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

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

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

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

   FreshBooks はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。

   詳細はヘルプドキュメントの「はじめに」を参照してください。

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