EF Core » 关系

2023-07-26 21:41:28

对初学者理解关系很有用，先留下来，有时间边看边翻译。

Caution 注意

This documentation is for EF Core. For EF6.x and earlier release see http://msdn.com/data/ef.

Relationships ¶

A relationship defines how two entities relate to each other. In a relational database, this is represented by a foreign key constraint.

Note

Most of the samples in this article use a one-to-many relationship to demonstrate concepts. For examples of one-to-one and many-to-many relationships see the Other Relationship Patterns section at the end of the article.

In this article:

Relationships

Definition of Terms ¶

There are a number of terms used to describe relationships

Dependent entity: This is the entity that contains the foreign key property(s). Sometimes referred to as the ‘child’ of the relationship.
Principal entity: This is the entity that contains the primary/alternate key property(s). Sometimes referred to as the ‘parent’ of the relationship.
Foreign key: The property(s) in the dependent entity that is used to store the values of the principal key property that the entity is related to.
Principal key: The property(s) that uniquely identifies the principal entity. This may be the primary key or an alternate key.
Navigation property: A property defined on the principal and/or dependent entity that contains a reference(s) to the related entity(s).
Collection navigation property: A navigation property that contains references to many related entities.
Reference navigation property: A navigation property that holds a reference to a single related entity.
Inverse navigation property: When discussing a particular navigation property, this term refers to the navigation property on the other end of the relationship.

The following code listing shows a one-to-many relationship between Blog and Post

Post is the dependent entity
Blog is the principal entity
Post.BlogId is the foreign key
Blog.BlogId is the principal key (in this case it is a primary key rather than an alternate key)
Post.Blog is a reference navigation property
Blog.Posts is a collection navigation property
Post.Blog is the inverse navigation property of Blog.Posts (and vice versa)

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> Posts { get; set; }

    }

    public class Post

    {

        public int PostId { get; set; }

        public string Title { get; set; }

        public string Content { get; set; }

        public int BlogId { get; set; }

        public Blog Blog { get; set; }

    }

Conventions ¶

By convention, a relationship will be created when there is a navigation property discovered on a type. A property is considered a navigation property if the type it points to can not be mapped as a scalar type by the current database provider.

Note

Relationships that are discovered by convention will always target the primary key of the principal entity. To target an alternate key, additional configuration must be performed using the Fluent API.

Fully Defined Relationships ¶

The most common pattern for relationships is to have navigation properties defined on both ends of the relationship and a foreign key property defined in dependent entity class.

If a pair of navigation properties is found between two types, then they will be configured as inverse navigation properties of the same relationship.
If the dependent entity contains a property named <primary key property name>, <navigation property name><primary key property name>, or <principal entity name><primary key property name> then it will be configured as the foreign key.

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> Posts { get; set; }

    }

    public class Post

    {

        public int PostId { get; set; }

        public string Title { get; set; }

        public string Content { get; set; }

        public int BlogId { get; set; }

        public Blog Blog { get; set; }

    }

Caution

If there are multiple navigation properties defined between two types (i.e. more than one distinct pair of navigations that point to each other), then no relationships will be created by convention and you will need to manually configure them to identify how the navigation properties pair up.

No Foreign Key Property ¶

While it is recommended to have a foreign key property defined in the dependent entity class, it is not required. If no foreign key property is found, a shadow foreign key property will be introduced with the name <navigation property name><principal key property name> (see Shadow Properties for more information).

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> 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; }

    }

Single Navigation Property ¶

Including just one navigation property (no inverse navigation, and no foreign key property) is enough to have a relationship defined by convention. You can also have a single navigation property and a foreign key property.

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> Posts { get; set; }

    }

    public class Post

    {

        public int PostId { get; set; }

        public string Title { get; set; }

        public string Content { get; set; }

    }

Cascade Delete ¶

By convention, cascade delete will be set to Cascade for required relationships and SetNull for optional relationships. Cascade means dependent entities are also deleted. SetNull means that foreign key properties in dependent entities are set to null.

Note

This cascading behavior is only applied to entities that are being tracked by the context. A corresponding cascade behavior should be setup in the database to ensure data that is not being tracked by the context has the same action applied. If you use EF to create the database, this cascade behavior will be setup for you.

Data Annotations ¶

There are two data annotations that can be used to configure relationships, [ForeignKey] and [InverseProperty].

[ForeignKey]¶

You can use the Data Annotations to configure which property should be used as the foreign key property for a given relationship. This is typically done when the foreign key property is not discovered by convention.

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> Posts { get; set; }

    }

    public class Post

    {

        public int PostId { get; set; }

        public string Title { get; set; }

        public string Content { get; set; }

        public int BlogForeignKey { get; set; }

        [ForeignKey("BlogForeignKey")]

        public Blog Blog { get; set; }

    }

Note

The [ForeignKey] annotation can be placed on either navigation property in the relationship. It does not need to go on the navigation property in the dependent entity class.

[InverseProperty]¶

