如何在ActiveRecord中设置默认值？

Question

如何在ActiveRecord中设置默认值？

我看到Pratik的一篇文章描述了一段丑陋,复杂的代码:http://m.onkey.org/2007/7/24/how-to-set-default-values-in-your-model

class Item < ActiveRecord::Base  
  def initialize_with_defaults(attrs = nil, &block)
    initialize_without_defaults(attrs) do
      setter = lambda { |key, value| self.send("#{key.to_s}=", value) unless
        !attrs.nil? && attrs.keys.map(&:to_s).include?(key.to_s) }
      setter.call('scheduler_type', 'hotseat')
      yield self if block_given?
    end
  end
  alias_method_chain :initialize, :defaults
end

我已经看到以下示例谷歌搜索:

  def initialize 
    super
    self.status = ACTIVE unless self.status
  end

和

  def after_initialize 
    return unless new_record?
    self.status = ACTIVE
  end

我也看到人们把它放在他们的迁移中,但我宁愿看到它在模型代码中定义.

是否有规范方法为ActiveRecord模型中的字段设置默认值？

Answer 1

每种可用方法都存在几个问题,但我认为定义after_initialize回调是出于以下原因的方法:

1. default_scope将初始化新模型的值,但随后将成为您找到模型的范围.如果您只想将某些数字初始化为0,那么这不是您想要的.
2. 在迁移定义的默认值也工作在部分时间......正如已经提到这个会不会当你只需要调用Model.new工作.
3. 覆盖initialize可以工作,但不要忘记打电话super!
4. 使用像phusion这样的插件有点荒谬.这是红宝石,我们真的需要一个插件来初始化一些默认值吗？
5. 从Rails 3开始,after_initialize 不推荐使用覆盖.当我after_initialize在rails 3.0.3中覆盖时,我在控制台中收到以下警告:

弃用警告:不推荐使用Base#after_initialize,请改用Base.after_initialize:方法.(来自/ Users/me/myapp/app/models/my_model:15)

因此我会说写一个after_initialize回调,它允许你默认属性,除了让你设置关联的默认值,如下所示:

  class Person < ActiveRecord::Base
    has_one :address
    after_initialize :init

    def init
      self.number  ||= 0.0           #will set the default value only if it's nil
      self.address ||= build_address #let's you set a default association
    end
  end    

现在您只有一个地方可以查找模型的初始化.我正在使用这种方法,直到有人想出一个更好的方法.

注意事项:

1. 对于布尔字段,执行:

   self.bool_field = true if self.bool_field.nil?

   有关详细信息,请参阅Paul Russell对此答案的评论

2. 如果您只为模型选择列的子集(即; select在类似查询中使用Person.select(:firstname, :lastname).all),您将获得一个MissingAttributeErrorif您的init方法是否访问未包含在该select子句中的列.你可以这样防范这种情况:

   self.number ||= 0.0 if self.has_attribute? :number

   并为布尔列...

   self.bool_field = true if (self.has_attribute? :bool_value) && self.bool_field.nil?

   另请注意,Rails 3.2之前的语法不同(请参阅下面的Cliff Darling的评论)

Answer 2

在Rails 5+中,您可以在模型中使用属性方法,例如:

class Account < ApplicationRecord
  attribute :locale, :string, default: 'en'
end

Answer 3

我们通过迁移(通过:default在每个列定义上指定选项)将默认值放在数据库中,并让Active Record使用这些值来设置每个属性的默认值.

恕我直言,这种方法符合AR的原则:约定优于配置,DRY,表定义驱动模型,而不是相反.

请注意,默认值仍在应用程序(Ruby)代码中,但不在模型中,而是在迁移中.

Answer 4

一些简单的情况可以通过在数据库模式中定义默认值来处理,但是不能处理许多棘手的情况,包括计算值和其他模型的键.对于这些情况,我这样做:

after_initialize :defaults

def defaults
   unless persisted?
    self.extras||={}
    self.other_stuff||="This stuff"
    self.assoc = [OtherModel.find_by_name('special')]
  end
end

我决定使用after_initialize,但我不希望它应用于只找到新的或创建的对象.我认为对于这个明显的用例没有提供after_new回调几乎令人震惊,但我已经通过确认该对象是否已经持久化表明它不是新的来做到了.

看过Brad Murray的回答,如果条件转移到回调请求,这甚至更清晰:

after_initialize :defaults, unless: :persisted?
              # ":if => :new_record?" is equivalent in this context

