Rails 初始化流程

本指南說明 Rails 中初始化流程的內部運作方式。這是一份非常深入的指南，建議進階 Rails 開發人員閱讀。

閱讀本指南後，您將了解

如何使用 bin/rails server。
Rails 初始化順序的時間軸。
啟動順序需要哪些不同的檔案。
如何定義和使用 Rails::Server 介面。

本指南將逐步介紹啟動預設 Rails 應用程式的 Ruby on Rails 堆疊所需的每個方法呼叫，並詳細說明每個部分。在本指南中，我們將重點說明執行 bin/rails server 來啟動應用程式時會發生的情況。

除非另有說明，否則本指南中的路徑都是相對於 Rails 或 Rails 應用程式的路徑。

如果您想在瀏覽 Rails 原始碼時跟著操作，我們建議您使用 t 按鍵綁定在 GitHub 中開啟檔案搜尋器並快速找到檔案。

1 啟動！

讓我們開始啟動和初始化應用程式。Rails 應用程式通常透過執行 bin/rails console 或 bin/rails server 來啟動。

1.1 `bin/rails`

此檔案如下所示

#!/usr/bin/env ruby
APP_PATH = File.expand_path("../config/application", __dir__)
require_relative "../config/boot"
require "rails/commands"

APP_PATH 常數稍後將在 rails/commands 中使用。此處引用的 config/boot 檔案是應用程式中的 config/boot.rb 檔案，負責載入 Bundler 並進行設定。

1.2 `config/boot.rb`

config/boot.rb 包含

ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)

require "bundler/setup" # Set up gems listed in the Gemfile.
require "bootsnap/setup" # Speed up boot time by caching expensive operations.

在標準的 Rails 應用程式中，有一個 Gemfile 宣告應用程式的所有相依性。config/boot.rb 將 ENV['BUNDLE_GEMFILE'] 設定為此檔案的位置。如果 Gemfile 存在，則需要 bundler/setup。Bundler 使用 require 來設定 Gemfile 相依性的載入路徑。

1.3 `rails/commands.rb`

config/boot.rb 完成後，下一個需要載入的檔案是 rails/commands，它有助於擴展別名。在目前的情況下，ARGV 陣列只包含將傳遞的 server。

require "rails/command"

aliases = {
  "g"  => "generate",
  "d"  => "destroy",
  "c"  => "console",
  "s"  => "server",
  "db" => "dbconsole",
  "r"  => "runner",
  "t"  => "test"
}

command = ARGV.shift
command = aliases[command] || command

Rails::Command.invoke command, ARGV

如果我們使用 s 而不是 server，Rails 將使用此處定義的 aliases 來尋找匹配的指令。

1.4 `rails/command.rb`

當使用者輸入 Rails 指令時，invoke 會嘗試尋找給定命名空間的指令，如果找到則執行該指令。

如果 Rails 無法識別該指令，則會將控制權交給 Rake 來執行相同名稱的任務。

如圖所示，如果 namespace 為空，Rails::Command 會自動顯示說明輸出。

module Rails
  module Command
    class << self
      def invoke(full_namespace, args = [], **config)
        namespace = full_namespace = full_namespace.to_s

        if char = namespace =~ /:(\w+)$/
          command_name, namespace = $1, namespace.slice(0, char)
        else
          command_name = namespace
        end

        command_name, namespace = "help", "help" if command_name.blank? || HELP_MAPPINGS.include?(command_name)
        command_name, namespace = "version", "version" if %w( -v --version ).include?(command_name)

        command = find_by_namespace(namespace, command_name)
        if command && command.all_commands[command_name]
          command.perform(command_name, args, config)
        else
          find_by_namespace("rake").perform(full_namespace, args, config)
        end
      end
    end
  end
end

對於 server 指令，Rails 將進一步執行以下程式碼

module Rails
  module Command
    class ServerCommand < Base # :nodoc:
      def perform
        extract_environment_option_from_argument
        set_application_directory!
        prepare_restart

        Rails::Server.new(server_options).tap do |server|
          # Require application after server sets environment to propagate
          # the --environment option.
          require APP_PATH
          Dir.chdir(Rails.application.root)

          if server.serveable?
            print_boot_information(server.server, server.served_url)
            after_stop_callback = -> { say "Exiting" unless options[:daemon] }
            server.start(after_stop_callback)
          else
            say rack_server_suggestion(using)
          end
        end
      end
    end
  end
