Belongs To

belongs to 会与另一个模型建立了一对一的连接。 这种模型的每一个实例都“属于”另一个模型的一个实例。

例如,您的应用包含 user 和 company,并且每个 user 能且只能被分配给一个 company。下面的类型就表示这种关系。 注意,在 User 对象中,有一个和 Company 一样的 CompanyID。 默认情况下, CompanyID 被隐含地用来在 UserCompany 之间创建一个外键关系, 因此必须包含在 User 结构体中才能填充 Company 内部结构体。

  1. // `User` 属于 `Company`,`CompanyID` 是外键
  2. type User struct {
  3. gorm.Model
  4. Name string
  5. CompanyID int
  6. Company Company
  7. }
  8. type Company struct {
  9. ID int
  10. Name string
  11. }

请参阅 预加载 以了解内部结构的详细信息。

重写外键

要定义一个 belongs to 关系,数据库的表中必须存在外键。默认情况下,外键的名字,使用拥有者的类型名称加上表的主键的字段名字

例如,定义一个User实体属于Company实体,那么外键的名字一般使用CompanyID。

GORM同时提供自定义外键名字的方式,如下例所示。

  1. type User struct {
  2. gorm.Model
  3. Name string
  4. CompanyRefer int
  5. Company Company `gorm:"foreignKey:CompanyRefer"`
  6. // 使用 CompanyRefer 作为外键
  7. }
  8. type Company struct {
  9. ID int
  10. Name string
  11. }

重写引用

对于 belongs to 关系,GORM 通常使用数据库表,主表(拥有者)的主键值作为外键参考。 正如上面的例子,我们使用主表Company中的主键字段ID作为外键的参考值。

如果设置了User实体属于Company实体,那么GORM会自动把Company中的ID属性保存到User的CompanyID属性中。

同样的,您也可以使用标签 references 来更改它,例如:

  1. type User struct {
  2. gorm.Model
  3. Name string
  4. CompanyID string
  5. Company Company `gorm:"references:Code"` // 使用 Code 作为引用
  6. }
  7. type Company struct {
  8. ID int
  9. Code string
  10. Name string
  11. }

NOTE 如果外键名恰好在拥有者类型中存在,GORM 通常会错误的认为它是 has one 关系。我们需要在 belongs to 关系中指定 references

  1. type User struct {
  2. gorm.Model
  3. Name string
  4. CompanyID string
  5. Company Company `gorm:"references:CompanyID"` // 使用 Company.CompanyID 作为引用
  6. }
  7. type Company struct {
  8. CompanyID int
  9. Code string
  10. Name string
  11. }

Belongs to 的 CRUD

查看 关联模式 获取 belongs to 相关的用法

预加载

GORM 可以通过 PreloadJoins 预加载 belongs to 关联的记录,查看 预加载 获取详情

外键约束

你可以通过 constraint 标签配置 OnUpdateOnDelete 实现外键约束,在使用 GORM 进行迁移时它会被创建,例如:

  1. type User struct {
  2. gorm.Model
  3. Name string
  4. CompanyID int
  5. Company Company `gorm:"constraint:OnUpdate:CASCADE,OnDelete:SET NULL;"`
  6. }
  7. type Company struct {
  8. ID int
  9. Name string
  10. }