Rails 애플리케이션 설정 관리: `rails-settings-cached` Gem 활용

Global app settings with gem rails-settings-cached #224

작성자
SupeRails
발행일
2025년 01월 15일
원문 보기
www.youtube.com

핵심 요약

  • 1 애플리케이션 전역 설정을 하드코딩하거나 YAML 파일에 저장하는 방식은 개발자 개입 및 재배포가 필요하여 지속 가능성이 낮습니다.
  • 2 `rails-settings-cached` Gem은 데이터베이스에 설정을 저장하고 기본값을 제공하여, 관리자가 코드 변경 및 재배포 없이 설정을 관리할 수 있게 합니다.
  • 3 이 Gem은 설정 변경을 위한 관리자 인터페이스(라우트, 컨트롤러, 뷰)를 쉽게 생성할 수 있으며, 유효성 검사 및 읽기 전용 필드와 같은 고급 기능을 지원합니다.

도입

Rails 애플리케이션에서 애플리케이션 이름, 설명, 연락처 정보와 같은 전역 설정을 관리하는 것은 중요한 과제입니다. 초기에는 이러한 설정을 코드에 하드코딩하거나 I18n 로컬(YAML 파일)에 저장하는 방식이 흔히 사용되었습니다. 그러나 이러한 방식은 설정 변경 시 개발자의 코드 수정 및 애플리케이션 재배포가 필수적이므로, 비기술적인 관리자가 직접 설정을 변경하기 어렵다는 한계가 있었습니다. 본 영상에서는 이러한 문제점을 해결하고 더욱 유연하게 애플리케이션 설정을 관리할 수 있는 `rails-settings-cached` Gem의 활용 방안을 제시합니다.

기존 설정 관리 방식의 한계

  • 하드코딩: 애플리케이션 전역 설정을 코드 내에 직접 작성하는 방식은 변경 시 여러 파일을 수동으로 수정해야 하며, 이는 유지보수 비용을 증가시키고 오류 발생 가능성을 높입니다.

  • I18n 로컬(YAML 파일): en.yml과 같은 로컬 파일에 설정을 중앙 집중화하는 방식은 하드코딩보다는 개선되었으나, 여전히 설정 변경을 위해서는 개발자가 코드 파일을 수정하고 애플리케이션을 재배포해야 하는 단점이 있습니다.

  • 기타 Rails 설정 방식: application.rb 내 config 객체 활용, 다양한 Gem 사용, 또는 Rails의 config_for 기능 등 여러 논의가 있었지만, 이들 대부분은 개발자의 개입 없이 관리자가 직접 설정을 변경할 수 있도록 하는 근본적인 문제를 해결하지 못했습니다.

rails-settings-cached Gem을 이용한 개선

rails-settings-cached Gem은 애플리케이션 설정을 데이터베이스에 저장함으로써, 관리자가 직접 설정을 변경하고 즉시 적용할 수 있도록 지원합니다. 이는 재배포 과정 없이 동적인 설정 관리를 가능하게 합니다.

Gem 설치 및 기본 설정

  1. Gem 추가: bundle add rails-settings-cached 명령어를 통해 Gem을 설치합니다.

  2. 모델 및 마이그레이션 생성: rails generate settings 명령어를 실행하면 Setting 모델과 key, value 컬럼을 포함하는 settings 테이블 생성 마이그레이션이 생성됩니다.

  3. 마이그레이션 실행: rails db:migrate를 통해 데이터베이스 테이블을 생성합니다.

  4. 기본값 정의: config/initializers/settings.rb 파일에서 Setting.app_name = 'My Restaurant'과 같이 기본 설정을 정의할 수 있습니다. 애플리케이션은 데이터베이스에 해당 설정이 없을 경우 이 기본값을 사용합니다.

  5. 설정 접근: 애플리케이션 코드 내에서 Setting.app_name과 같이 간편하게 설정 값에 접근할 수 있습니다.

관리자 인터페이스 구축

rails-settings-cached Gem은 관리자가 데이터베이스에 저장된 설정을 쉽게 편집할 수 있도록 관리자 인터페이스를 제공합니다. 최근 PR을 통해 rails generate settings:admin 명령어로 라우트, 컨트롤러, 뷰 파일을 자동으로 생성할 수 있게 되었습니다.

  1. 제너레이터 실행: rails generate settings:admin 명령어를 실행하여 관리자 인터페이스 관련 파일을 생성합니다.

  2. 생성된 파일: routes.rb에 namespace :admin { resource :settings } 라우트가 추가되고, SettingsController 및 views/settings/show.html.erb 뷰 파일이 생성됩니다.

  3. 설정 편집: /admin/settings 경로에 접속하면, 웹 인터페이스를 통해 애플리케이션 설정을 확인하고 변경할 수 있습니다. 변경된 설정은 즉시 데이터베이스에 반영되며, 애플리케이션은 업데이트된 설정을 사용합니다.

추가 기능

  • 유효성 검사: 관리자가 편집 가능한 필드에 대한 유효성 검사를 정의할 수 있습니다.

  • 읽기 전용 필드: 관리자에게 표시되지만 편집은 불가능한 읽기 전용 필드를 설정할 수 있습니다.

  • 스타일링: 생성된 관리자 뷰는 기본적인 스타일만 제공하므로, 필요에 따라 커스텀 CSS를 적용하여 UI를 개선할 수 있습니다.

결론

`rails-settings-cached` Gem은 Rails 애플리케이션의 전역 설정을 효율적으로 관리할 수 있는 강력한 솔루션을 제공합니다. 기존의 하드코딩이나 YAML 파일 기반 방식의 한계를 극복하고, 관리자가 개발자의 개입 없이 직접 설정을 변경하고 즉시 적용할 수 있게 함으로써 애플리케이션의 유연성과 유지보수성을 크게 향상시킵니다. 이 Gem은 데이터베이스 기반의 설정 저장, 기본값 지원, 그리고 손쉬운 관리자 인터페이스 구축 기능을 통해 동적인 애플리케이션 설정 관리에 최적화된 접근 방식을 제시하며, 이는 현대 웹 애플리케이션 개발에 있어 매우 유용한 도구로 평가될 수 있습니다.

관련 글들

Rails 8 Monigon SaaS Boilerplate 로컬 Stripe 결제 시스템 연동 가이드

Rails 8 기반 Monigon SaaS boilerplate 애플리케이션을 로컬 환경에 설정하고, Stripe API 키 및 웹훅 시크릿을 구성하여 결제 기능을 활성화하는 과정을 상세히 설명합니다.

04/14 읽어보기 →

Rails 기본값: 업그레이드된 앱 속 시한폭탄 해체하기

Rails 업그레이드 시 `config.load_defaults` 설정과 `new_framework_defaults_*.rb` 파일 관리가 필수적이며, 이를 간과할 경우 잠재적 문제 발생 가능성이 높습니다.

07/24 읽어보기 →

Rails API 개발: 중첩된 리소스와 효율적인 데이터 처리 전략

본 발표는 Rails API 개발 시 중첩된 리소스 관리의 복잡성을 다루고, 이를 해결하기 위한 혁신적인 접근 방식을 제시합니다.

03/15 읽어보기 →

Rails 애플리케이션에서 ID를 숨기는 가장 효율적인 방법

애플리케이션 URL 및 마크업에 ID 노출은 보안 취약점 및 경쟁사 분석의 위험을 초래합니다.

03/31 읽어보기 →

댓글 0

댓글 작성

0/1000
정중하고 건설적인 댓글을 작성해 주세요.

아직 댓글이 없습니다

첫 번째 댓글을 작성해보세요!