EF Core 2.0 の新機能

[アーティクル]
08/24/2023

.NET Standard 2.0

EF Core が .NET Standard 2.0 対応になりました。つまり、.NET Core 2.0、.NET Framework 4.6.1、および .NET Standard 2.0 を実装するその他のライブラリで使えるようになりました。サポート対象の詳細については、「Supported .NET Implementations」 (サポートされている .NET 実装) を参照してください。

モデリング

テーブル分割

2 つまたはそれ以上のエンティティ型を同じテーブルにマッピングできるようになりました。そこで主キー列が共有され、各行が 2 つまたはそれ以上のエンティティに対応します。

テーブル分割を利用するには、テーブルを共有するすべてのエンティティ型の間で依存リレーションシップ (外部キープロパティが主キーを形成する) を構成する必要があります。

modelBuilder.Entity<Product>()
    .HasOne(e => e.Details).WithOne(e => e.Product)
    .HasForeignKey<ProductDetails>(e => e.Id);
modelBuilder.Entity<Product>().ToTable("Products");
modelBuilder.Entity<ProductDetails>().ToTable("Products");

この機能の詳細については、テーブル分割に関するページを参照してください。

所有されている型

所有されているエンティティ型は、別の所有されているエンティティ型と同じ .NET 型を共有できます。ただし、.NET 型だけでは識別できないため、別のエンティティ型からそれへのナビゲーションが必要になります。定義となるナビゲーションを含むエンティティは所有者です。所有者に問い合わせるとき、所有されている型が既定で含まれます。

慣例によって、所有されている型に対してシャドウ主キーが作成され、テーブル分割を利用し、同じテーブルに所有者としてマッピングされます。それによって、所有されている型を EF6 の複合型の使用方法と同じように使用できます。

modelBuilder.Entity<Order>().OwnsOne(p => p.OrderDetails, cb =>
    {
        cb.OwnsOne(c => c.BillingAddress);
        cb.OwnsOne(c => c.ShippingAddress);
    });

public class Order
{
    public int Id { get; set; }
    public OrderDetails OrderDetails { get; set; }
}

public class OrderDetails
{
    public StreetAddress BillingAddress { get; set; }
    public StreetAddress ShippingAddress { get; set; }
}

public class StreetAddress
{
    public string Street { get; set; }
    public string City { get; set; }
}

この機能に関する詳細は、所有エンティティ型のセクションをご覧ください。

モデルレベルのクエリフィルター

EF Core 2.0 には、モデルレベルのクエリフィルターと呼んでいる新しい機能があります。この機能では、(通常 OnModelCreating の) メタデータモデルのエンティティ型で直接、LINQ クエリ述語 (通常 LINQ Where クエリ演算子に渡されるブール式) を定義できます。このようなフィルターは、このようなエンティティ型が関係するあらゆる LINQ クエリに自動的に適用されます。これには間接的に参照されるエンティティ型が含まれます。たとえば、Include を利用して参照されます。あるいは、ナビゲーションプロパティが直接参照されます。この機能の一般的な用途は次のようになっています。

論理削除 - エンティティ型が IsDeleted プロパティを定義します。
マルチテナント - エンティティ型が TenantId プロパティを定義します。

次の単純なサンプルでは、上記の 2 つのシナリオに対してこの機能が使われています。

public class BloggingContext : DbContext
{
    public DbSet<Blog> Blogs { get; set; }
    public DbSet<Post> Posts { get; set; }

    public int TenantId { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<Post>().HasQueryFilter(
            p => !p.IsDeleted
            && p.TenantId == this.TenantId);
    }
}

エンティティ型 Post のインスタンスに対してマルチテナントと論理削除を実行するモデルレベルフィルターを定義します。 DbContext インスタンスレベルプロパティ TenantId の使用に注目してください。モデルレベルフィルターは、正しいコンテキストインスタンス (つまり、クエリを実行しているコンテキストインスタンス) の値を使用します。

フィルターは、IgnoreQueryFilters() 演算子を利用し、個々の LINQ クエリに対して無効にできます。

制限事項

ナビゲーション参照は許可されていません。この機能はフィードバックに応じて追加される可能性があります。
フィルターは、階層のエンティティ型ルートでのみ定義できます。

データベーススカラー関数マッピング

EF Core 2.0 には、Paul Middleton の重要な貢献が不可欠でした。それは、データベーススカラー関数のメソッドスタブへのマッピングを可能にするものです。マッピングにより、LINQ クエリで使用したり、SQL に変換したりすることができます。

この機能の使用方法を簡単に説明すると次のようになります。

DbContext で静的メソッドを宣言し、それに DbFunctionAttribute で注釈を付けます。

public class BloggingContext : DbContext
{
    [DbFunction]
    public static int PostReadCount(int blogId)
    {
        throw new NotImplementedException();
    }
}

このようなメソッドが自動的に登録されます。登録されると、LINQ クエリでのメソッドへの呼び出しが SQL での関数呼び出しに変換されます。