end

此檔案將變更為 Rails 根目錄（從指向 config/application.rb 的 APP_PATH 向上兩個目錄的路徑），但只有在找不到 config.ru 檔案時才會變更。然後啟動 Rails::Server 類別。

1.5 `actionpack/lib/action_dispatch.rb`

Action Dispatch 是 Rails 框架的路由組件。它增加了路由、會話和常見中介軟體等功能。

1.6 `rails/commands/server/server_command.rb`

Rails::Server 類別在此檔案中定義，透過繼承自 Rack::Server。當呼叫 Rails::Server.new 時，會呼叫 rails/commands/server/server_command.rb 中的 initialize 方法

module Rails
  class Server < ::Rack::Server
    def initialize(options = nil)
      @default_options = options || {}
      super(@default_options)
      set_environment
    end
  end
end

首先，呼叫 super，這會呼叫 Rack::Server 上的 initialize 方法。

1.7 Rack: `lib/rack/server.rb`

Rack::Server 負責為所有基於 Rack 的應用程式提供通用的伺服器介面，而 Rails 現在是其中的一部分。

Rack::Server 中的 initialize 方法只是設定幾個變數

module Rack
  class Server
    def initialize(options = nil)
      @ignore_options = []

      if options
        @use_default_options = false
        @options = options
        @app = options[:app] if options[:app]
      else
        argv = defined?(SPEC_ARGV) ? SPEC_ARGV : ARGV
        @use_default_options = true
        @options = parse_options(argv)
      end
    end
  end
end

在此情況下，Rails::Command::ServerCommand#server_options 的回傳值將指派給 options。當評估 if 語句中的行時，將會設定幾個實例變數。

Rails::Command::ServerCommand 中的 server_options 方法定義如下

module Rails
  module Command
    class ServerCommand
      no_commands do
        def server_options
          {
            user_supplied_options: user_supplied_options,
            server:                using,
            log_stdout:            log_to_stdout?,
            Port:                  port,
            Host:                  host,
            DoNotReverseLookup:    true,
            config:                options[:config],
            environment:           environment,
            daemonize:             options[:daemon],
            pid:                   pid,
            caching:               options[:dev_caching],
            restart_cmd:           restart_command,
            early_hints:           early_hints
          }
        end
      end
    end
  end
end

該值將指派給實例變數 @options。

在 Rack::Server 中的 super 完成後，我們跳回 rails/commands/server/server_command.rb。此時，會在 Rails::Server 物件的內容中呼叫 set_environment。

module Rails
  module Server
    def set_environment
      ENV["RAILS_ENV"] ||= options[:environment]
    end
  end
end

在 initialize 完成後，我們跳回伺服器指令，其中需要 APP_PATH（先前已設定）。

1.8 `config/application`

當執行 require APP_PATH 時，會載入 config/application.rb（回想一下，APP_PATH 是在 bin/rails 中定義的）。此檔案存在於您的應用程式中，您可以根據自己的需求自由變更。

1.9 `Rails::Server#start`

在載入 config/application 後，會呼叫 server.start。此方法定義如下

module Rails
  class Server < ::Rack::Server
    def start(after_stop_callback = nil)
      trap(:INT) { exit }
      create_tmp_directories
      setup_dev_caching
      log_to_stdout if options[:log_stdout]

      super()
      # ...
    end

    private
      def setup_dev_caching
        if options[:environment] == "development"
          Rails::DevCaching.enable_by_argument(options[:caching])
        end
      end

      def create_tmp_directories
        %w(cache pids sockets).each do |dir_to_make|
          FileUtils.mkdir_p(File.join(Rails.root, "tmp", dir_to_make))
        end
      end

      def log_to_stdout
        wrapped_app # touch the app so the logger is set up

        console = ActiveSupport::Logger.new(STDOUT)
        console.formatter = Rails.logger.formatter
        console.level = Rails.logger.level

        unless ActiveSupport::Logger.logger_outputs_to?(Rails.logger, STDOUT)
          Rails.logger.extend(ActiveSupport::Logger.broadcast(console))
        end
      end
  end
end