You can use the Data Annotations to configure how navigation properties on the dependent and principal entities pair up. This is typically done when there is more than one pair of navigation properties between two entity types.

    public class Post

    {

        public int PostId { get; set; }

        public string Title { get; set; }

        public string Content { get; set; }

        public int AuthorUserId { get; set; }

        public User Author { get; set; }

        public int ContributorUserId { get; set; }

        public User Contributor { get; set; }

    }

    public class User

    {

        public string UserId { get; set; }

        public string FirstName { get; set; }

        public string LastName { get; set; }

        [InverseProperty("Author")]

        public List<Post> AuthoredPosts { get; set; }

        [InverseProperty("Contributor")]

        public List<Post> ContributedToPosts { get; set; }

    }

Fluent API ¶

To configure a relationship in the Fluent API, you start by identifying the navigation properties that make up the relationship. HasOne or HasMany identifies the navigation property on the entity type you are beginning the configuration on. You then chain a call to WithOne or WithMany to identify the inverse navigation. HasOne/WithOne are used for reference navigation properties and HasMany/WithMany are used for collection navigation properties.

    class MyContext : DbContext

    {

        public DbSet<Blog> Blogs { get; set; }

        public DbSet<Post> Posts { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<Post>()

                .HasOne(p => p.Blog)

                .WithMany(b => b.Posts);

        }

    }

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> 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; }

    }

Single Navigation Property ¶

If you only have one navigation property then there are parameterless overloads of WithOne and WithMany. This indicates that there is conceptually a reference or collection on the other end of the relationship, but there is no navigation property included in the entity class.

    class MyContext : DbContext

    {

        public DbSet<Blog> Blogs { get; set; }

        public DbSet<Post> Posts { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<Blog>()

                .HasMany(b => b.Posts)

                .WithOne();

        }

    }

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> Posts { get; set; }

    }

    public class Post

    {

        public int PostId { get; set; }

        public string Title { get; set; }

        public string Content { get; set; }

    }

Foreign Key ¶

You can use the Fluent API to configure which property should be used as the foreign key property for a given relationship.

    class MyContext : DbContext

    {

        public DbSet<Blog> Blogs { get; set; }

        public DbSet<Post> Posts { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<Post>()

                .HasOne(p => p.Blog)

                .WithMany(b => b.Posts)

                .HasForeignKey(p => p.BlogForeignKey);

        }

    }

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> Posts { get; set; }

    }

    public class Post

    {

        public int PostId { get; set; }

        public string Title { get; set; }

        public string Content { get; set; }

        public int BlogForeignKey { get; set; }

        public Blog Blog { get; set; }

    }

The following code listing shows how to configure a composite foreign key.

    class MyContext : DbContext

    {

        public DbSet<Car> Cars { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<Car>()

                .HasKey(c => new { c.State, c.LicensePlate });

            modelBuilder.Entity<RecordOfSale>()

                .HasOne(s => s.Car)

                .WithMany(c => c.SaleHistory)

                .HasForeignKey(s => new { s.CarState, s.CarLicensePlate });

        }

    }

    public class Car

    {

        public string State { get; set; }

        public string LicensePlate { get; set; }

        public string Make { get; set; }

        public string Model { get; set; }

        public List<RecordOfSale> SaleHistory { get; set; }

    }

    public class RecordOfSale

    {

        public int RecordOfSaleId { get; set; }

        public DateTime DateSold { get; set; }

        public decimal Price { get; set; }

        public string CarState { get; set; }

        public string CarLicensePlate { get; set; }

        public Car Car { get; set; }

    }

Principal Key ¶

If you want the foreign key to reference a property other than the primary key, you can use the Fluent API to configure the principal key property for the relationship. The property that you configure as the principal key will automatically be setup as an alternate key (see Alternate Keys for more information).

    class MyContext : DbContext

    {

        public DbSet<Car> Cars { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<RecordOfSale>()

                .HasOne(s => s.Car)

                .WithMany(c => c.SaleHistory)

                .HasForeignKey(s => s.CarLicensePlate)

                .HasPrincipalKey(c => c.LicensePlate);

        }

    }

    public class Car

    {

        public int CarId { get; set; }

        public string LicensePlate { get; set; }

        public string Make { get; set; }

        public string Model { get; set; }

        public List<RecordOfSale> SaleHistory { get; set; }

    }

    public class RecordOfSale

    {

        public int RecordOfSaleId { get; set; }

        public DateTime DateSold { get; set; }

        public decimal Price { get; set; }

        public string CarLicensePlate { get; set; }

        public Car Car { get; set; }

    }

The following code listing shows how to configure a composite principal key.

    class MyContext : DbContext

    {

        public DbSet<Car> Cars { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<RecordOfSale>()

                .HasOne(s => s.Car)

                .WithMany(c => c.SaleHistory)

                .HasForeignKey(s => new { s.CarState, s.CarLicensePlate })

                .HasPrincipalKey(c => new { c.State, c.LicensePlate });

        }

    }

    public class Car

    {

        public int CarId { get; set; }

        public string State { get; set; }

        public string LicensePlate { get; set; }

        public string Make { get; set; }

        public string Model { get; set; }

        public List<RecordOfSale> SaleHistory { get; set; }

    }

    public class RecordOfSale

    {

        public int RecordOfSaleId { get; set; }

        public DateTime DateSold { get; set; }

        public decimal Price { get; set; }

        public string CarState { get; set; }

        public string CarLicensePlate { get; set; }

        public Car Car { get; set; }

    }

