在 TypeORM 中,@JoinColumn
装饰器用于指定外键关系中的“拥有方”(即外键所在的表)。通常在以下情况下使用 @JoinColumn
:
1. 一对一关系(One-to-One)
- 在一对一关系中,
@JoinColumn
用于指定哪一方是关系的“拥有方”。 - 拥有方会存储外键,因此需要加上
@JoinColumn
。
@Entity()
export class User {
@PrimaryGeneratedColumn()
id: number;
@OneToOne(() => Profile)
@JoinColumn() // User 表会存储 profileId 外键
profile: Profile;
}
@Entity()
export class Profile {
@PrimaryGeneratedColumn()
id: number;
@OneToOne(() => User, user => user.profile)
user: User;
}
2. 多对一关系(Many-to-One)
- 在多对一关系中,
@JoinColumn
通常不需要显式声明,因为 TypeORM 会自动在多的一方创建外键。 - 如果你需要自定义外键列名或其他属性,可以加上
@JoinColumn
。
@Entity()
export class Post {
@PrimaryGeneratedColumn()
id: number;
@ManyToOne(() => User)
@JoinColumn({ name: 'user_id' }) // 自定义外键列名
user: User;
}
@Entity()
export class User {
@PrimaryGeneratedColumn()
id: number;
@OneToMany(() => Post, post => post.user)
posts: Post[];
}
3. 一对多关系(One-to-Many)
- 在一对多关系中,
@JoinColumn
通常不需要加在“一”的一方,因为外键会存储在“多”的一方。 - 如果你在“一”的一方加上
@JoinColumn
,TypeORM 会忽略它。
4. 多对多关系(Many-to-Many)
- 在多对多关系中,
@JoinColumn
不需要使用,因为多对多关系是通过中间表实现的。
总结
- 一对一关系:在拥有方(存储外键的一方)使用
@JoinColumn
。 - 多对一关系:通常不需要显式使用
@JoinColumn
,除非需要自定义外键列名。 - 一对多关系:不需要在“一”的一方使用
@JoinColumn
。 - 多对多关系:不需要使用
@JoinColumn
。