在哪里放置在多个模型中找到的通用代码？

Question

我有两个包含相同方法的模型：

def foo
  # do something
end

我应该把它放在哪里？

我知道公共代码位于 Rails 应用程序的 lib 目录 中。

但是，如果我将其放入 lib 中名为“Foo”的新类中，并且我需要将其功能添加到我的两个 ActiveRecord 模型 ，我是否这样做：

class A < ActiveRecord::Base
includes Foo

class B < ActiveRecord::Base
includes Foo

然后 A 和 B 都将包含 foo 方法，就像我在每个方法中定义了它一样？

Answer 1

创建一个模块，您可以将其放入 lib 目录中：

module Foo
  def foo
    # do something
  end
end

然后您可以在每个模型类中包含该模块：

class A < ActiveRecord::Base
  include Foo
end

class B < ActiveRecord::Base
  include Foo
end

A 和B 模型现在将定义一个 foo 方法。

如果您遵循 Rails 命名约定，使用模块名称和文件名称（例如 foo.rb 中的 Foo 和 foo_bar.rb 中的 FooBar），那么 Rails 将自动为您加载该文件。否则，您将需要使用 require_dependency 'file_name' 加载您的 lib 文件。

Answer 2

您实际上有两个选择：

1. 使用通用逻辑模块并将其包含在 A & 中。 B
2. 使用扩展 ActiveRecord 并具有 A 和 A 的通用类 C； B 扩展 C。

如果共享功能不是每个类的核心，但适用于每个类，则使用#1。例如：

(app/lib/serializable.rb)
module Serializable
  def serialize
    # do something to serialize this object
  end
end

如果共享功能对于每个类和 A 和 A 都是通用的，则使用#2。 B 具有天然的关系：

(app/models/letter.rb)
class Letter < ActiveRecord::Base
  def cyrilic_equivilent
    # return somethign similar
  end
end

class A < Letter
end

class B < Letter
end

Answer 3

我是这样做的...首先创建 mixin：

module Slugged
  extend ActiveSupport::Concern

  included do
    has_many :slugs, :as => :target
    has_one :slug, :as => :target, :order => :created_at
  end
end

然后将其混合到需要它的每个模型中：

class Sector < ActiveRecord::Base
  include Slugged

  validates_uniqueness_of :name
  etc
end

这几乎很漂亮！

为了完成这个例子，虽然它与问题无关，但这是我的 slug 模型：

class Slug < ActiveRecord::Base
  belongs_to :target, :polymorphic => true
end

Answer 4

一种选择是将它们放在新目录中，例如 app/models/modules/。然后，您可以将其添加到 config/environment.rb 中：

Dir["#{RAILS_ROOT}/app/models/modules/*.rb"].each do |filename|
  require filename
end

这将需要该目录中的每个文件，因此如果您将如下所示的文件放入模块目录中：

module SharedMethods
  def foo
    #...
  end
end

然后你就可以在你的模型中使用它，因为它会自动加载：

class User < ActiveRecord::Base
  include SharedMethods
end

这种方法比将这些 mixins 放在 lib 目录中更有组织性，因为它们位于使用它们的类附近。

Answer 5

如果您需要 ActiveRecord::Base 代码作为常用功能的一部分，那么使用抽象类也可能很有用。比如：

class Foo < ActiveRecord::Base
  self.abstract_class = true
  #Here ActiveRecord specific code, for example establish_connection to a different DB.
end

class A < Foo; end
class B < Foo; end

就这么简单。另外，如果代码与 ActiveRecord 无关，请查找 ActiveSupport::Concerns 作为更好的方法。

Answer 6

正如其他人提到的， include Foo 是做事的方式......但是，它似乎无法通过基本模块为您提供所需的功能。以下是许多 Rails 插件除了新实例方法之外添加类方法和新回调的形式。

module Foo #:nodoc:

  def self.included(base) # :nodoc:
    base.extend ClassMethods
  end

  module ClassMethods
    include Foo::InstanceMethods

    before_create :before_method
  end

  module InstanceMethods
    def foo
      ...
    end

    def before_method
      ...
    end
  end 

end