此方法會為 INT 訊號建立陷阱，因此如果您 CTRL-C 伺服器，它將會退出該程序。從此處的程式碼中可以看到，它會建立 tmp/cache、tmp/pids 和 tmp/sockets 目錄。如果呼叫 bin/rails server 時帶有 --dev-caching，則會在開發中啟用快取。最後，它會呼叫 wrapped_app，該方法負責建立 Rack 應用程式，然後建立並指派 ActiveSupport::Logger 的實例。

super 方法將呼叫 Rack::Server.start，其定義的開頭如下

module Rack
  class Server
    def start(&blk)
      if options[:warn]
        $-w = true
      end

      if includes = options[:include]
        $LOAD_PATH.unshift(*includes)
      end

      if library = options[:require]
        require library
      end

      if options[:debug]
        $DEBUG = true
        p options[:server]
        pp wrapped_app
        pp app
      end

      check_pid! if options[:pid]

      # Touch the wrapped app, so that the config.ru is loaded before
      # daemonization (i.e. before chdir, etc).
      handle_profiling(options[:heapfile], options[:profile_mode], options[:profile_file]) do
        wrapped_app
      end

      daemonize_app if options[:daemonize]

      write_pid if options[:pid]

      trap(:INT) do
        if server.respond_to?(:shutdown)
          server.shutdown
        else
          exit
        end
      end

      server.run wrapped_app, options, &blk
    end
  end
end

對於 Rails 應用程式來說，有趣的部分是最後一行，server.run。在這裡我們再次遇到 wrapped_app 方法，這次我們將進一步探索（即使它之前已經執行過，因此現在已被記憶）。

module Rack
  class Server
    def wrapped_app
      @wrapped_app ||= build_app app
    end
  end
end

此處的 app 方法定義如下

module Rack
  class Server
    def app
      @app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
    end

    # ...

    private
      def build_app_and_options_from_config
        if !::File.exist? options[:config]
          abort "configuration #{options[:config]} not found"
        end

        app, options = Rack::Builder.parse_file(self.options[:config], opt_parser)
        @options.merge!(options) { |key, old, new| old }
        app
      end

      def build_app_from_string
        Rack::Builder.new_from_string(self.options[:builder])
      end
  end
end

options[:config] 值預設為 config.ru，其中包含此

# This file is used by Rack-based servers to start the application.

require_relative "config/environment"

run Rails.application

此處的 Rack::Builder.parse_file 方法會從此 config.ru 檔案中取得內容，並使用此程式碼剖析它

module Rack
  class Builder
    def self.load_file(path, opts = Server::Options.new)
      # ...
      app = new_from_string cfgfile, config
      # ...
    end

    # ...

    def self.new_from_string(builder_script, file = "(rackup)")
      eval "Rack::Builder.new {\n" + builder_script + "\n}.to_app",
        TOPLEVEL_BINDING, file, 0
    end
  end
end

Rack::Builder 的 initialize 方法將在此處取得區塊，並在 Rack::Builder 的實例中執行它。這是 Rails 初始化流程大部分發生的地方。config.ru 中 config/environment.rb 的 require 行是第一個執行的

require_relative "config/environment"

1.10 `config/environment.rb`

此檔案是 config.ru (bin/rails server) 和 Passenger 所需的通用檔案。這是兩種執行伺服器方式的交會點；此點之前的一切都是 Rack 和 Rails 設定。

此檔案開頭需要 config/application.rb

require_relative "application"

1.11 `config/application.rb`

此檔案需要 config/boot.rb

require_relative "boot"

但前提是之前沒有需要，這在 bin/rails server 中是這種情況，但在 Passenger 中則不會是這種情況。

然後好戲開始！

2 載入 Rails

config/application.rb 中的下一行是

require "rails/all"

2.1 `railties/lib/rails/all.rb`

此檔案負責載入 Rails 的所有個別框架

require "rails"

%w(
  active_record/railtie
  active_storage/engine
  action_controller/railtie
  action_view/railtie
  action_mailer/railtie
  active_job/railtie
  action_cable/engine
  action_mailbox/engine
  action_text/engine
  rails/test_unit/railtie
).each do |railtie|
  begin
    require railtie
  rescue LoadError
  end
end

