Entity Framework 6 からPonparemall データに連携

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

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

   Ponparemall に接続するには、ShopUrl、InventoryUserId、InventoryPassword、OrderUserId、OrderPassword、PaymentUserId、およびPaymentPassword が必要です。

   Ponparemall へのアクセスの設定

   Ponparemall には各API のId とPassword が必要です。取得するには、以下の手順に従ってください。

   • Ponparemall Manager にログインし、メニューの「各種申請」の「WebAPI利用申請」をクリックします。
   • Web API メニューの「WebAPIサービス利用申請」をクリックし、利用申請を行います。
   • 後日、Ponparemall から必要なId とPassword が送られてきます。

   Ponparemall アカウントの認証

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

   • ShopUrl：接続先のPonparemall Shop URL を設定。「http://storetst4.ponparemall.com/sample/」に含まれる「sample」の部分を入力します。
   • InventoryUserId：「在庫API」のユーザID を設定。このプロパティは、Inventory テーブルにアクセスする場合に必要です。
   • InventoryPassword：「在庫API」のパスワードを設定。このプロパティは、Inventory テーブルにアクセスする場合に必要です。
   • OrderUserId：「受注API」のユーザID を設定。このプロパティは、Orders テーブルにアクセスする場合に必要です。
   • OrderPassword：「受注API」のパスワードを設定。このプロパティは、Orders テーブルにアクセスする場合に必要です。
   • PaymentUserId：「決済API」のユーザID を設定。このプロパティは、Payments テーブルにアクセスする場合に必要です。
   • PaymentPassword：「決済API」のパスワードを設定。このプロパティは、Payments テーブルにアクセスする場合に必要です。
   <configuration> ... <connectionStrings> <add name="PonparemallContext" connectionString="Offline=False;InventoryUserId=Inventory UserId;InventoryPassword=Invetory Password;" providerName="System.Data.CData.Ponparemall" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Ponparemall" type="System.Data.CData.Ponparemall.PonparemallProviderServices, System.Data.CData.Ponparemall.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Ponparemall.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はPonparemallContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class PonparemallContext :DbContext { public PonparemallContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<PonparemallContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているPonparemall のエンティティ、例えば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 OrderNumber { get; set; } } public class OrdersMap :EntityTypeConfiguration<Orders> { public OrdersMap() { this.ToTable("Orders"); this.HasKey(Orders => Orders.Id); this.Property(Orders => Orders.OrderNumber); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Orders> Orders { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： PonparemallContext context = new PonparemallContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Orders select line;