はじめに
Railsアプリケーションのバージョンアップ作業に携わる中で、config.load_defaultsという設定オプションについて学びました。
そこでこの記事ではconfig.load_defaultsの役割や使い方、バージョンアップ作業時の取り扱いについてまとめます。
対象読者は次のとおりです。
- Railsの設定まわりに興味のあるエンジニア
- 歴史のあるRailsアプリケーションに携わっている（Rails5.0以前）
- Railsのバージョンアップ前に設定ファイルをリファクタリングしたいエンジニア
config.load_defaultsとは？
config.load_defaultsとは、指定したRailsバージョンのデフォルト設定を一括で読み込むための設定です。
config/application.rbに記述されています。
下記はRails7.2でrails newした時点のconfig/application.rbです。
require_relative "boot"
require "rails/all"
# Require the gems listed in Gemfile, including any gems
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)
module SampleApp
class Application < Rails::Application
# Initialize configuration defaults for originally generated Rails version.
config.load_defaults 7.2
# Please, add to the `ignore` list any other `lib` subdirectories that do
# not contain `.rb` files, or that should not be reloaded or eager loaded.
# Common ones are `templates`, `generators`, or `middleware`, for example.
config.autoload_lib(ignore: %w[assets tasks])
# Configuration for the application, engines, and railties goes here.
#
# These settings can be overridden in specific environments using the files
# in config/environments, which are processed later.
#
# config.time_zone = "Central Time (US & Canada)"
# config.eager_load_paths << Rails.root.join("extras")
end
end
デフォルトの設定ではアプリケーションの要件を満たせない場合、値を個別に上書きすることも可能です。
require_relative "boot"
require "rails/all"
# Require the gems listed in Gemfile, including any gems
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)
module SampleApp
class Application < Rails::Application
# Initialize configuration defaults for originally generated Rails version.
config.load_defaults 7.2
# Please, add to the `ignore` list any other `lib` subdirectories that do
# not contain `.rb` files, or that should not be reloaded or eager loaded.
# Common ones are `templates`, `generators`, or `middleware`, for example.
config.autoload_lib(ignore: %w[assets tasks])
# Configuration for the application, engines, and railties goes here.
#
# These settings can be overridden in specific environments using the files
# in config/environments, which are processed later.
#
# config.time_zone = "Central Time (US & Canada)"
# config.eager_load_paths << Rails.root.join("extras")
# load_defaults で設定されるデフォルト値は "UTC" だが東京に変更
config.time_zone = 'Asia/Tokyo'
end
end
バージョン毎にどのようなデフォルト値が用意されているかは、Railsガイドで確認できます。
config.load_defaultsで得られること
config.load_defaultsを採用することで、以下の利点があります。
1. 個別設定の可視化
Rails のデフォルト設定とプロジェクト固有の設定を明確にできます。
「普通のRailsアプリケーションとはどこが異なるか？」がコードとして可視化されるため、設定ファイルの管理が容易になります。
2. Rails 標準への準拠
可能なかぎり Rails の標準設定に寄せた方が、フレームワークの最新機能や最適化の恩恵を受けやすいです。
アプリケーションのパフォーマンス向上やセキュリティ面の強化などが期待できます。
3. メンテナンスの効率化
デフォルト設定を一括で適用することで、個別の設定変更が減少し、設定ファイルがシンプルになります。
その結果として、バージョンアップ対応時のメンテナンス作業の効率化が可能です。
既存のRailsアプリケーションへの導入
config.load_defaultsはRails 5.0より導入された機能です。
Rails 5.0以前から運用されているアプリケーションではconfig.load_defaultsが使用されていない可能性があります。
この場合はconfig/application.rbにconfig.load_defaults(5.0)と記述するだけで、デフォルト設定が適用されます。
require_relative "boot"
require "rails/all"
Bundler.require(*Rails.groups)
module SampleApp
class Application < Rails::Application
config.load_defaults(5.0) # 記述を追加
# ...
end
end
load_defaultsで採用されているデフォルト設定で問題ない場合、個別設定の記述は不要なので削除しましょう。
デフォルト値では要件を満たせない設定のみ、既存の記述をそのまま残しておけば、アプリケーションの挙動に影響は与えません。
つまり、load_defaultsを新規に採用することで、設定ファイルconfig/application.rbのリファクタリングが可能なのです。
注意点
たとえばRails 7.0までバージョンアップしたい場合、理論上はconfig.load_defaults(7.0)と目標のバージョンをいきなり指定して一気に変更することもできます。
しかし、実務ではレビュー負荷や問題発生のトラブルシューティングなどを考慮し、段階的に変更していく方が安全です。
まずはconfig.load_defaults(5.0)を指定し、5.1, 5.2, 6.0, 6.1, 7.0.....と目標のバージョンまで段階的に少しずつ変更していくのが良いでしょう。
おわりに
config.load_defaultsは、設定ファイルの見通しを改善し、アプリケーションのメンテナンス性を向上させる便利な機能です。
Rails 5.0以降の新規プロジェクトでは標準で使用されており、既存のプロジェクトでも段階的に導入することができます。
バージョンアップ作業を通じてRailsへの理解が深まりました。
またこの記事に誤りがありましたらコメントにてご指摘いただけますと幸いです。
参考資料