Entity Framework 6 からZoho Books データに連携

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

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

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

   Zoho Books はOAuth 認証標準を使用します。OAuth を使用して認証するには、アプリを作成して OAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを設定してください。 認証方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

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