Rails 6.1迁移add_reference参数数量错误：第三个参数来源排查

核心原因 #

这个额外的{:foreign_key=>true}参数，90%以上是项目内部的自定义补丁（monkey patch）或者第三方gem改写了add_reference方法，强制注入的。Rails 6.1原生的add_reference方法本身支持第三个options参数，默认不会自动传入foreign_key: true，所以肯定是外部代码修改了原方法的调用逻辑。

排查步骤 #

• 检查项目自定义补丁
  1. 查看config/initializers目录下的所有文件，有没有对ActiveRecord::Migration或ActiveRecord::ConnectionAdapters::SchemaStatements（add_reference的定义模块）进行重写的代码。
  2. 检查lib目录下是否有迁移扩展相关文件（比如migration_extensions.rb），这类文件常被用来封装通用迁移逻辑，很可能会改写add_reference。
• 排查第三方gem
  查看Gemfile里的数据库相关gem、团队内部私有gem，有没有声称会增强迁移功能的，这类gem可能会对add_reference做包装，注入额外参数。
• 验证方法源
  在迁移文件里临时加一行代码，打印add_reference的定义位置：

  class AddImmuneVaccineToImmuneRecord < ActiveRecord::Migration[6.1]
    def change
      puts ActiveRecord::ConnectionAdapters::SchemaStatements.instance_method(:add_reference).source_location
      add_reference :immunisation_records, :immune_vaccine
    end
  end
  

  执行迁移后，如果输出的路径不是Rails源码目录（比如.../gems/activerecord-6.1.x/lib/...），那说明这个方法被重写过，顺着路径找到修改的代码即可。

解决办法 #

• 如果是自定义补丁导致的，修改补丁代码，去掉强制注入foreign_key: true的逻辑，或者兼容Rails 6.1的方法签名（确保参数传递正确）。
• 如果是第三方gem导致的，升级该gem到兼容Rails 6.1的版本，或者替换为功能类似的兼容gem。

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