自动加载路径和嵌套服务类在 Ruby 中崩溃

Question

我在 Rails 5 项目中的 app/services 文件夹下加载/需要类有多个问题，我开始放弃这个问题。

首先要明确一点，services/ 是我在整个项目中使用的简单 PORO 类，用于从控制器、模型等中抽象出大部分业务逻辑。

这棵树是这样的

app/
 services/
  my_service/
    base.rb
    funny_name.rb
  my_service.rb  
models/
 funny_name.rb

失败 #1

首先，当我尝试使用 MyService.const_get('FunnyName') 时，它从我的模型目录中获得了 FunnyName。当我直接执行MyService::FunnyName 时，它似乎没有相同的行为，但在我的大多数测试和更改中，这工作正常，这很奇怪。

我意识到 Rails config.autoload_paths 不会递归加载东西；第一个被捕获的FunnyName 是models/funny_name.rb 是有道理的，因为它肯定已经加载，而不是另一个。

没关系，让我们找到解决方法。我将此添加到我的application.rb：

config.autoload_paths += Dir[Rails.root.join('app', 'services', '**/')]

这会将服务的所有子目录添加到config.autoload_paths。显然，从 Rails 5 开始不建议写这样的东西；但这个想法对我来说确实是正确的。

失败 #2

现在，当我启动我的应用程序时，它会崩溃并输出类似这样的内容

无法自动加载常量 Base，预期 /.../backend/app/services/my_service/base.rb 来定义它（LoadError）

名称已更改，但它是我之前编写的树的匹配路径

问题是，base.rb 是在错误导致我的确切文件中定义的，其中包含类似

class MyService
  class Base
  end
end

糟糕的解决方案

所以我尝试了其他解决方法，其中很多，但没有任何效果。所以我最终完全删除了 autoload_paths 并将其直接添加到 application.rb

Dir[Rails.root.join('app', 'services', '**', '*.rb')].each { |file| require file }

现在base.rb 已正确加载，MyService.const_get('FunnyName') 实际上将返回正确的类并且一切正常，但这是一个令人作呕的解决方法。此外，它尚未在 production 中进行测试，但它可能会根据环境产生问题。

要求application.rb 提供整棵树听起来是个坏主意，我认为不能这样保留。

在 Rails 中添加自定义 services/ 目录的最简洁方法是什么？它包含多个具有简单名称的子目录和类，这些名称也存在于应用程序的其他部分（模型、base.rb 等）

如何避免混淆 autoload_paths ？还有什么我不知道可以解决问题的方法吗？为什么base.rb 会在这里崩溃？

Answer 1

工作解决方案

经过更深入的调查和尝试，我意识到我必须eager_load 服务以避免在调用诸如const_get('MyClassWithModelName') 之类的元功能时得到错误的常量。

但事情是这样的：经典的eager_load_paths 不起作用，因为出于某种原因，这些类显然会在 Rails 的整个核心初始化之前被加载，而简单的类名，例如 Base 实际上会被混合与核心一起，因此让一切崩溃。

有些人可能会说“然后将 Base 重命名为其他名称”，但我是否应该更改包装到命名空间中的类名，因为 Rails 告诉我这样做？我不这么认为。 类名应该保持简单，我在自定义命名空间中所做的事情与 Rails 无关。

我必须仔细考虑并写下我自己的 Rails 配置钩子。我们加载核心及其所有功能，然后递归地加载service/。

顺便说一句，它不会给生产环境增加任何负担，而且非常方便开发。

要添加的代码

把它放在config/environment/development.rb 和所有其他你想在没有Rails 类冲突的情况下预先加载的环境中（比如我的例子中的test.rb）

# we eager load all services and subdirectories after Rails itself has been initializer
# why not use `eager_load_paths` or `autoload_paths` ? it makes conflict with the Rails core classes
# here we do eager them the same way but afterwards so it never crashes or has conflicts.
# see `initializers/after_eager_load_paths.rb` for more details
config.after_eager_load_paths = Dir[Rails.root.join('app', 'services', '**/')]

然后创建一个包含这个的新文件initializers/after_eager_load_paths.rb

# this is a customized eager load system
# after Rails has been initialized and if the `after_eager_load_paths` contains something
# we will go through the directories recursively and eager load all ruby files
# this is to avoid constant mismatch on startup with `autoload_paths` or `eager_load_paths`
# it also prevent any autoload failure dû to deep recursive folders with subclasses
# which have similar name to top level constants.
Rails.application.configure do
  if config.respond_to?(:after_eager_load_paths) && config.after_eager_load_paths.instance_of?(Array)
    config.after_initialize do
      config.after_eager_load_paths.each do |path|
        Dir["#{path}/*.rb"].each { |file| require file }
      end
    end
  end
end

像魅力一样工作。如果需要，您还可以将require 更改为load。

Answer 2

当我这样做时（在我所有的项目中），它看起来像这样：

app
 |- services
 |   |- sub_service
 |   |   |- service_base.rb
 |   |   |- useful_service.rb     
 |   |- service_base.rb

我把所有常用的方法定义都放在app/services/service_base.rb：

app/services/service_base.rb

class ServiceBase

  attr_accessor *%w(
    args
  ).freeze

  class < self 

    def call(args={})
      new(args).call
    end

  end

    def initialize(args)
      @args = args
    end

end

我将sub_services 常用的任何方法都放在app/services/sub_service/service_base.rb 中：

app/services/sub_service/service_base.rb

class SubService::ServiceBase < ServiceBase

    def call

    end

  private

    def a_subservice_method
    end

end

然后useful_service中的任何独特方法：

app/services/sub_service/useful_service.rb

class SubService::UsefulService < SubService::ServiceBase

    def call
      a_subservice_method
      a_useful_service_method
    end

  private

    def a_useful_service_method
    end

end

然后，我可以这样做：

SubService::UsefulService.call(some: :args)

Answer 3

用你的树，

app/
 services/
  my_class/
    base.rb
    funny_name.rb
  my_class.rb  
models/
 funny_name.rb

services/my_class/base.rb 应该类似于：

module MyClass
  class Base

services/my_class/funny_name.rb 应该类似于：

module MyClass
  class FunnyName

services/my_class.rb 应该类似于：

class MyClass

models/funny_name.rb 应该类似于：

class FunnyName

我说“应该看起来类似于”，因为类/模块是可互换的； Rails 只是在这些位置寻找要定义的这些常量。

您无需向自动加载路径添加任何内容。 Rails 自动提取 app 中的所有内容

轶事：对于您的服务目录，将它们的命名约定（文件名和底层常量）视为“_service.rb”或“ThingService”是相当普遍的——就像控制器的外观一样。模型没有这个后缀，因为它们被视为一等对象。

GitLab 有一些很棒的文件结构，非常值得一看。 https://gitlab.com/gitlab-org/gitlab-ce