跳至內容 跳至搜尋

宣告一個枚舉屬性,其值會對映至資料庫中的整數,但可以用名稱查詢。範例

class Conversation < ActiveRecord::Base
  enum :status, [ :active, :archived ]
end

# conversation.update! status: 0
conversation.active!
conversation.active? # => true
conversation.status  # => "active"

# conversation.update! status: 1
conversation.archived!
conversation.archived? # => true
conversation.status    # => "archived"

# conversation.status = 1
conversation.status = "archived"

conversation.status = nil
conversation.status.nil? # => true
conversation.status      # => nil

也會提供基於枚舉欄位允許值的範圍。使用上述範例

Conversation.active
Conversation.not_active
Conversation.archived
Conversation.not_archived

當然,如果範圍不符合你的需求,你也可以直接查詢它們

Conversation.where(status: [:active, :archived])
Conversation.where.not(status: :active)

可以透過設定 `:scopes` 為 `false` 來停用範圍定義。

class Conversation < ActiveRecord::Base
  enum :status, [ :active, :archived ], scopes: false
end

你可以透過設定 `:default` 來設定預設枚舉值,如下

class Conversation < ActiveRecord::Base
  enum :status, [ :active, :archived ], default: :active
end

conversation = Conversation.new
conversation.status # => "active"

可以使用雜湊來明確對應屬性和資料庫整數之間的關係

class Conversation < ActiveRecord::Base
  enum :status, active: 0, archived: 1
end

最後,也可以使用字串欄位來持續儲存列舉值。請注意,這可能會導致資料庫查詢速度變慢

class Conversation < ActiveRecord::Base
  enum :status, active: "active", archived: "archived"
end

請注意,當使用陣列時,從值到資料庫整數的隱式對應會衍生自值在陣列中出現的順序。在範例中,`:active` 對應到 `:0`,因為它是第一個元素,而 `:archive` 對應到 `:1`。一般而言,第 `i` 個元素在資料庫中會對應到 `i-1`。

因此,一旦將一個值加入枚舉陣列中,在陣列中的位置就必須維持,而且新的值只應該加入到陣列的尾端。要移除未使用的值,應該使用明確的雜湊語法。

在少數情況下,你可能會需要直接存取對應。對應會透過使用屬性名稱複數形式的類別方法公開,它會在 `ActiveSupport::HashWithIndifferentAccess` 中傳回對應

Conversation.statuses[:active]    # => 0
Conversation.statuses["archived"] # => 1

當你需要知道枚舉的序號值時,請使用該類別方法。例如,你在手動建立 SQL 字串時可以使用它

Conversation.where("status <> ?", Conversation.statuses[:archived])

當你需要定義具有相同值的數個枚舉時,可以使用 `:prefix` 或 `:suffix` 選項。如果傳遞的值為 `true`,方法會加上枚舉名稱的前綴/後綴。也可以提供自訂值

class Conversation < ActiveRecord::Base
  enum :status, [ :active, :archived ], suffix: true
  enum :comments_status, [ :active, :inactive ], prefix: :comments
end

使用上述範例,驚嘆號和判斷詞方法以及相關範圍目前會加上前綴和/或後綴

conversation.active_status!
conversation.archived_status? # => false

conversation.comments_inactive!
conversation.comments_active? # => false

如果你想停用自動產生在模型上的方法,可以透過設定 `:instance_methods` 選項為 false 來達成

class Conversation < ActiveRecord::Base
  enum :status, [ :active, :archived ], instance_methods: false
end

如果你希望在儲存前驗證枚舉值,請使用 `:validate` 選項

class Conversation < ActiveRecord::Base
  enum :status, [ :active, :archived ], validate: true
end

conversation = Conversation.new

conversation.status = :unknown
conversation.valid? # => false

conversation.status = nil
conversation.valid? # => false

conversation.status = :active
conversation.valid? # => true

也可以傳遞額外的驗證選項

class Conversation < ActiveRecord::Base
  enum :status, [ :active, :archived ], validate: { allow_nil: true }
end

conversation = Conversation.new

conversation.status = :unknown
conversation.valid? # => false

conversation.status = nil
conversation.valid? # => true

conversation.status = :active
conversation.valid? # => true

否則會引發 `ArgumentError`

class Conversation < ActiveRecord::Base
  enum :status, [ :active, :archived ]
end

conversation = Conversation.new

conversation.status = :unknown # 'unknown' is not a valid status (ArgumentError)
方法
E

實例公共方法

enum(name, values = nil, **options)

# File activerecord/lib/active_record/enum.rb, line 216
def enum(name, values = nil, **options)
  values, options = options, {} unless values
  _enum(name, values, **options)
end