這是載入所有 Rails 框架的地方，因此它們可用於應用程式。我們不會詳細說明每個框架內部發生的情況，但鼓勵您嘗試自行探索它們。

目前，請記住像 Rails 引擎、I18n 和 Rails 設定等常見功能都在此處定義。

2.2 回到 `config/environment.rb`

config/application.rb 的其餘部分定義了 Rails::Application 的設定，該設定將在應用程式完全初始化後使用。當 config/application.rb 完成加載 Rails 並定義了應用程式命名空間後，我們回到 config/environment.rb。在此，應用程式會使用 Rails.application.initialize! 初始化，該方法定義於 rails/application.rb 中。

2.3 `railties/lib/rails/application.rb`

initialize! 方法看起來像這樣

def initialize!(group = :default) # :nodoc:
  raise "Application has been already initialized." if @initialized
  run_initializers(group, self)
  @initialized = true
  self
end

您只能初始化應用程式一次。Railtie 的初始化器透過 run_initializers 方法執行，該方法定義於 railties/lib/rails/initializable.rb 中。

def run_initializers(group = :default, *args)
  return if instance_variable_defined?(:@ran)
  initializers.tsort_each do |initializer|
    initializer.run(*args) if initializer.belongs_to?(group)
  end
  @ran = true
end

run_initializers 程式碼本身很複雜。Rails 在這裡做的是遍歷所有類別的祖先，尋找那些回應 initializers 方法的祖先。然後，它會依名稱排序祖先並執行它們。例如，Engine 類別將透過在其上提供 initializers 方法來使所有引擎可用。

Rails::Application 類別（如 railties/lib/rails/application.rb 中所定義）定義了 bootstrap、railtie 和 finisher 初始化器。bootstrap 初始化器準備應用程式（例如初始化記錄器），而 finisher 初始化器（例如建構中介軟體堆疊）則最後執行。railtie 初始化器是在 Rails::Application 本身上定義的初始化器，並且在 bootstrap 和 finishers 之間執行。

請不要將 Railtie 的整體初始化器與load_config_initializers 初始化器實例或其在 config/initializers 中相關的設定初始化器混淆。

完成後，我們回到 Rack::Server。

2.4 Rack：lib/rack/server.rb

上次我們離開時，正在定義 app 方法

module Rack
  class Server
    def app
      @app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
    end

    # ...

    private
      def build_app_and_options_from_config
        if !::File.exist? options[:config]
          abort "configuration #{options[:config]} not found"
        end

        app, options = Rack::Builder.parse_file(self.options[:config], opt_parser)
        @options.merge!(options) { |key, old, new| old }
        app
      end

      def build_app_from_string
        Rack::Builder.new_from_string(self.options[:builder])
      end
  end
end

此時，app 是 Rails 應用程式本身（一個中介軟體），接下來會發生的事情是 Rack 將呼叫所有提供的中介軟體

module Rack
  class Server
    private
      def build_app(app)
        middleware[options[:environment]].reverse_each do |middleware|
          middleware = middleware.call(self) if middleware.respond_to?(:call)
          next unless middleware
          klass, *args = middleware
          app = klass.new(app, *args)
        end
        app
      end
  end
end

請記住，build_app 是在 Rack::Server#start 的最後一行中被 wrapped_app 呼叫的。以下是我們離開時的樣子

server.run wrapped_app, options, &blk

此時，server.run 的實作將取決於您使用的伺服器。例如，如果您使用的是 Puma，則 run 方法看起來會像這樣

module Rack
  module Handler
    module Puma
      # ...
      def self.run(app, options = {})
        conf   = self.config(app, options)

        events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio

        launcher = ::Puma::Launcher.new(conf, events: events)

        yield launcher if block_given?
        begin
          launcher.run
        rescue Interrupt
          puts "* Gracefully stopping, waiting for requests to finish"
          launcher.stop
          puts "* Goodbye!"
        end
      end
      # ...
    end
  end
end

我們不會深入探討伺服器設定本身，但這是我們在 Rails 初始化過程中旅程的最後一塊拼圖。

這個高層次的概述將幫助您了解您的程式碼何時以及如何執行，並且整體上成為一個更好的 Rails 開發人員。如果您仍然想了解更多資訊，Rails 原始碼本身可能是接下來最好的去處。