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

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

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

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

   Zoho Projects 接続プロパティの取得・設定方法

   Zoho Projects に接続するには、Region をサーバーURL のトップレベルドメイン（TLD）に設定します。

   Zoho Projects への認証

   Zoho Projects は、データに接続する2つの方法を提供します。

   • デスクトップ経由で自分のローカルデータに接続する場合（非ブラウザ接続）は、CData が提供する組み込みOAuth アプリケーションを使用します。
   • ネットワーク経由で共有データに接続する場合（ブラウザ接続）は、カスタムOAuth アプリケーションを使用します。

   すべてのOAuth フロー（埋め込みまたはカスタム）で、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

   ヘルプドキュメントでは、次の3つの一般的な認証フローでのZoho Projects への認証について詳しく説明します。

   • デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
   • Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
   • ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

   認証方法の詳細は、ヘルプドキュメントを参照してください。

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