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

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

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

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

   Asana への接続は以下のように行います。

   • WorkspaceId: Asana Wrokspace のglobally unique identifier (gid) を設定すると指定されたWorkspace のプロジェクトだけを返します。Workspace Id はhttps://app.asana.com/api/1.0/workspaces から取得します。表示されるJSON にWorkspace name およびId が含まれます。
   • ProjectId: Asana Project のglobally unique identifier (gid) に設定すると指定されたProject のデータだけを返します。Project ID はプロジェクトのOverview ページのURL を参照してください。/0/ の後ろの数字 です。

   OAuth 認証

   Asana への認証にはOAuth 認証が使われます。OAuth はAsana のブラウザで認証ユーザーを認証する処理が必要です。OAuth の詳細については、ヘルプドキュメントの「はじめに」を参照してください。

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