Rails 6 belongs_to配置optional: true不生效问题排查

你遇到的optional: true不生效问题，根源是自定义名称的belongs_to关联没有显式指定外键字段：

• Rails的belongs_to默认会按照关联名推导外键名，规则是关联名 + _id，你定义的关联名是:starting_period，Rails默认会去找不存在的starting_period_id字段当外键，而你实际数据库里存储Period关联id的字段是period_id
• 只指定class_name: 'Period'只能告诉Rails关联的模型类是哪个，不会修正外键推导逻辑，这种情况下不仅关联读写会异常，Rails 5+默认开启的belongs_to必填校验也无法正确识别optional: true配置，就会持续抛出starting_period 必填的错误
• 你看到的错误消息是message=>:required，这是Rails自动为belongs_to生成的默认校验错误，不是你自定义的条件校验抛出的，所以删除自定义校验也无法解决问题。
• 额外的兼容问题：你写的迁移版本号是[6.1]，但当前使用的Rails版本是6.0.4，版本号不匹配也可能导致迁移配置异常。

1. 修正Idea模型的关联定义 #

给belongs_to :starting_period显式指定foreign_key参数，指向实际存在的period_id字段：

class Idea < ApplicationRecord
  has_rich_text :body

  #Relationships
  has_one :action_text_rich_text, class_name: 'ActionText::RichText', as: :record
  has_many :votes, dependent: :destroy
  has_many :comments, dependent: :destroy

  belongs_to :user
  # 新增foreign_key配置，明确指定外键字段
  belongs_to :starting_period, optional: true, class_name: 'Period', foreign_key: :period_id
  
  #validations
  validates :title, presence: true
  validates :body, presence: true
  validates :user, presence: true
  validates :starting_period, presence: { message: "can't be blank if planned or started" }, if: :planned_or_started?
  validates :size, numericality: { only_integer: true, greater_than_or_equal_to: 0 }, presence: true
  validates :size, numericality: { greater_than: 0, message: "can't be unsized if planned or started" }, if: :planned_or_started?

  def planned_or_started?
    ["planned", "in_progress", "complete"].include?(progress)    
  end
end

改完后重启Rails控制台使配置生效，再新建无starting_period的Idea记录，就不会触发默认的必填校验了。

2. 补正迁移配置 #

你之前的迁移add_reference :ideas, :period, on_delete: :nullify存在问题：add_reference默认不会创建数据库层面的外键约束，on_delete: :nullify是外键约束的配置项，单独写不会生效。如果还没把迁移提交到生产环境，可以直接修改原迁移为（同时修正迁移版本号匹配当前Rails版本）：

class AddStartPeriodToIdeas < ActiveRecord::Migration[6.0]
  def change
    add_reference :ideas, :period, foreign_key: { to_table: :periods, on_delete: :nullify }
  end
end

如果迁移已经上线，新建一个迁移补充外键约束即可。

3. 优化自定义条件校验（可选最佳实践） #

你的progress字段是integer类型的枚举字段，当前用字符串数组判断状态的写法容易出现类型匹配问题，推荐改用Rails枚举自带的判断方法，更稳妥：

def planned_or_started?
  planned? || in_progress? || complete?
end

改完配置后可以在控制台做简单验证：

idea = Idea.new(title: 'test', body: 'test', user: User.first)
idea.save # 正常返回true，无starting_period相关报错
# 测试关联赋值是否正常
period = Period.first
idea.starting_period = period
idea.period_id == period.id # 返回true说明关联配置完全正常

内容的提问来源于stack exchange，提问作者Robert Neville