各製品の資料を入手。
詳細はこちら →
Entity Framework 6 からMisoca のデータに連携
この記事は、Entity Framework のcode-first アプローチを使って、Misoca に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。
最終更新日：2022-04-04
この記事で実現できるMisoca 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでMisoca にアクセスします。
- Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
- Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
- プロジェクトのApp.config ファイルを修正して、Misoca Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。
まず、OAuth アプリを作成する必要があります。 https://app.misoca.jp/oauth2/applications に移動し、「新しいアプリケーションを作成する」ボタンをクリックしてください。アプリケーション名を入力し、リダイレクトURL を指定して、「登録する」をクリックします。そうすると、クライアントシークレットとクライアントID が表示されます。
次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。
以下の接続プロパティを設定した後、接続の準備が整います。
- AuthScheme：OAuth に設定してください。
- OAuthClientID：アプリケーション設定で指定されたOAuth クライアントID に設定してください。
- OAuthClientSecret：アプリケーション設定で指定されたOAuth クライアントシークレットに設定してください。
- CallbackURL：アプリケーション設定で指定したリダイレクトURI に設定してください。
- InitiateOAuth：GETANDREFRESH に設定してください。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
<configuration> ... <connectionStrings> <add name="APIContext" connectionString="Offline=False;Profile=Misoca.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;" providerName="System.Data.CData.API" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.API" type="System.Data.CData.API.APIProviderServices, System.Data.CData.API.Entities.EF6" /> </providers> <entityFramework> </configuration> </code> - インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.API.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
- この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
- プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAPIContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
- PluralizingTableNameConvention をModelBuilder Conventions から削除。
- MigrationHistory テーブルへのリクエストを削除。
using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class APIContext :DbContext { public APIContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<APIContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } } - もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているMisoca のエンティティ、例えばContacts にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。
using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Contacts { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String RecipientName { get; set; } } public class ContactsMap :EntityTypeConfiguration<Contacts> { public ContactsMap() { this.ToTable("Contacts"); this.HasKey(Contacts => Contacts.Id); this.Property(Contacts => Contacts.RecipientName); } } - エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：
public DbSet<Contacts> Contacts { set; get; } - コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：
APIContext context = new APIContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Contacts select line;
関連コンテンツ