Caution

The order that you specify principal key properties must match the order they are specified for the foreign key.

Required ¶

You can use the Fluent API to configure whether the relationship is required or optional. Ultimately this controls whether the foreign key property is required or optional. This is most useful when you are using a shadow state foreign key. If you have a foreign key property in your entity class then the requiredness of the relationship is determined based on whether the foreign key property is required or optional (see Required/optional properties for more information).

    class MyContext : DbContext

    {

        public DbSet<Blog> Blogs { get; set; }

        public DbSet<Post> Posts { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<Post>()

                .HasOne(p => p.Blog)

                .WithMany(b => b.Posts)

                .IsRequired();

        }

    }

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> 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; }

    }

Cascade Delete ¶

You can use the Fluent API to configure the cascade delete behavior for a given relationship.

There are three behaviors that control how a delete operation is applied to dependent entities in a relationship when the principal is deleted or the relationship is severed.

Cascade: Dependent entities are also deleted.
SetNull: The foreign key properties in dependent entities are set to null.
Restrict: The delete operation is not applied to dependent entities. The dependent entities remain unchanged.

Note

    class MyContext : DbContext

    {

        public DbSet<Blog> Blogs { get; set; }

        public DbSet<Post> Posts { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<Post>()

                .HasOne(p => p.Blog)

                .WithMany(b => b.Posts)

                .OnDelete(DeleteBehavior.Cascade);

        }

    }

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public List<Post> Posts { get; set; }

    }

    public class Post

    {

        public int PostId { get; set; }

        public string Title { get; set; }

        public string Content { get; set; }

        public int? BlogId { get; set; }

        public Blog Blog { get; set; }

    }

Other Relationship Patterns ¶

One-to-one ¶

One to one relationships have a reference navigation property on both sides. They follow the same conventions as one-to-many relationships, but a unique index is introduced on the foreign key property to ensure only one dependent is related to each principal.

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public BlogImage BlogImage { get; set; }

    }

    public class BlogImage

    {

        public int BlogImageId { get; set; }

        public byte[] Image { get; set; }

        public string Caption { get; set; }

        public int BlogId { get; set; }

        public Blog Blog { get; set; }

    }

Note

EF will choose one of the entities to be the dependent based on its ability to detect a foreign key property. If the wrong entity is chosen as the dependent you can use the Fluent API to correct this.

When configuring the relationship with the Fluent API, you use the HasOne and WithOne methods.

When configuring the foreign key you need to specify the dependent entity type - notice the generic parameter provided to HasForeignKey in the listing below. In a one-to-many relationship it is clear that the entity with the reference navigation is the dependent and the one with the collection is the principal. But this is not so in a one-to-one relationship - hence the need to explicitly define it.

    class MyContext : DbContext

    {

        public DbSet<Blog> Blogs { get; set; }

        public DbSet<BlogImage> BlogImages { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<Blog>()

                .HasOne(p => p.BlogImage)

                .WithOne(i => i.Blog)

                .HasForeignKey<BlogImage>(b => b.BlogForeignKey);

        }

    }

    public class Blog

    {

        public int BlogId { get; set; }

        public string Url { get; set; }

        public BlogImage BlogImage { get; set; }

    }

    public class BlogImage

    {

        public int BlogImageId { get; set; }

        public byte[] Image { get; set; }

        public string Caption { get; set; }

        public int BlogForeignKey { get; set; }

        public Blog Blog { get; set; }

    }

Many-to-many ¶

Many-to-many relationships without an entity class to represent the join table are not yet supported. However, you can represent a many-to-many relationship by including an entity class for the join table and mapping two separate one-to-many relationships.

    class MyContext : DbContext

    {

        public DbSet<Post> Posts { get; set; }

        public DbSet<Tag> Tags { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<PostTag>()

                .HasKey(t => new { t.PostId, t.TagId });

            modelBuilder.Entity<PostTag>()

                .HasOne(pt => pt.Post)

                .WithMany(p => p.PostTags)

                .HasForeignKey(pt => pt.PostId);

            modelBuilder.Entity<PostTag>()

                .HasOne(pt => pt.Tag)

                .WithMany(t => t.PostTags)

                .HasForeignKey(pt => pt.TagId);

        }

    }

    public class Post

    {

        public int PostId { get; set; }

        public string Title { get; set; }

        public string Content { get; set; }

        public List<PostTag> PostTags { get; set; }

    }

    public class Tag

    {

        public string TagId { get; set; }

        public List<PostTag> PostTags { get; set; }

    }

    public class PostTag

    {

        public int PostId { get; set; }

        public Post Post { get; set; }

        public string TagId { get; set; }

        public Tag Tag { get; set; }

    }

原文链接

相关文章