var query =
    from p in context.Posts
    where BloggingContext.PostReadCount(p.Id) > 5
    select p;

注意すべき点:

規則では、SQL の生成時、関数 (この場合はユーザー定義関数) の名前としてメソッドの名前が使用されますが、メソッド登録時に名前とスキーマをオーバーライドできます。
現在のところ、スカラー関数のみがサポートされています。
データベースにマップされた関数を作成する必要があります。 EF Core の移行では作成が行われません。

Code First の自己完結型構成

EF6 では、EntityTypeConfiguration から派生することで、特定のエンティティ型の Code First 構成をカプセル化できました。 EF Core 2.0 では、このパターンが復活します。

class CustomerConfiguration : IEntityTypeConfiguration<Customer>
{
    public void Configure(EntityTypeBuilder<Customer> builder)
    {
        builder.HasKey(c => c.AlternateKey);
        builder.Property(c => c.Name).HasMaxLength(200);
    }
}

...
// OnModelCreating
builder.ApplyConfiguration(new CustomerConfiguration());

高パフォーマンス

DbContext プール

ASP.NET Core アプリケーションで EF Core を使用する基本パターンは通常、カスタム DbContext 型を依存関係挿入システムに登録し、その後、コントローラーのコンストラクターパラメーターからその型のインスタンスを取得するというパターンになります。つまり、DbContext の新しいインスタンスが要求ごとに作成されます。

バージョン 2.0 では、依存関係挿入でカスタム DbContext 型を登録する新しい方法を導入しました。再利用可能な DbContext インスタンスのプールが透過的に導入されます。 DbContext プールを使用するには、サービス登録で AddDbContext の代わりに AddDbContextPool を使用します。

services.AddDbContextPool<BloggingContext>(
    options => options.UseSqlServer(connectionString));

この方法を利用する場合、コントローラーが DbContext インスタンスを要求した時点で、プールに利用できるインスタンスがないか最初に確認されます。要求処理が終わると、インスタンス上のあらゆる状態がリセットされ、インスタンス自体はプールに戻ります。

これは概念としては、DbContext プロバイダーの接続プールと似ており、DbContext インスタンスの初期化コストが一部節約されるという長所があります。

制限事項

この新しい方法では、DbContext の OnConfiguring() メソッドでできることにいくつかの制限があります。

警告

派生した DbContext クラス (要求間で共有できない) で独自の状態を維持する場合 (プライベートフィールドなど)、DbContext プールを使用しないでください。 EF Core は、DbContext インスタンスをプールに追加する前に認識した状態のみをリセットします。

明示的にコンパイルされたクエリ

これは 2 つ目のオプトインパフォーマンス機能であり、大規模なシナリオで利点が得られるように設計されています。

以前のバージョンの EF や LINQ to SQL では、手動または明示的にコンパイルされたクエリ API を利用できました。アプリケーションでは、1 回だけ計算し、何回も実行できるよう、クエリの変換をキャッシュできました。

一般的に、EF Core は、ハッシュ後のクエリ式に基づいてクエリを自動的にコンパイルし、キャッシュできますが、このメカニズムを利用し、ハッシュとキャッシュ参照の計算をバイパスすることでパフォーマンスを少し上げることができます。アプリケーションは、デリゲートを呼び出すことで、コンパイル済みのクエリを利用できます。

// Create an explicitly compiled query
private static Func<CustomerContext, int, Customer> _customerById =
    EF.CompileQuery((CustomerContext db, int id) =>
        db.Customers
            .Include(c => c.Address)
            .Single(c => c.Id == id));

// Use the compiled query by invoking it
using (var db = new CustomerContext())
{
   var customer = _customerById(db, 147);
}

変更の追跡

Attach で新規および既存のエンティティのグラフを追跡可能

EF Core では、さまざまメカニズムを利用し、キー値を自動生成できます。この機能を使用するとき、キープロパティが CLR 既定の場合 (通常はゼロか null)、値が生成されます。つまり、エンティティのグラフを DbContext.Attach または DbSet.Attach に渡すことができます。EF Core は、既にキーが設定されているエンティティを Unchanged としてマークします。キーが設定されていないエンティティは Added としてマークされます。それにより、生成されたキーを使用するとき、新規と既存の混合エンティティのグラフを簡単に添付できるようになります。 DbContext.Update と DbSet.Update は同じように動作しますが、キーが設定されているエンティティは Unchanged ではなく Modified としてマークされます。

クエリ

強化された LINQ 変換

より多くのクエリを正常に実行できるようになりました。(メモリではなく) データベースで評価されるロジックが増え、データベースから取得できないデータが減りました。

GroupJoin の改善

これにより、グループ結合に対して生成される SQL が改善されます。グループ結合は、大抵の場合、オプションのナビゲーションプロパティでのサブクエリの結果です。

FromSql と ExecuteSqlCommand の文字列補間

