Entity Framework 6 からAuthorize.Net のデータに連携

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

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

   Merchant アカウントにログインして、「Security Settings」->「General Settings」ページから必要な接続値を取得できます。

   • UseSandbox：トランザクション処理に使われるAuthorizeNet のAPI。プロダクションアカウントを使用している場合、このプロパティを指定する必要はありません。開発アカウントを利用している場合には、このプロパティをTrue に設定します。
   • LoginID：ペイメントゲートウェイアカウントに紐づいているAPI ログインId。このプロパティは、利用者がウェブサイトトランザクションを送信する権限があるかを認証するために使われます。Merchant Interface にログインするときのログインId とは異なります。
   • TransactionKey：ペイメントゲートウェイアカウントに紐づいているトランザクションキー。このプロパティは、利用者がウェブサイトトランザクションを送信する権限があるかを認証するために使われます。

   
   <configuration>
      ... <connectionStrings>
       <add name="AuthorizeNetContext" connectionString="Offline=False;LoginId=MyLoginId;TransactionKey=MyTransactionKey;" providerName="System.Data.CData.AuthorizeNet" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.AuthorizeNet" type="System.Data.CData.AuthorizeNet.AuthorizeNetProviderServices, System.Data.CData.AuthorizeNet.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.AuthorizeNet.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAuthorizeNetContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class AuthorizeNetContext :DbContext {
   	public AuthorizeNetContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<AuthorizeNetContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているAuthorize.Net のエンティティ、例えばSettledBatchList にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class SettledBatchList {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String MarketType { get; set; }
   }
   public class SettledBatchListMap :EntityTypeConfiguration<SettledBatchList> {
   	public SettledBatchListMap() {
   		this.ToTable("SettledBatchList");
   		this.HasKey(SettledBatchList => SettledBatchList.Id);
   		this.Property(SettledBatchList => SettledBatchList.MarketType);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<SettledBatchList> SettledBatchList { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   AuthorizeNetContext context = new AuthorizeNetContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.SettledBatchList select line;