Entity Framework 6 からau PAY Market データに連携

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでau PAY Market にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、au PAY Market Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   au PAY マーケットに接続するには、ShopId およびApiKey が必要です。

   au PAY マーケットへのアクセスの設定

   ShopId およびApiKey を取得するには、以下の手順に従ってください。

   • Wow! manager サイトにログインして、「各種お申し込み」メニューの「API利用申請」に移動します。
   • API利用規約に同意します。
   • 「APIキーの発行はこちら」をクリックします。
   • 「発行」ボタンをクリックして、API キーを生成します。
   • 「接続元IPアドレスを登録」に、対象とするIP アドレスを入力します。
   • 「登録」ボタンをクリックして、設定を保存します。

   au PAY マーケットアカウントの認証

   次の接続プロパティを設定して接続します。

   • ShopId：接続先のau PAY マーケットShop ID を設定。
   • ApiKey：API キーを設定。au PAY マーケットストアアカウントから取得したAPI キーです。
   • UseSandbox：Sandbox 環境に接続する場合はTrue を設定。
   <configuration> ... <connectionStrings> <add name="auPAYMarketContext" connectionString="Offline=False;ApiKey=MyApiKey;ShopId=MyShopId" providerName="System.Data.CData.auPAYMarket" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.auPAYMarket" type="System.Data.CData.auPAYMarket.auPAYMarketProviderServices, System.Data.CData.auPAYMarket.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.auPAYMarket.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はauPAYMarketContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class auPAYMarketContext :DbContext { public auPAYMarketContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<auPAYMarketContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているau PAY Market のエンティティ、例えばItems にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Items { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String ItemCode { get; set; } } public class ItemsMap :EntityTypeConfiguration<Items> { public ItemsMap() { this.ToTable("Items"); this.HasKey(Items => Items.Id); this.Property(Items => Items.ItemCode); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Items> Items { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： auPAYMarketContext context = new auPAYMarketContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Items select line;