C# 6 では文字列補間が導入されました。この機能では、C# 式を文字列リテラルに直接埋め込むことができます。実行時、文字列が効率的に構築されます。 EF Core 2.0 では、RAW SQL 文字列を受け取る 2 つのプライマリ API、FromSql と ExecuteSqlCommand に、補間文字列の特殊なサポートを追加しました。この新しいサポートにより、"安全な" 方法で C# 文字列補間を使用できます。すなわち、実行時に SQL を動的に構築するときに起こりうる SQL 挿入のよくある間違いを防ぎます。

次に例を示します。

var city = "London";
var contactTitle = "Sales Representative";

using (var context = CreateContext())
{
    context.Set<Customer>()
        .FromSql($@"
            SELECT *
            FROM ""Customers""
            WHERE ""City"" = {city} AND
                ""ContactTitle"" = {contactTitle}")
            .ToArray();
  }

この例では、2 つの変数が SQL 形式文字列に埋め込まれています。 EF Core が次の SQL を生成します。

@p0='London' (Size = 4000)
@p1='Sales Representative' (Size = 4000)

SELECT *
FROM ""Customers""
WHERE ""City"" = @p0
    AND ""ContactTitle"" = @p1

EF.Functions.Like()

EF Core またはプロバイダーが利用できる EF.Functions プロパティを追加しました。このプロパティは、LINQ クエリで呼び出せるようにデータベースの関数や演算子にマッピングされるメソッドを定義します。このようなメソッドの最初の例が Like() です。

var aCustomers =
    from c in context.Customers
    where EF.Functions.Like(c.Name, "a%")
    select c;

Like() にはインメモリ実装が付随することに注目してください。インメモリデータベースに対して作業するときやクライアント側で述語を評価する必要があるときに便利です。

データベースの管理

DbContext スキャフォールディングの複数形化フック

EF Core 2.0 では、新しい IPluralizer サービスが導入されました。エンティティ型の名前を単数形化し、DbSet の名前を複数形化するために利用されます。既定の実装は no-op (操作なし) です。独自のプルーラライザー (複数形にするもの) を簡単にプラグインできるフックに過ぎません。

開発者が独自のプルーラライザーをフックインすると次のようになります。

public class MyDesignTimeServices : IDesignTimeServices
{
    public void ConfigureDesignTimeServices(IServiceCollection services)
    {
        services.AddSingleton<IPluralizer, MyPluralizer>();
    }
}

public class MyPluralizer : IPluralizer
{
    public string Pluralize(string name)
    {
        return Inflector.Inflector.Pluralize(name) ?? name;
    }

    public string Singularize(string name)
    {
        return Inflector.Inflector.Singularize(name) ?? name;
    }
}

その他

ADO.NET SQLite プロバイダーを SQLitePCL.raw に移動

これにより、Microsoft.Data.Sqlite で、さまざまプラットフォームでネイティブ SQLite バイナリを配信するためのソリューションがより堅牢になります。

モデルごとにプロバイダーは 1 つ

プロバイダーがモデルと対話するしくみが大幅に増強され、規則、注釈、fluent API がさまざまプロバイダーと連動するしくみが単純になりました。

EF Core 2.0 は、使用されるプロバイダーごとに異なる IModel をビルドするようになりました。これは通常、アプリケーションに対して透過的です。下位レベルのメタデータ API が単純になり、一般的なリレーショナルメタデータコンセプトへのあらゆるアクセスが .SqlServer や .Sqlite などではなく、.Relational の呼び出しで常に行われます。

統合されたログと診断

ログ記録 (ILogger に基づく) メカニズムと診断 (DiagnosticSource に基づく) メカニズムで共有されるコードが増えました。

ILogger に送信されるメッセージのイベント ID が 2.0 で変更されました。イベント ID が EF Core コード全体で一意になりました。これらのメッセージはまた、たとえば MVC で使用される構造化されたログ記録の標準パターンに従います。

ロガーカテゴリも変更されました。現在、DbLoggerCategory 経由でアクセスされる既知のカテゴリセットがあります。

DiagnosticSource イベントでは、それに対応する ILogger メッセージと同じイベント ID 名が使用されるようになりました。

EF Core 2.0 の新機能

.NET Standard 2.0

モデリング

テーブル分割

所有されている型

モデルレベルのクエリ フィルター

制限事項

データベース スカラー関数マッピング

Code First の自己完結型構成

高パフォーマンス

DbContext プール

制限事項

明示的にコンパイルされたクエリ

変更の追跡

Attach で新規および既存のエンティティのグラフを追跡可能

クエリ

強化された LINQ 変換

GroupJoin の改善

FromSql と ExecuteSqlCommand の文字列補間

EF.Functions.Like()

データベースの管理

DbContext スキャフォールディングの複数形化フック

その他

ADO.NET SQLite プロバイダーを SQLitePCL.raw に移動

モデルごとにプロバイダーは 1 つ

統合されたログと診断

フィードバック

その他のリソース

モデルレベルのクエリフィルター

データベーススカラー関数マッピング