Code First Fluent APIを使用した関係の説明

ASP.NET MVC 4のマニュアルをより詳細に理解しようとすると、Fluent API、Code First、アノテーションなどの概念に出会いました。 Fluent APIに関する情報はあまりありませんでした。 特にロシア語で。 見ます。



Entity FrameworkのCode Firstアプローチでは、独自のドメインクラスを使用して、EFがクエリの作成、変更の追跡、および更新に使用するモデルを表すことができます。 Code Firstは、構成規則と呼ばれるプログラミングパターンを使用します。 これは、クラスがEFが概念モデルに使用するスキーマの規則に従うことをCode Firstが信じていることを意味します。 この場合、EFは必要な部分を使用してその機能を実行できます。 ただし、クラスが規則を正しく使用しない場合は、EFがそれらを正しく理解できるように、必要な構成を手動で追加できます。



Code Firsアプローチを使用すると、これらの構成を2つの方法で定義できます。 1つは、DataAnnotationsと呼ばれる単純な属性を使用することです。 2番目の方法は、Fluent APIを使用することです。これにより、構成をコードで命令的に記述できます。



この記事では、Fluent APIを使用したカスタマイズに焦点を当てています。 Code Firsの規則は、子孫または個々のクラスを指すプロパティに基づいてクラス間の関係を記述するのに非常に役立ちます。 クラスに外部キーがない場合、Code Firsはそれらを自分で作成できます。 ただし、クラスの説明では関係に関する十分な情報が提供されない場合があるため、Code Firsはすべてを正しく理解し、「欠落」部分を正しく追加できます。

モデルを考える

まず、BlogとPostの2つの単純なクラスから始めましょう。BlogはPostと1対多の関係にあります。

public class Blog { public int Id { get; set; } public string Title { get; set; } public string BloggerName { get; set; } public virtual ICollection<Post> Posts { get; set; } } public class Post { public int Id { get; set; } public string Title { get; set; } public DateTime DateCreated { get; set; } public string Content { get; set; } public int BlogId { get; set; } public Blog Blog { get; set; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

1対多の関係の規則を理解する

クラスで1対多の関係を定義する一般的な方法の1つは、1つのクラスの子コレクションと外部キーを、子クラスのナビゲーションプロパティと共に作成することです。 上記の例では、BlogにはPostsプロパティがあります。これは、Post型のICollectionのコレクションです。 そして、Postには外部キーBlogIDがあります。これはBlogナビゲーションプロパティとも呼ばれ、Blogの祖先を指します。



このデータは、Code Firstが規則に基づいてデータベースに次のテーブルを作成するのに十分です。







Code FirstによってBlogIdフィールドが外部キーになり（Posts.BlogIdの主キー/外部キーとBlogs.Idの制限が決定されます）、null不可であることに注意してください。 Code Firstは、クラスで説明されている規則に基づいてこれらの結論を引き出しました。

外部キープロパティが指定されていない場合にHasRequiredを使用する

PostクラスでBlogIdプロパティを設定せず、Blogナビゲーションプロパティを設定するとどうなりますか。 Code Firstは、BlogプロパティがBlogエンティティを指すことを知っているため、必要な関係を作成します。 彼は、図2に示すように、Posts.Blog_Id外部キーを作成し、Blog.Idに関連付けます。







ただし、重要な詳細が1つあります。 Blog_IdはNULL可能です。 その後、ブログに関連しない投稿を追加することが可能になります。 だからコードファーストは、クラスの慣習を研究して、それを理解しましたが、これは開発者が求めていたものではありません。 Fluent APIを使用して、その不正確さを修正します。



Fluent API構成は、クラスからモデルを構築するときにCode Firstで使用されます。 以下に示すように、DbContextクラスのOnModelCreatingメソッドをオーバーライドすることにより、構成を埋め込むことができます。

 public class BlogContext : DbContext { public DbSet<Blog> Blogs { get; set; } public DbSet<Post> Posts { get; set; } protected override void OnModelCreating(DbModelBuilder modelBuilder) { //configure model with fluent API }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

DbModelBuilderを使用すると、設定を傍受することができます。 エンティティの1つを変更することをモデルビルダーに通知します。 このために、ジェネリックを使用し、Postの本質を変更します。 アクセスすると、関係の一部であるHasRequiredメソッドを使用して、ナビゲーションプロパティ（この場合はBlogプロパティ）が必要であることを示すことが可能になります。

