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

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

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

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

   SurveyMonkey はOAuth 2 認証標準を利用しています。SurveyMonkey がアンケートの回答を読むためにこれを必要とすることを考えると、アンケートを読むアカウントには有料プランのサブスクリプションが必要です。

   SurveyMonkey への接続に使用できる認証方法は2つあります。

   • プライベートoauth アプリケーションを登録するときに、パーソナルアクセストークンを使用します。
   • パブリックoauth アプリケーションを登録するときに、OAuth を使用します。

   パーソナルアクセストークンの使用

   個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得するには、ヘルプの「Creating a Custom OAuth App」の手順に従って、次の接続プロパティを設定します。

   • OAuthAccessToken：アプリケーション設定で生成されたAccessToken に設定。
   • InitiateOAuth：OFF に設定。

   OAuth の使用

   CData 製品はすでにSurveyMonkey にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的に埋め込みクレデンシャルを使用して接続します。

   独自のカスタムOAuth アプリを使用したい場合は、ヘルプのCustom Credentials を参照してください。

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