def defaults
  self.extras||={}
  self.other_stuff||="This stuff"
  self.assoc = [OtherModel.find_by_name('special')]
end

Answer 5

只需执行以下操作即可改进after_initialize回调模式

after_initialize :some_method_goes_here, :if => :new_record?

如果您的初始化代码需要处理关联,这会带来非常重要的好处,因为如果您在不包含关联的情况下读取初始记录,则以下代码会触发一个微妙的n + 1.

class Account

  has_one :config
  after_initialize :init_config

  def init_config
    self.config ||= build_config
  end

end

Answer 6

Phusion的家伙有一些不错的插件.

Answer 7

轨道 6.1+

现在，您可以在模型上使用属性方法，而无需设置类型。

attribute :status, default: ACTIVE

或者

class Account < ApplicationRecord
  attribute :locale, default: 'en'
end

请注意，提供默认值attribute不能引用类的实例（lambda 将在类的上下文中执行，而不是在实例中执行）。因此，如果您需要根据实例或关联动态地将默认值设置为一个值，您仍然需要使用替代方案，例如回调after_initialize。如前所述，建议仅将其限制为新记录，以避免在引用关联时出现 n+1 查询。

after_initialize :do_something_that_references_instance_or_associations, if: :new_record?

Answer 8

我用的是attribute-defaults宝石

从文档:运行sudo gem install attribute-defaults并添加require 'attribute_defaults'到您的应用程序.

class Foo < ActiveRecord::Base
  attr_default :age, 18
  attr_default :last_seen do
    Time.now
  end
end

Foo.new()           # => age: 18, last_seen => "2014-10-17 09:44:27"
Foo.new(:age => 25) # => age: 25, last_seen => "2014-10-17 09:44:28"

Answer 9

比建议的答案更好/更清晰的潜在方式是覆盖访问器,如下所示:

def status
  self['status'] || ACTIVE
end

请参阅ActiveRecord :: Base文档中的 "覆盖默认访问器" 以及使用self时StackOverflow中的更多信息.

Answer 10

类似的问题,但都有不同的上下文: - 如何在Rails activerecord的模型中为属性创建默认值？

最佳答案:取决于你想要的!

如果您希望每个对象都以值开头:使用after_initialize :init

您希望new.html表单在打开页面时具有默认值吗？使用/sf/answers/358937911/

class Person < ActiveRecord::Base
  has_one :address
  after_initialize :init

  def init
    self.number  ||= 0.0           #will set the default value only if it's nil
    self.address ||= build_address #let's you set a default association
  end
  ...
end 

如果您希望每个对象都具有根据用户输入计算的值:使用before_save :default_values 您希望用户输入X然后Y = X+'foo'？使用:

class Task < ActiveRecord::Base
  before_save :default_values
  def default_values
    self.status ||= 'P'
  end
end

Answer 11

我也看到人们把它放在他们的迁移中，但我宁愿看到它在模型代码中定义。

有没有一种规范的方法来为 ActiveRecord 模型中的字段设置默认值？

在 Rails 5 之前，规范的 Rails 方式实际上是在迁移中设置它，并且db/schema.rb只要想查看数据库为任何模型设置的默认值时就查看 for。

与@Jeff Perrin 的回答（有点旧）相反Model.new，由于一些 Rails 魔法，迁移方法甚至会在使用时应用默认值。已验证在 Rails 4.1.16 中工作。

最简单的东西往往是最好的。减少代码库中的知识债务和潜在的混淆点。它“有效”。

class AddStatusToItem < ActiveRecord::Migration
  def change
    add_column :items, :scheduler_type, :string, { null: false, default: "hotseat" }
  end
end

或者，对于不创建新列的列更改，请执行以下任一操作：

class AddStatusToItem < ActiveRecord::Migration
  def change
    change_column_default :items, :scheduler_type, "hotseat"
  end
end

或者甚至更好：

class AddStatusToItem < ActiveRecord::Migration
  def change
    change_column :items, :scheduler_type, :string, default: "hotseat"
  end
end

查看官方RoR 指南以了解列更改方法中的选项。

在null: false不允许使用空值在DB，并且，作为一个额外的好处，同时也更新，所以这在以前是空的所有预先存在的数据库记录被设定的默认值这个领域也是如此。如果您愿意，您可以在迁移中排除此参数，但我发现它非常方便！

正如@Lucas Caton 所说，Rails 5+ 中的规范方式是：

class Item < ActiveRecord::Base
  attribute :scheduler_type, :string, default: 'hotseat'
end