класс Rails::Application
Объект Engine отвечающий за координацию всего процесса запуска.
Инициализация
Rails::Application отвечает за выполнение всех инициализаторов railties и engines. Также он выполняет некоторые инициализаторы bootstrap (см. Rails::Application::Bootstrap) и завершающие инициализаторы, после выполнения всех остальных (см. Rails::Application::Finisher).
Конфигурация
Помимо предоставления той же конфигурации, что и Rails::Engine и Rails::Railtie, объект приложения имеет несколько специфичных конфигураций, например enable_reloading, consider_all_requests_local, filter_parameters, logger, и так далее.
Все конфигурации можно посмотреть в Rails::Application::Configuration.
Маршруты
Объект приложения также отвечает за хранение маршрутов и их перезагрузку при изменении файлов в режиме разработки.
Средства
Объект Application также отвечает за построение стека middleware.
Процесс загрузки
Приложение также отвечает за настройку и выполнение процесса загрузки. С момента, когда вы требуете config/application.rb в своём приложении, процесс загрузки происходит так:
-
require "config/boot.rb"для настройки путей загрузки. -
requirerailties и engines. -
Определить
Rails.applicationкакclass MyApp::Application < Rails::Application. -
Выполнить
config.before_configurationколбеки. -
Загрузить
config/environments/ENV.rb. -
Выполнить
config.before_initializeколбеки. -
Выполнить
Railtie#initializerопределённые railties, engines и приложением. Каждый engine по очереди настраивает свои пути загрузки и маршруты, и выполняет своиconfig/initializers/*файлы. -
Выполняются пользовательские
Railtie#initializersдобавленные railties, engines и приложениями. -
Построить стек middleware и выполнить
to_prepareколбеки. -
Выполнить
config.before_eager_loadиeager_load!еслиeager_loadявляетсяtrue. -
Выполнить
config.after_initializeколбеки.
Атрибуты
Публичные методы класса
# File railties/lib/rails/application.rb, line 84
def create(initial_variable_values = {}, &block)
new(initial_variable_values, &block).run_load_hooks!
end # File railties/lib/rails/application.rb, line 88 def find_root(from) find_root_with_flag "config.ru", from, Dir.pwd end
# File railties/lib/rails/application.rb, line 71 def inherited(base) super Rails.app_class = base # lib has to be added to $LOAD_PATH unconditionally, even if it's in the # autoload paths and config.add_autoload_paths_to_load_path is false. add_lib_to_load_path!(find_root(base.called_from)) ActiveSupport.run_load_hooks(:before_configuration, base) end
# File railties/lib/rails/application.rb, line 80 def instance super.run_load_hooks! end
# File railties/lib/rails/application.rb, line 109
def initialize(initial_variable_values = {}, &block)
super()
@initialized = false
@reloaders = []
@routes_reloader = nil
@app_env_config = nil
@ordered_railties = nil
@railties = nil
@key_generators = {}
@message_verifiers = nil
@deprecators = nil
@ran_load_hooks = false
@executor = Class.new(ActiveSupport::Executor)
@reloader = Class.new(ActiveSupport::Reloader)
@reloader.executor = @executor
@autoloaders = Rails::Autoloaders.new
# are these actually used?
@initial_variable_values = initial_variable_values
@block = block
end Общедоступные методы экземпляра
# File railties/lib/rails/application.rb, line 271
def config_for(name, env: Rails.env)
yaml = name.is_a?(Pathname) ? name : Pathname.new("#{paths["config"].existent.first}/#{name}.yml")
if yaml.exist?
require "erb"
all_configs = ActiveSupport::ConfigurationFile.parse(yaml).deep_symbolize_keys
config, shared = all_configs[env.to_sym], all_configs[:shared]
if shared
config = {} if config.nil? && shared.is_a?(Hash)
if config.is_a?(Hash) && shared.is_a?(Hash)
config = shared.deep_merge(config)
elsif config.nil?
config = shared
end
end
if config.is_a?(Hash)
config = ActiveSupport::OrderedOptions.new.update(config)
end
config
else
raise "Could not load configuration. No such file - #{yaml}"
end
end Удобный способ загрузки config/foo.yml для текущей среды Rails.
Примеры:
# config/exception_notification.yml:
production:
url: http://127.0.0.1:8080
namespace: my_app_production
development:
url: http://localhost:3001
namespace: my_app_development
# config/environments/production.rb
Rails.application.configure do
config.middleware.use ExceptionNotifier, config_for(:exception_notification)
end
# You can also store configurations in a shared section which will be
# merged with the environment configuration
# config/example.yml
shared:
foo:
bar:
baz: 1
development:
foo:
bar:
qux: 2
# development environment
Rails.application.config_for(:example)[:foo][:bar]
# => { baz: 1, qux: 2 } # File railties/lib/rails/application.rb, line 354 def console(&blk) self.class.console(&blk) end
Пересылает любые вызовы консоли в экземпляре нового приложения в метод console, определенный в Rails::Railtie.
# File railties/lib/rails/application.rb, line 513 def credentials @credentials ||= encrypted(config.credentials.content_path, key_path: config.credentials.key_path) end
Возвращает экземпляр ActiveSupport::EncryptedConfiguration для файла credentials, указанного в config.credentials.content_path.
По умолчанию, config.credentials.content_path будет указывать на config/credentials/#{environment}.yml.enc для текущей среды (например, config/credentials/production.yml.enc для среды production), или config/credentials.yml.enc в случае отсутствия этого файла.
Ключ шифрования берется из ENV["RAILS_MASTER_KEY"], или из файла, указанного в config.credentials.key_path. По умолчанию, config.credentials.key_path будет указывать на config/credentials/#{environment}.key для текущей среды, или config/master.key в случае отсутствия этого файла.
# File railties/lib/rails/application.rb, line 230
def deprecators
@deprecators ||= ActiveSupport::Deprecation::Deprecators.new.tap do |deprecators|
deprecators[:railties] = Rails.deprecator
end
end Управляемая коллекция устаревших методов (ActiveSupport::Deprecation::Deprecators). Методы конфигурации коллекции влияют на все устаревшие методы в коллекции. Кроме того, метод silence отключает все устаревшие методы в коллекции на время выполнения заданного блока.
# File railties/lib/rails/application.rb, line 571 def eager_load! Rails.autoloaders.each(&:eager_load) end
Загружает код приложения.
# File railties/lib/rails/application.rb, line 532
def encrypted(path, key_path: "config/master.key", env_key: "RAILS_MASTER_KEY")
ActiveSupport::EncryptedConfiguration.new(
config_path: Rails.root.join(path),
key_path: Rails.root.join(key_path),
env_key: env_key,
raise_if_missing_key: config.require_master_key
)
end Возвращает экземпляр ActiveSupport::EncryptedConfiguration для зашифрованного файла. По умолчанию, ключ шифрования берется из ENV["RAILS_MASTER_KEY"], или из файла config/master.key.
my_config = Rails.application.encrypted("config/my_config.enc")
my_config.read
# => "foo:\n bar: 123\n"
my_config.foo.bar
# => 123
Зашифрованные файлы можно редактировать с помощью команды bin/rails encrypted:edit. (Дополнительную информацию см. в выводе bin/rails encrypted:edit --help).
# File railties/lib/rails/application.rb, line 300
def env_config
@app_env_config ||= super.merge(
"action_dispatch.parameter_filter" => filter_parameters,
"action_dispatch.redirect_filter" => config.filter_redirect,
"action_dispatch.secret_key_base" => secret_key_base,
"action_dispatch.show_exceptions" => config.action_dispatch.show_exceptions,
"action_dispatch.show_detailed_exceptions" => config.consider_all_requests_local,
"action_dispatch.log_rescued_responses" => config.action_dispatch.log_rescued_responses,
"action_dispatch.debug_exception_log_level" => ActiveSupport::Logger.const_get(config.action_dispatch.debug_exception_log_level.to_s.upcase),
"action_dispatch.logger" => Rails.logger,
"action_dispatch.backtrace_cleaner" => Rails.backtrace_cleaner,
"action_dispatch.key_generator" => key_generator,
"action_dispatch.http_auth_salt" => config.action_dispatch.http_auth_salt,
"action_dispatch.signed_cookie_salt" => config.action_dispatch.signed_cookie_salt,
"action_dispatch.encrypted_cookie_salt" => config.action_dispatch.encrypted_cookie_salt,
"action_dispatch.encrypted_signed_cookie_salt" => config.action_dispatch.encrypted_signed_cookie_salt,
"action_dispatch.authenticated_encrypted_cookie_salt" => config.action_dispatch.authenticated_encrypted_cookie_salt,
"action_dispatch.use_authenticated_cookie_encryption" => config.action_dispatch.use_authenticated_cookie_encryption,
"action_dispatch.encrypted_cookie_cipher" => config.action_dispatch.encrypted_cookie_cipher,
"action_dispatch.signed_cookie_digest" => config.action_dispatch.signed_cookie_digest,
"action_dispatch.cookies_serializer" => config.action_dispatch.cookies_serializer,
"action_dispatch.cookies_digest" => config.action_dispatch.cookies_digest,
"action_dispatch.cookies_rotations" => config.action_dispatch.cookies_rotations,
"action_dispatch.cookies_same_site_protection" => coerce_same_site_protection(config.action_dispatch.cookies_same_site_protection),
"action_dispatch.use_cookies_with_metadata" => config.action_dispatch.use_cookies_with_metadata,
"action_dispatch.content_security_policy" => config.content_security_policy,
"action_dispatch.content_security_policy_report_only" => config.content_security_policy_report_only,
"action_dispatch.content_security_policy_nonce_generator" => config.content_security_policy_nonce_generator,
"action_dispatch.content_security_policy_nonce_directives" => config.content_security_policy_nonce_directives,
"action_dispatch.permissions_policy" => config.permissions_policy,
)
end Хранит некоторые параметры начальной среды Rails, которые будут использоваться middleware и движками для собственной конфигурации.
# File railties/lib/rails/application.rb, line 360 def generators(&blk) self.class.generators(&blk) end
Пересылает любые вызовы генераторов в экземпляре нового приложения в метод generators, определенный в Rails::Railtie.
# File railties/lib/rails/application.rb, line 134 def initialized? @initialized end
Возвращает true, если приложение инициализировано.
# File railties/lib/rails/application.rb, line 342
def initializer(name, opts = {}, &block)
self.class.initializer(name, opts, &block)
end Пересылает инициализаторы в метод initializer, определенный в модуле Rails::Initializable. Каждый класс Rails::Application имеет свой набор инициализаторов, как определено модулем Initializable.
# File railties/lib/rails/application.rb, line 371 def isolate_namespace(mod) self.class.isolate_namespace(mod) end
Пересылает метод isolate_namespace в метод класса.
# File railties/lib/rails/application.rb, line 161
def key_generator(secret_key_base = self.secret_key_base)
# number of iterations selected based on consultation with the google security
# team. Details at https://github.com/rails/rails/pull/6952#issuecomment-7661220
@key_generators[secret_key_base] ||= ActiveSupport::CachingKeyGenerator.new(
ActiveSupport::KeyGenerator.new(secret_key_base, iterations: 1000)
)
end Возвращает генератор ключей (ActiveSupport::CachingKeyGenerator) для указанного secret_key_base. Возвращаемое значение кэшируется, поэтому дополнительные вызовы с тем же secret_key_base вернут тот же экземпляр генератора ключей.
# File railties/lib/rails/application.rb, line 222 def message_verifier(verifier_name) message_verifiers[verifier_name] end
Возвращает объект верификатора сообщений.
Этот верификатор можно использовать для генерации и проверки подписанных сообщений в приложении.
Рекомендуется не использовать один и тот же верификатор для разных целей, поэтому можно получить разные верификаторы, передав аргумент verifier_name.
Параметры
-
verifier_name- имя верификатора сообщений.
Примеры
message = Rails.application.message_verifier('sensitive_data').generate('my sensible data')
Rails.application.message_verifier('sensitive_data').verify(message)
# => 'my sensible data'
См. документацию ActiveSupport::MessageVerifier для получения дополнительной информации.
# File railties/lib/rails/application.rb, line 197
def message_verifiers
@message_verifiers ||=
ActiveSupport::MessageVerifiers.new do |salt, secret_key_base: self.secret_key_base|
key_generator(secret_key_base).generate_key(salt)
end.rotate_defaults
end Возвращает фабрику верификаторов сообщений (ActiveSupport::MessageVerifiers). Эта фабрика может быть использована как центральная точка для настройки и создания верификаторов сообщений (ActiveSupport::MessageVerifier) для вашего приложения.
По умолчанию, верификаторы сообщений, созданные этой фабрикой, будут генерировать сообщения с использованием опций по умолчанию ActiveSupport::MessageVerifier. Вы можете переопределить эти опции с помощью комбинации ActiveSupport::MessageVerifiers#clear_rotations и ActiveSupport::MessageVerifiers#rotate. Однако это необходимо сделать до создания экземпляров верификатора сообщений. Например, в блоке before_initialize:
# Use `url_safe: true` when generating messages config.before_initialize do |app| app.message_verifiers.clear_rotations app.message_verifiers.rotate(url_safe: true) end
Верификаторы сообщений, созданные этой фабрикой, всегда будут использовать секрет, полученный из secret_key_base, при генерации сообщений. clear_rotations не повлияет на это поведение. Однако старые значения secret_key_base можно вращать для проверки сообщений:
# Fall back to old `secret_key_base` when verifying messages config.before_initialize do |app| app.message_verifiers.rotate(secret_key_base: "old secret_key_base") end
# File railties/lib/rails/application.rb, line 335 def rake_tasks(&block) self.class.rake_tasks(&block) end
Если вы попытаетесь определить набор задач Rake в экземпляре, они будут переданы задачам Rake, определенным в классе приложения.
# File railties/lib/rails/application.rb, line 153 def reload_routes! routes_reloader.reload! end
Перезагрузить маршруты приложения независимо от того, изменились ли они или нет.
# File railties/lib/rails/application.rb, line 348 def runner(&blk) self.class.runner(&blk) end
Отправляет любой вызываемый метод runner в экземпляре нового приложения в метод runner, определённый в Rails::Railtie.
# File railties/lib/rails/application.rb, line 475
def secret_key_base
if Rails.env.local? || ENV["SECRET_KEY_BASE_DUMMY"]
config.secret_key_base ||= generate_local_secret
else
validate_secret_key_base(
ENV["SECRET_KEY_BASE"] || credentials.secret_key_base || begin
secret_skb = secrets_secret_key_base
if secret_skb.equal?(config.secret_key_base)
config.secret_key_base
else
Rails.deprecator.warn(<<~MSG.squish)
Your `secret_key_base is configured in `Rails.application.secrets`,
which is deprecated in favor of `Rails.application.credentials` and
will be removed in Rails 7.2.
MSG
secret_skb
end
end
)
end
end Значение secret_key_base используется в качестве секретного входного значения для генератора ключей приложения, который в свою очередь используется для создания всех экземпляров ActiveSupport::MessageVerifier и ActiveSupport::MessageEncryptor, включая те, что подписывают и шифруют куки.
В режиме разработки и тестирования оно генерируется случайным образом и сохраняется во временном файле в tmp/local_secret.txt.
Вы также можете установить ENV["SECRET_KEY_BASE_DUMMY"], чтобы активировать использование случайно сгенерированного secret_key_base, который сохраняется во временном файле. Это полезно при предварительной компиляции ресурсов для производства в рамках этапа сборки, который в противном случае не нуждается в доступе к секретам производства.
Пример Dockerfile: RUN SECRET_KEY_BASE_DUMMY=1 bundle exec rails assets:precompile.
Во всех остальных средах, мы ищем его сначала в ENV["SECRET_KEY_BASE"], затем в credentials.secret_key_base, и, наконец, в secrets.secret_key_base. Для большинства приложений правильное место для его хранения — в зашифрованном файле учетных данных.
# File railties/lib/rails/application.rb, line 440
def secrets
Rails.deprecator.warn(<<~MSG.squish)
`Rails.application.secrets` is deprecated in favor of `Rails.application.credentials` and will be removed in Rails 7.2.
MSG
@secrets ||= begin
secrets = ActiveSupport::OrderedOptions.new
files = config.paths["config/secrets"].existent
files = files.reject { |path| path.end_with?(".enc") } unless config.read_encrypted_secrets
secrets.merge! Rails::Secrets.parse(files, env: Rails.env)
# Fallback to config.secret_key_base if secrets.secret_key_base isn't set
secrets.secret_key_base ||= config.secret_key_base
secrets
end
end # File railties/lib/rails/application.rb, line 366 def server(&blk) self.class.server(&blk) end
Отправляет любой вызываемый метод server в экземпляре нового приложения в метод server, определённый в Rails::Railtie.
Защищённые методы экземпляров
# File railties/lib/rails/application.rb, line 659 def ensure_generator_templates_added configured_paths = config.generators.templates configured_paths.unshift(*(paths["lib/templates"].existent - configured_paths)) end
# File railties/lib/rails/application.rb, line 649
def validate_secret_key_base(secret_key_base)
if secret_key_base.is_a?(String) && secret_key_base.present?
secret_key_base
elsif secret_key_base
raise ArgumentError, "`secret_key_base` for #{Rails.env} environment must be a type of String`"
else
raise ArgumentError, "Missing `secret_key_base` for '#{Rails.env}' environment, set this string with `bin/rails credentials:edit`"
end
end
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.