各製品の資料を入手。
詳細はこちら →
Entity Framework 6 からOData のデータに連携
この記事は、Entity Framework のcode-first アプローチを使って、OData に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。
最終更新日：2022-04-04
この記事で実現できるOData 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでOData にアクセスします。
- Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
- Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
- プロジェクトのApp.config ファイルを修正して、OData Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。
OData への接続
OData に接続するには、Url を有効なOData サービスルートURI に設定する必要があります。 OData サービスにルートドキュメントがない場合、テーブルとして公開したい特定のエンティティをFeedURL に指定してください。
OData への認証
OData は、以下を経由する認証をサポートします。
- HTTP
- Kerberos
- SharePoint Online
- OAuth
- Azure AD
HTTP 認証スキーム
HTTP で認証する場合は、次の表に従ってAuthScheme を設定します。
Scheme AuthScheme その他の設定 None None 認証を必要としない場合に使用。 Basic Basic User、Password NTLM NTLM User、Password Digest（サポートされている場合） Digest User、Password その他の認証方法の詳細は、ヘルプドキュメントの「接続の確立」セクションを参照してください。
<configuration> ... <connectionStrings> <add name="ODataContext" connectionString="Offline=False;URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;" providerName="System.Data.CData.OData" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.OData" type="System.Data.CData.OData.ODataProviderServices, System.Data.CData.OData.Entities.EF6" /> </providers> <entityFramework> </configuration> </code> - インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.OData.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
- この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
- プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はODataContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
- PluralizingTableNameConvention をModelBuilder Conventions から削除。
- MigrationHistory テーブルへのリクエストを削除。
using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class ODataContext :DbContext { public ODataContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<ODataContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } } - もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているOData のエンティティ、例えばOrders にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。
using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Orders { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String OrderName { get; set; } } public class OrdersMap :EntityTypeConfiguration<Orders> { public OrdersMap() { this.ToTable("Orders"); this.HasKey(Orders => Orders.Id); this.Property(Orders => Orders.OrderName); } } - エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：
public DbSet<Orders> Orders { set; get; } - コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：
ODataContext context = new ODataContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Orders select line;
関連コンテンツ
