Entity Framework 6 からMicrosoft Planner データに連携

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

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

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

   ユーザー資格情報の接続プロパティを設定せずに接続できます。接続に最小限必要な接続プロパティは、以下のとおりです。

   • InitiateOAuth: GETANDREFRESH に設定。
   • Tenant (optional): デフォルトと異なるテナントに認証したい場合は、これを設定します。これは、デフォルトのテナントに所属していない組織と連携するために必要です。

   接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、CData 製品にアクセス許可を与えます。CData 製品がOAuth プロセスを完了します。

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