9.5 翻译系列:数据注解之ForeignKey特性【EF 6 Code-First系列】

原文链接:https://www.entityframeworktutorial.net/code-first/foreignkey-dataannotations-attribute-in-code-first.aspx

EF 6 Code-First系列文章目录：

• 1 翻译系列:什么是Code First(EF 6 Code First 系列)
• 2.翻译系列:为EF Code-First设置开发环境(EF 6 Code-First系列)
• 3.翻译系列：EF Code-First 示例(EF 6 Code-First系列)
• 4.翻译系列:EF 6 Code-First默认约定（EF 6 Code-First系列)
• 5.翻译系列：EF 6中数据库的初始化（EF 6 Code-First 系列)
• 6.翻译系列：EF 6 Code-First中数据库初始化策略（EF 6 Code-First系列
• 7.翻译系列：EF 6中的继承策略（EF 6 Code-First 系列)
• 8.翻译系列: EF 6中配置领域类（EF 6 Code-First 系列）
• 9.翻译系列：EF 6以及EF Core中的数据注解特性（EF 6 Code-First系列）
•        9.1 翻译系列：数据注解特性之----Table【EF 6 Code-First 系列】
•        9.2 翻译系列：数据注解特性之---Column【EF 6 Code First系列】
•        9.3 翻译系列：数据注解特性之Key【EF 6 Code-First 系列】
•        9.4 翻译系列：EF 6以及 EF Core中的NotMapped特性（EF 6 Code-First系列）
•        9.5 翻译系列:数据注解之ForeignKey特性【EF 6 Code-First系列】
•        9.6 翻译系列:数据注解之Index特性【EF 6 Code-First系列】
•        9.7 翻译系列：EF数据注解特性之--InverseProperty【EF 6 Code-First系列】
•        9.8 翻译系列：数据注解特性之--Required 【EF 6 Code-First系列】
•        9.9 翻译系列：数据注解特性之--MaxLength 【EF 6 Code-First系列】
•        9.10 翻译系列：EF数据注解特性之StringLength【EF 6 Code-First系列】
•        9.11 翻译系列：数据注解特性之--Timestamp【EF 6 Code-First系列】
•        9.12 翻译系列：数据注解特性之ConcurrencyCheck【EF 6 Code-First系列】
• 10.翻译系列:EF 6中的Fluent API配置【EF 6 Code-First系列】
•        10.1.翻译系列：EF 6中的实体映射【EF 6 Code-First系列】
•        10.2.翻译系列：使用Fluent API进行属性映射【EF 6 Code-First】
• 11.翻译系列：在EF 6中配置一对零或者一对一的关系【EF 6 Code-First系列】
• 12.翻译系列：EF 6 中配置一对多的关系【EF 6 Code-First系列】
• 13.翻译系列：Code-First方式配置多对多关系【EF 6 Code-First系列】
• 14.翻译系列：从已经存在的数据库中生成上下文类和实体类【EF 6 Code-First系列】
• 15.翻译系列：EF 6中的级联删除【EF 6 Code-First 系列】
• 16.翻译系列：EF 6 Code -First中使用存储过程【EF 6 Code-First系列】
• 17.翻译系列：将Fluent API的配置迁移到单独的类中【EF 6 Code-First系列】
• 18.翻译系列：EF 6 Code-First 中的Seed Data（种子数据或原始测试数据）【EF 6 Code-First系列】
• 19.翻译系列：EF 6中定义自定义的约定【EF 6 Code-First约定】
• 20.翻译系列：Code-First中的数据库迁移技术【EF 6 Code-First系列】
•        20.1翻译系列：EF 6中自动数据迁移技术【EF 6 Code-First系列】
•        20.2.翻译系列：EF 6中基于代码的数据库迁移技术【EF 6 Code-First系列】
• 21.翻译系列：Entity Framework 6 Power Tools【EF 6 Code-First系列】

在EF 6和EF Core中，数据注解中的ForeignKey特性，是用来在两个实体间配置外键关系。根据默认的约定，当属性的名称与相关实体的主键属性匹配时，EF将该属性作为外键属性。ForeignKey Signature: [ForeignKey(name string)]
name:相关联的导航属性的名称或者相关联的外键属性名称
看看下面实体间的一对多关系：

