Entity Framework 数据注释

简介

Entity Framework (EF) 是一个用于.NET平台的ORM(Object-Relational Mapping)框架，用于简化开发人员对数据库操作的管理。数据注释是EF中的一种特性，用于为实体类的属性添加说明、验证规则以及其他元数据。

在EF中，数据注释可以通过使用注释属性（Attribute）或者 Fluent API 进行添加和配置。数据注释提供了一种声明性的方式来定义实体类的属性的一些约束和行为。

常用的数据注释特性

以下是一些常用的数据注释特性，用于在实体类的属性上添加注释。

Key

[Key]特性用于标识实体类的属性作为主键。

public class Customer
{
    [Key]
    public int Id { get; set; }
    
    public string Name { get; set; }
}

Required

[Required]特性用于标识实体类的属性不能为空。

public class Customer
{
    [Key]
    public int Id { get; set; }
    
    [Required]
    public string Name { get; set; }
}

MaxLength

[MaxLength]特性用于标识实体类的属性的最大长度。

public class Customer
{
    [Key]
    public int Id { get; set; }
    
    [Required]
    [MaxLength(50)]
    public string Name { get; set; }
}

StringLength

[StringLength]特性用于标识实体类的属性的字符串长度的限制。

public class Customer
{
    [Key]
    public int Id { get; set; }
    
    [Required]
    [StringLength(50)]
    public string Name { get; set; }
}

Range

[Range]特性用于标识实体类的属性的取值范围。

public class Product
{
    [Key]
    public int Id { get; set; }
    
    [Required]
    [Range(1, 100)]
    public int Quantity { get; set; }
}

ForeignKey

[ForeignKey]特性用于标识实体类的属性作为外键。

public class Order
{
    [Key]
    public int Id { get; set; }
    
    public int CustomerId { get; set; }
    
    [ForeignKey("CustomerId")]
    public Customer Customer { get; set; }
}

Fluent API

除了使用数据注释特性，EF还提供了 Fluent API 的方式进行数据注释的配置。Fluent API 通过使用方法链形式，提供了更灵活的数据注释配置方式。

public class CustomerConfiguration : EntityTypeConfiguration<Customer>
{
    public CustomerConfiguration()
    {
        HasKey(c => c.Id);
        
        Property(c => c.Name)
            .IsRequired()
            .HasMaxLength(50);
    }
}

总结

数据注释是EF中非常实用的功能，可以帮助开发人员快速定义实体类属性的约束和行为。通过使用数据注释，可以提高代码的可读性和维护性，并自动处理与数据库的交互过程中的验证和限制。无论是使用注释属性还是 Fluent API，数据注释都是EF中重要的一个方面，值得开发人员深入学习和使用。