（20）ASP.NET Core2.2 EF创建模型（必需属性和可选属性、最大长度、并发标记、阴影属性） - 指南

1.必需和可选属性

如果实体属性可以包含null，则将其视为可选。如果属性的有效值不可以包含null，则将其视为必需属性。映射到关系数据库架构时，必需的属性将创建为不可为null的列，而可选属性则创建为可以为null的列。

1.1约定

按照约定，.NET 类型可以包含null的属性将配置为可选，而.NET类型不包含null的属性将根据需要进行配置。例如，具有.net值类型（int、decimal、bool等）的所有属性都是必需的，而具有可为null的.net值类型（int?、decimal?、bool?等）的所有属性都是配置为可选。

1.2数据批注

可以按如下所示将"约定"可以为"可选"的属性配置为"必需"：

namespace EFModeling.DataAnnotations.Required
{
    class MyContext : DbContext
    {
        public DbSet Blogs { get; set; }
    }
    public class Blog
    {
        public int BlogId { get; set; }
        //加上这个批注，这个值就必需写入
        [Required]
        public string Url { get; set; }
    }
}

1.3Fluent API

namespace EFModeling.FluentAPI.Required
{
    class MyContext : DbContext
    {
        public DbSet Blogs { get; set; }
        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.Entity()
                .Property(b => b.Url)
                //这个方法表示必需写入
                .IsRequired();
        }
    }
    public class Blog
    {
        public int BlogId { get; set; }
        public string Url { get; set; }
    }
}

2.最大长度

配置最大长度可为数据存储提供有关要对给定属性使用的相应数据类型的提示。最大长度仅适用于数组数据类型，如string和byte[]。例如前端传统数据长度远大于限定的长度，则提示。

2.1约定

按照约定，应由数据库提供程序为属性选择适当的数据类型，即数据库字段设置长度多少，生产程序实体接受值时就限定长度多少。对于具有长度的属性，数据库提供程序通常将选择允许最长数据长度的数据类型。例如，Microsoft SQL Server将对字符string属性使用 nvarchar(max)（如果该列用作键，则会使用nvarchar(450)）。

2.2数据批注

你可以使用数据批注为属性配置最大长度。此示例面向SQL Server，因此使用数据类型 nvarchar(500)：

namespace EFModeling.DataAnnotations.MaxLength
{
    class MyContext : DbContext
    {
        public DbSet Blogs { get; set; }
    }
    public class Blog
    {
        public int BlogId { get; set; }
        //设置最大长度
        [MaxLength(500)]
        public string Url { get; set; }
    }
}

2.3Fluent API

namespace EFModeling.FluentAPI.MaxLength
{
    class MyContext : DbContext
    {
        public DbSet Blogs { get; set; }
        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.Entity()
                .Property(b => b.Url)
                //设置最大长度
                .HasMaxLength(500);
        }
    }
    public class Blog
    {
        public int BlogId { get; set; }
        public string Url { get; set; }
    }
}

3.并发标记

当我们发现生产环境某个实体字段经常处于并发当中，我们可以批注一下为并发字段。

3.1约定

按照约定，属性永远不会配置为并发标记。

3.2数据注释

您可以使用数据批注将属性配置为并发标记：

public class Person
{public int PersonId { get; set; }//并发标记
    [ConcurrencyCheck]
    public string LastName { get; set; }
    public string FirstName { get; set; }
}

3.3Fluent API

您可以使用熟知的API将属性配置为并发标记：

class MyContext : DbContext
{
    public DbSet People { get; set; }
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity()
            .Property(p => p.LastName)
            //并发标记
            .IsConcurrencyToken();
    }
}
public class Person
{
    public int PersonId { get; set; }
    public string LastName { get; set; }
    public string FirstName { get; set; }
}

4.时间戳/行版本

时间戳是一个属性类型，在每次插入或更新行时，数据库都会生成一个新值。此该属性类型也被视为并发标记。这可以确保在你和其他人修改了行数据时你会收到异常信息。

4.1约定

按照约定，属性永远不会配置为时间戳。

4.2数据注释

你可以使用数据批注将属性配置为时间戳：

public class Blog
{
    public int BlogId { get; set; }
    public string Url { get; set; }
    //设置时间戳
    [Timestamp]
    public byte[] Timestamp { get; set; }
}

4.3Fluent API

你可以使用熟知的API将属性配置为时间戳：

class MyContext : DbContext
{
    public DbSet Blogs { get; set; }
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity()
            .Property(p => p.Timestamp)
            //设置时间戳
            .IsRowVersion();
    }
}
public class Blog
{
    public int BlogId { get; set; }
    public string Url { get; set; }
    public byte[] Timestamp { get; set; }
}

5.阴影属性

当数据库中的数据不应在映射的实体类型上公开时，阴影属性非常有用。它们最常用于外键属性，其中两个实体之间的关系由数据库中的外键值表示，但使用实体类型之间的导航属性在实体类型上管理关系，可以通过ChangeTracker API获取和更改影子属性值：

context.Entry(myBlog).Property("LastUpdated").CurrentValue = DateTime.Now;

可以通过EF.Property静态方法在LINQ查询中引用影子属性：

var blogs = context.Blogs.OrderBy(b => EF.Property(b, "LastUpdated"));

5.1约定

如果发现了关系，但在依赖实体类中找不到外键属性，则可以按约定创建阴影属性。在这种情况下，将引入阴影外键属性。影子外键属性将命名<navigation property name><principal key property name>为（指向主体实体的依赖实体上的导航用于命名）。如果主体键属性名称包含导航属性的名称，则该名称将只是<principal key property name>。如果依赖实体上没有导航属性，则会在其位置使用主体类型名称。例如，下面的代码列表将导致BlogId Post向实体引入阴影属性：

class MyContext : DbContext
{
    public DbSet Blogs { get; set; }
    public DbSet Posts { get; set; }
}
public class Blog
{
    public int BlogId { get; set; }
    public string Url { get; set; }
    //阴影属性
    public List Posts { get; set; }
}
public class Post
{
    public int PostId { get; set; }
    public string Title { get; set; }
    public string Content { get; set; }
     //阴影属性
    public Blog Blog { get; set; }
}

5.2数据注释

不能通过数据批注创建阴影属性。

5.3Fluent API

你可以使用"熟知API"配置阴影属性。一旦你调用了Property方法的字符串重载，就可以链接到其他属性的任何配置调用。如果提供Property方法的名称与现有属性的名称相匹配（一个阴影属性或在实体类中定义的属性），则代码将配置该现有属性，而不是引入新的阴影属性：

class MyContext : DbContext
{
    public DbSet Blogs { get; set; }
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity()
            //创建阴影属性
            .Property("LastUpdated");
    }
}
public class Blog
{
    public int BlogId { get; set; }
    public string Url { get; set; }
}

参考文献：
必需和可选属性https://learn.microsoft.com/zh-cn/ef/core/modeling/entity-properties?tabs=data-annotations%2Cwithout-nrt#required-and-optional-properties
最大长度https://learn.microsoft.com/zh-cn/ef/core/modeling/entity-properties?tabs=data-annotations%2Cwith-nrt#maximum-length
并发标记https://learn.microsoft.com/zh-cn/ef/core/saving/concurrency?tabs=data-annotations
阴影属性https://learn.microsoft.com/zh-cn/ef/core/modeling/shadow-properties