Entity Framework 6 からKintone のデータに連携

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

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

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

   Kintone 接続プロパティの設定方法

   Kintone に接続するには、以下の接続プロパティを設定する必要があります。

   • URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
   • User：アカウントのユーザー名
   • Password：アカウントのパスワード
   • AuthScheme：Password を指定

   パスワード認証の代わりにAPI トークン認証を利用する場合は、ヘルプドキュメントの「接続の設定」セクションをご参照ください。

   Basic 認証の設定

   ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

   • BasicAuthUser：Basic認証のユーザー名
   • BasicAuthPassword：Basic認証のパスワード

   クライアント証明書認証の設定

   Basic認証の代わりにクライアント証明書による認証を利用する場合は、以下の項目を設定してください。

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