没有导航属性的EF Code First外键

Question

假设我有以下实体：

public class Parent
{
    public int Id { get; set; }
}
public class Child
{
    public int Id { get; set; }
    public int ParentId { get; set; }
}

什么是代码优先流式 API 语法来强制在数据库中创建 ParentId，并具有对 Parent 表的外键约束，不需要导航属性？

我知道如果我将导航属性 Parent 添加到 Child，那么我可以这样做：

modelBuilder.Entity<Child>()
    .HasRequired<Parent>(c => c.Parent)
    .WithMany()
    .HasForeignKey(c => c.ParentId);

但在这种特殊情况下，我不想要导航属性。

Answer 1

使用 EF Code First Fluent API 是不可能的。您始终需要至少一个导航属性才能在数据库中创建外键约束。

如果您使用 Code First 迁移，您可以选择在包管理器控制台 (add-migration SomeNewSchemaName) 上添加新的基于代码的迁移。如果您对模型或映射进行了更改，则会添加新的迁移。如果您没有更改任何内容，请使用 add-migration -IgnoreChanges SomeNewSchemaName 强制进行新迁移。在这种情况下，迁移将只包含空的 Up 和 Down 方法。

然后你可以修改Up方法，添加以下内容：

public override void Up()
{
    // other stuff...

    AddForeignKey("ChildTableName", "ParentId", "ParentTableName", "Id",
        cascadeDelete: true); // or false
    CreateIndex("ChildTableName", "ParentId"); // if you want an index
}

运行此迁移（包管理控制台上的update-database）将运行类似于此的 SQL 语句（对于 SQL Server）：

ALTER TABLE [ChildTableName] ADD CONSTRAINT [FK_SomeName]
FOREIGN KEY ([ParentId]) REFERENCES [ParentTableName] ([Id])

CREATE INDEX [IX_SomeName] ON [ChildTableName] ([ParentId])

或者，无需迁移，您可以使用运行纯 SQL 命令

context.Database.ExecuteSqlCommand(sql);

其中context 是派生上下文类的实例，sql 只是上述 SQL 命令字符串形式。

请注意，尽管如此，EF 并不知道ParentId 是描述关系的外键。 EF 只会将其视为普通的标量属性。不知何故，与仅仅打开SQL管理工具并手动添加约束相比，以上所有方法只是一种更复杂，更慢的方式。

Answer 2

对于那些想要使用 DataAnotations 并且不想公开导航属性的人的小提示 - 使用 protected

public class Parent
{
    public int Id { get; set; }
}
public class Child
{
    public int Id { get; set; }
    public int ParentId { get; set; }

    protected virtual Parent Parent { get; set; }
}

就是这样 - 将创建在 Add-Migration 之后带有 cascade:true 的外键。

Answer 3

虽然这篇文章是针对Entity Framework 而不是Entity Framework Core，但对于想要使用Entity Framework Core（我使用的是V1.1.2）实现相同目标的人来说可能会有用。

我不需要导航属性（尽管它们很好），因为我正在练习 DDD，我希望 Parent 和 Child 成为两个单独的聚合根。我希望他们能够通过外键而不是通过特定于基础架构的 Entity Framework 导航属性相互交谈。

您所要做的就是使用HasOne 和WithMany 在一侧配置关系，而不指定导航属性（毕竟它们不存在）。

public class AppDbContext : DbContext
{
    public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) {}

    protected override void OnModelCreating(ModelBuilder builder)
    {
        ......

        builder.Entity<Parent>(b => {
            b.HasKey(p => p.Id);
            b.ToTable("Parent");
        });

        builder.Entity<Child>(b => {
            b.HasKey(c => c.Id);
            b.Property(c => c.ParentId).IsRequired();

            // Without referencing navigation properties (they're not there anyway)
            b.HasOne<Parent>()    // <---
                .WithMany()       // <---
                .HasForeignKey(c => c.ParentId);

            // Just for comparison, with navigation properties defined,
            // (let's say you call it Parent in the Child class and Children
            // collection in Parent class), you might have to configure them 
            // like:
            // b.HasOne(c => c.Parent)
            //     .WithMany(p => p.Children)
            //     .HasForeignKey(c => c.ParentId);

            b.ToTable("Child");
        });

        ......
    }
}

我也给出了如何配置实体属性的示例，但这里最重要的是HasOne<>、WithMany() 和HasForeignKey()。

希望对你有帮助。

Answer 4

如果是 EF Core，您不一定需要提供导航属性。您可以简单地在关系的一侧提供外键。一个使用 Fluent API 的简单示例：

using Microsoft.EntityFrameworkCore;
using System.Collections.Generic;

namespace EFModeling.Configuring.FluentAPI.Samples.Relationships.NoNavigation
{
    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<Blog>()
                .WithMany()
                .HasForeignKey(p => p.BlogId);
        }
    }

    public class Blog
    {
         public int BlogId { get; set; }
         public string Url { 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; }
    }
}

Answer 5

我不使用导航属性的原因是类依赖。我将我的模型分成几个程序集，这些程序集可以在不同的项目中以任何组合使用或不使用。因此，如果我的实体具有从另一个程序集分类的导航属性，我需要引用该程序集，这是我想要避免的（或者任何使用该完整数据模型的一部分的项目都将携带所有内容）。

我有单独的迁移应用程序，用于迁移（我使用自动迁移）和初始数据库创建。该项目出于显而易见的原因引用了所有内容。

解决方案是 C 风格的：

• 通过链接将带有目标类的文件“复制”到迁移项目（在VS中使用alt键拖放）
• 通过#if _MIGRATION禁用导航属性（和FK属性）
• 在迁移应用程序中设置该预处理器定义，而不是在模型项目中设置，因此它不会引用任何内容（在示例中不要引用带有Contact 类的程序集）。

示例：

    public int? ContactId { get; set; }

#if _MIGRATION
    [ForeignKey(nameof(ContactId))]
    public Contact Contact { get; set; }
#endif

当然，您应该以同样的方式禁用using 指令并更改命名空间。

之后，所有消费者都可以像往常一样使用该属性 DB 字段（如果不需要，不要引用其他程序集），但 DB 服务器会知道它是 FK 并且可以使用级联。非常肮脏的解决方案。但有效。

Answer 6

我正在使用 .Net Core 3.1、EntityFramework 3.1.3。 我一直在寻找，我想出的解决方案是使用HasForeginKey<DependantEntityType>(e => e.ForeginKeyProperty) 的通用版本。 您可以像这样创建一对一的关系：

builder.entity<Parent>()
.HasOne<Child>()
.WithOne<>()
.HasForeginKey<Child>(c => c.ParentId);

builder.entity<Child>()
    .Property(c => c.ParentId).IsRequired();

希望这对如何使用HasForeginKey 方法有所帮助或至少提供一些其他想法。