Rails模型关联迁移报错：teachers表不存在，求解决方案

问题描述 #

需要建立两个模型关联，其中User模型为自关联，执行操作后在添加Lab的Teacher关联时出现数据库迁移错误。

实验步骤 #

rails new test1 -d mysql
rails g scaffold User name
rails g migration AddTeacherToUsers #add_reference :users, :teacher, index: true 
rails g scaffold Lab name user:references
rails db:create db:migrate

系统执行反馈 #

Created database 'test1_development'
Created database 'test1_test'
20230416164900 CreateUsers: migrating ==
create_table(:users)
0.1837s
20230416164900 CreateUsers: migrated (0.1839s) ==

20230416164941 AddTeacherToUsers: migrating ==
add_reference(:users, :teacher, {:index=>true})
0.4567s
20230416164941 AddTeacherToUsers: migrated (0.4568s) ==

20230416165121 CreateLabs: migrating ==
create_table(:labs)
0.4219s
20230416165121 CreateLabs: migrated (0.4221s) ==

后续执行操作：

rails g migration AddTeacherToLabs teacher:references
vi app/models/lab.rb # 添加 belongs_to :teacher, class_name: "User"
rails db:migrate

错误信息 #

20230416165540 AddTeacherToLabs: migrating ==
add_reference(:labs, :teacher, {:foreign_key=>true})
rails aborted!
StandardError: An error has occurred, all later migrations canceled:

Mysql2::Error: Table 'test1_development.teachers' doesn't exist: SHOW FULL FIELDS FROM teachers
/home/patrick/test1/db/migrate/20230416165540_add_teacher_to_labs.rb:3:in change' /home/patrick/test1/bin/rails:9:in <top (required)>'
/home/patrick/test1/bin/spring:15:in <top (required)>' bin/rails:3:in load'
bin/rails:3:in `'

Caused by:
ActiveRecord::StatementInvalid: Mysql2::Error: Table 'test1_development.teachers' doesn't exist: SHOW FULL FIELDS FROM teachers
/home/patrick/test1/db/migrate/20230416165540_add_teacher_to_labs.rb:3:in change' /home/patrick/test1/bin/rails:9:in <top (required)>'
/home/patrick/test1/bin/spring:15:in <top (required)>' bin/rails:3:in load'
bin/rails:3:in `'

Caused by:
Mysql2::Error: Table 'test1_development.teachers' doesn't exist
/home/patrick/test1/db/migrate/20230416165540_add_teacher_to_labs.rb:3:in change' /home/patrick/test1/bin/rails:9:in <top (required)>'
/home/patrick/test1/bin/spring:15:in <top (required)>' bin/rails:3:in load'
bin/rails:3:in `'

Caused by:
Mysql2::Error: Can't create table test1_development.labs (errno: 150 "Foreign key constraint is incorrectly formed")
/home/patrick/test1/db/migrate/20230416165540_add_teacher_to_labs.rb:3:in change' /home/patrick/test1/bin/rails:9:in <top (required)>'
/home/patrick/test1/bin/spring:15:in <top (required)>' bin/rails:3:in load'
bin/rails:3:in `'
Tasks: TOP => db:migrate
(See full trace by running task with --trace)

问题原因 #

使用rails g migration AddTeacherToLabs teacher:references生成的迁移文件，默认会创建指向teachers表的外键约束，但实际需要关联的是users表（Teacher是User的自关联角色），数据库找不到teachers表导致外键约束创建失败。

解决步骤 #

1. 修改迁移文件 #

打开生成的迁移文件（以你实际生成的时间戳文件名为准，示例为db/migrate/20230416165540_add_teacher_to_labs.rb），修改add_reference方法，指定外键关联到users表：

class AddTeacherToLabs < ActiveRecord::Migration[7.0] # 版本号匹配你的Rails版本
  def change
    add_reference :labs, :teacher, index: true, foreign_key: { to_table: :users }
  end
end

2. 确认模型关联正确 #

确保app/models/lab.rb中的关联声明无误：

class Lab < ApplicationRecord
  belongs_to :user
  belongs_to :teacher, class_name: "User"
end

3. 补充User模型的反向关联（可选但推荐） #

在app/models/user.rb中添加反向关联，方便后续查询操作：

class User < ApplicationRecord
  # 自关联：用户的导师
  belongs_to :teacher, class_name: "User", optional: true # 非必填，避免无导师用户的验证错误
  # 反向关联：导师名下的学生
  has_many :students, class_name: "User", foreign_key: :teacher_id
  # 关联用户创建的实验室
  has_many :labs, dependent: :destroy
  # 作为导师管理的实验室
  has_many :managed_labs, class_name: "Lab", foreign_key: :teacher_id
end

4. 重新执行迁移 #

rails db:migrate

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