Rails::Railtie 是 Rails 框架的核心，并提供了几个钩子来扩展 Rails 和/或修改初始化过程。

Rails 的每个主要组件（Action Mailer、Action Controller、Active Record 等）都实现了 railtie。每个组件都负责自己的初始化。这使得 Rails 本身没有任何组件钩子，从而允许使用其他组件来代替任何 Rails 默认组件。

开发 Rails 扩展不需要实现 railtie，但如果你需要在启动期间或启动后与 Rails 框架进行交互，那么就需要一个 railtie。

例如，执行以下任何操作的扩展将需要 railtie

• 创建初始化器

• 为应用程序配置 Rails 框架，例如设置生成器

• 向环境添加 config.* 键

• 使用 ActiveSupport::Notifications 设置订阅者

• 添加 Rake 任务

创建 Railtie

要使用 railtie 扩展 Rails，请创建一个 Rails::Railtie 的子类。此类必须在 Rails 启动过程中加载，并且通常称为 MyNamespace::Railtie。

以下示例演示了一个可与 Rails 一起使用或不使用的扩展。

# lib/my_gem/railtie.rb
module MyGem
  class Railtie < Rails::Railtie
  end
end

# lib/my_gem.rb
require "my_gem/railtie" if defined?(Rails::Railtie)

初始化器

要从 railtie 向 Rails 启动过程添加初始化步骤，只需使用 initializer 宏定义初始化代码

class MyRailtie < Rails::Railtie
  initializer "my_railtie.configure_rails_initialization" do
    # some initialization behavior
  end
end

如果指定了，该块还可以接收应用程序对象，以防你需要访问一些应用程序特定的配置，例如中间件

class MyRailtie < Rails::Railtie
  initializer "my_railtie.configure_rails_initialization" do |app|
    app.middleware.use MyRailtie::Middleware
  end
end

最后，你还可以将 :before 和 :after 作为选项传递给 initializer，以防你想将其与初始化过程中的特定步骤耦合。

配置

Railtie 可以访问一个 config 对象，其中包含所有 railtie 和应用程序共享的配置

class MyRailtie < Rails::Railtie
  # Customize the ORM
  config.app_generators.orm :my_railtie_orm

  # Add a to_prepare block which is executed once in production
  # and before each request in development.
  config.to_prepare do
    MyRailtie.setup!
  end
end

加载 Rake 任务和 生成器

如果您的 railtie 具有 Rake 任务，您可以通过 rake_tasks 方法告知 Rails 加载它们

class MyRailtie < Rails::Railtie
  rake_tasks do
    load "path/to/my_railtie.tasks"
  end
end

默认情况下，Rails 从您的加载路径加载生成器。但是，如果您想将生成器放置在其他位置，可以在 railtie 中指定一个块，该块将在常规生成器查找过程中加载它们

class MyRailtie < Rails::Railtie
  generators do
    require "path/to/my_railtie_generator"
  end
end

由于加载路径上的文件名在 gem 之间共享，因此请确保通过 railtie 加载的文件具有唯一名称。

在 Rails 服务器启动时运行另一个程序

在开发中，通常需要在 Rails Server 旁边运行另一个进程。例如，您可能希望启动 Webpack 或 React 服务器。或者，您可能需要运行作业调度程序进程，如 Sidekiq。这通常是通过打开一个新 shell 并从此处运行程序来完成的。

Rails 允许您指定一个 server 块，该块将在 Rails 服务器启动时被调用。这样，您的用户就不必记住打开一个新 shell 并运行另一个程序，这使得每个人都更不容易混淆。它可以像这样使用

class MyRailtie < Rails::Railtie
  server do
    WebpackServer.start
  end
end

Application 和 Engine

引擎只不过是一个已设置了一些初始化程序的 railtie。并且由于 Rails::Application 是一个引擎，因此此处描述的相同配置可以在两者中使用。

请务必查看这些特定类的文档以获取更多信息。