using System.ComponentModel.DataAnnotations.Schema;

public class Student
{
    public int StudentID { get; set; }
    public string StudentName { get; set; }
        
    //Foreign key for Standard
    public int StandardId { get; set; }
    public Standard Standard { get; set; }
}

public class Standard
{
    public int StandardId { get; set; }
    public string StandardName { get; set; }
    
    public ICollection<Student> Students { get; set; }
}

上面的代码例子中，描述了Student和Standard实体中的一对多关系。为了解释一对多关系，Student类包含了一个StandardId属性还有一个引用类型的属性Standard，并且Standard实体包含了一个集合类型的导航属性Students,Student实体中的StandardId属性匹配上了Standard实体中的主键属性名称StandardId，所以Student实体中的StandardId属性将会自动变成外键属性，并在数据表中生成外键：

ForeignKey特性重写了默认的外键约定，他允许我们在依赖实体中【这里是Student】指定外键属性，这个指定的外键属性名称，不需要匹配主体实体【这里是Standard】中的主键属性名称。
使用ForeignKey数据注解特性，可以有以下三种方式：

1. [ForeignKey(NavigationPropertyName)]应用在依赖实体的外键标量属性上面，ForeignKey里面的name参数，填写导航属性的名称
2. [ForeignKey(ForeignKeyPropertyName)]应用在依赖实体的导航属性上面，ForeignKey里面的name参数，填写外键属性的名称
3. [ForeignKey(ForeignKeyPropertyName)]应用在主体实体的导航属性上面，ForeignKey里面的name参数，填写外键属性的名称

1.[ForeignKey] on the foreign key property in the dependent entity

ForeignKey应用在依赖实体的外键属性上面，相关联的导航属性的名称作为ForeignKey的name参数传入：

using System.ComponentModel.DataAnnotations.Schema;

public class Student
{
    public int StudentID { get; set; }
    public string StudentName { get; set; }
        
    [ForeignKey("Standard")]
    public int StandardRefId { get; set; }
    public Standard Standard { get; set; }
}

public class Standard
{
    public int StandardId { get; set; }
    public string StandardName { get; set; }
    
    public ICollection<Student> Students { get; set; }
}

在上面的例子中，ForeignKey特性应用于StandardRefId属性上，并且传入导航属性的名称Standard到name参数上，这样就会在Students表中创建一个外键列StandardRefId，这样就不会生成默认的StandardID列了。

2.[ForeignKey] on the navigation property in the dependent entity

ForeignKey特性可以应用在导航属性上面，然后name参数就指定外键属性列的名称：

using System.ComponentModel.DataAnnotations.Schema;

public class Student
{
    public int StudentID { get; set; }
    public string StudentName { get; set; }
        
    public int StandardRefId { get; set; }
    
    [ForeignKey("StandardRefId")]
    public Standard Standard { get; set; }
}

public class Standard
{
    public int StandardId { get; set; }
    public string StandardName { get; set; }
    
    public ICollection<Student> Students { get; set; }
}

在上面的例子中，ForeignKey特性应用在Standard导航属性上面，name参数就是外键属性的名称StandardRefId,这样就会在Students数据表中，生成一个StandardRefId外键列，就不会生成默认的StandardId列了。

3.[ForeignKey] on the navigation property in the principal entity

ForeignKey特性可以应用在主体实体的导航属性上面，name参数就指定外键属性的名称：

using System.ComponentModel.DataAnnotations.Schema;

public class Student
{
    public int StudentID { get; set; }
    public string StudentName { get; set; }
        
    public int StandardRefId { get; set; }
    public Standard Standard { get; set; }
}

public class Standard
{
    public int StandardId { get; set; }
    public string StandardName { get; set; }
    
    [ForeignKey("StandardRefId")]
    public ICollection<Student> Students { get; set; }
}

在上面的例子中，ForeignKey特性应用于主体实体Standard中的导航属性Students上，这样同样会在Students表中创建一个外键列StandardRefId.
好了，以上就是数据注解之ForeignKey特性，大家有什么不明白可以留言，感谢支持！