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

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

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

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

   CData 製品は、2つのPayPal API のテーブルを表示します。API は異なる認証方法を使用します。

   • REST API はOAuth 標準を使用します。REST API を認証するには、OAuthClientId、OAuthClientSecret、CallbackURL プロパティを設定する必要があります。
   • Classic API にはSignature API 認証情報が必要です。Classic API を認証するにはUsername、Password、およびSignature プロパティを設定する必要があります。

   必要なAPI 資格情報の取得については、ヘルプドキュメントの「はじめに」を参照してください。

   使用するAPI を選択するには、Schema プロパティをREST またはSOAP に設定します。デフォルトでは、SOAP スキーマが使われます。

   テスト目的では、UseSandbox をtrue に設定してSandbox 資格情報を使用できます。

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