Entity Framework 6 からWooCommerce のデータに連携

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

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

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

   WooCommerce は、one-legged OAuth1.0 認証と通常のOAuth2.0 認証をサポートします。

   one-legged OAuth 1.0 認証を使って接続する

   次のプロパティを指定してください（NOTE：次の資格情報はWooCommerce の設定ページで生成されるもので、WordPress OAuth2.0 プラグインで生成されるものとは異なります）。

   • ConsumerKey
   • ConsumerSecret

   WordPress OAuth 2.0 認証を使って接続する

   プラグインを設定した後、 次の接続プロパティを指定することでWooCommerce に接続できます。

   • OAuthClientId
   • OAuthClientSecret
   • CallbackURL
   • InitiateOAuth - GETANDREFRESH または REFRESH のどちらかに設定してください

   どちらの場合方法でも、Url プロパティをWooCommerce インスタンスのURL に設定する必要があります。

   <configuration> ... <connectionStrings> <add name="WooCommerceContext" connectionString="Offline=False;Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; " providerName="System.Data.CData.WooCommerce" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.WooCommerce" type="System.Data.CData.WooCommerce.WooCommerceProviderServices, System.Data.CData.WooCommerce.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.WooCommerce.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はWooCommerceContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class WooCommerceContext :DbContext { public WooCommerceContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<WooCommerceContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているWooCommerce のエンティティ、例えば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 ParentId { get; set; } } public class OrdersMap :EntityTypeConfiguration<Orders> { public OrdersMap() { this.ToTable("Orders"); this.HasKey(Orders => Orders.Id); this.Property(Orders => Orders.ParentId); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Orders> Orders { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： WooCommerceContext context = new WooCommerceContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Orders select line;