 modelBuilder.Entity<Post>().HasRequired(p => p.Blog);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

結果は二重の効果です。 1つ目は、Blog_Idフィールドが再びnullにならないことです。 また、EFはオンデマンドで、またはデータベースに保存する前に検証を実行するため、指定されたすべての条件が満たされていることを確認できます。

カスタム外部キー名のカスタマイズ

外部キーを指定した場合でも、その名前はCode Firstの規則と常に一致するとは限りません。 慣例により、キー名はクラスの名前または「classname_Id」または「classnameId」と一致する必要があります。 そのため、Code Firstは元のクラスプロパティであるBlogIdで適切に動作できました。



しかし、名前が慣例に従っていない場合はどうなりますか？ たとえば、「FK」+ parent_class_name +「Id」です。

 public int FKBlogId { get; set; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Code Firstは、FKBlogIdが外部キーとして機能する必要があることを知りません。 Blogプロパティをリンクするために必要であるため、FKBlogIdおよびBlog_Idの標準列を作成します。これは外部キーになります。







また、BlogとPostをさらに使用して、FKBlogIdは、ブログを指す外部キーとしてプログラムによって認識されることはありません。



Fluent APIを使用すると、この問題も解決できます。FKBlogIdをブログに関連する外部キーとして使用します。



設定時には、リレーションシップの両端を指定する必要があります。複数のリレーションシップを示すブログのプロパティ（投稿）と、親を指すポインティングプロパティ（ブログ）です。



まず、WithManyメソッドを追加する必要があります。これにより、複数の関係が含まれるBlogプロパティを指定できます。

 modelBuilder.Entity<Post>().HasRequired(p => p.Blog) .WithMany(b => b.Posts)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、HasForeignKeyメソッドを追加します。これは、どのPostプロパティが外部キーであり、ブログを指すかを示します。 完全なコード：

 modelBuilder.Entity<Post>().HasRequired(p => p.Blog) .WithMany(b => b.Posts) .HasForeignKey(p => p.FKBlogId);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

開発者が提案するデータベーススキーマと関係の正しい構築に必要なすべてのデータをCode Firstが収集できるようになりました。

スプレッドシートスキーマと多対多の関係の定義

必要に応じて、相互に指すプロパティを使用して多対多の関係を簡単に定義できます。 たとえば、投稿内のタグを追跡するためにモデルにTagクラスを追加する場合、それらの間に多対多の関係が必要になります。



新しいタグクラス：

 public class Tag { public int TagId{ get; set; } public string Name { get; set; } public ICollection<Post> Posts { get; set; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Postクラスに追加する新しいプロパティ：

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

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コードはまず、スパニングテーブルの名前が2つのクラスの名前の組み合わせで構成され、テーブルにクラス名とキー名の組み合わせで構成される名前の外部キーが含まれることを前提としています。 この場合、Post.IdおよびTag.TagIdを使用しています。 Codeに最初にミドルウェアテーブルを作成させると、次のようになります。







また、コードが最初に自分でデータベースを作成できるようにした場合、原則として問題は発生しません。 ただし、既存のデータベースにマッピングする場合は、テーブル、列の名前に問題がある可能性があります。 Fluent APIを使用して、テーブル名と列名を指定します。



3つの名前を指定する必要がある場合の例を考えてみましょう。 テーブル名はPostJoinTagでなければならず、列名はTagIdとPostIdでなければなりません。



エンティティマッピングメソッドから始めましょう。 最初の投稿またはタグの説明は重要ではありません。 転記を選択します。 関係の両端を示します。 前の例で1対多の関係が示されたように、HasManyメソッドとWithManyメソッドを使用して同じことを行います。 PostエンティティはTagsプロパティと複数の関係を持ち、TagエンティティはPostsプロパティと複数の関係を持つことを指摘します。

 modelBuilder.Entity<Post>() .HasMany(p => p.Tags) .WithMany(t => t.Posts) .Map(mc => { mc.ToTable("PostJoinTag"); mc.MapLeftKey("PostId"); mc.MapRightKey("TagId"); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

左右のマッピングキー（MapLeftKey、MapRightKey）を決定する際には注意が必要です。 左側は、あなたが指し示した最初のクラスのキー、つまりPostです。右側のキーは2番目のクラスです。 それらを交換すると、データは正しく保存されず、既知のマイナスの結果につながります。

結論

Code First fluent APIを使用して関係を記述する機能のいくつかに精通しました。 個別に、または組み合わせて使用​​できる他のマッピングがあります。 IsRequiredとHasRequiredまたはWithManyとHasManyなど、一部は冗長または混乱しているように見える場合があります。 ただし、各タスクが担当するタスクと、それらを使用する利点を確認しておく必要があります。



Entity Frameworkの詳細については、 MSDNまたはEntity Frameworkチームのブログをご覧ください 。