Entity Framework 6 からCoinbase のデータに連携
Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでCoinbase にアクセスします。
- Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
- Visual Studio の [パッケージ マネージャー コンソール]から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
- プロジェクトのApp.config ファイルを修正して、Coinbase Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。
まず、Profile 接続プロパティをディスク上のCoinbase プロファイルの場所に設定します(例:C:\profiles\Coinbase.apip)。次に、ProfileSettings 接続プロパティをCoinbase の接続文字列に設定します(以下を参照)。
Coinbase API プロファイル設定
Coinbase はOAuth ベースの認証を使用します。
まず、Coinbase でOAuth アプリを登録する必要があります。これはアカウントの「Settings」>「API Access」>「New OAuth2 Application」から行えます。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されたClientID に設定します。
- OAuthClientSecret:アプリ設定で指定されたClientSecret に設定します。
- CallbackURL:アプリ設定で指定したRedirect URI に設定します。
<configuration> ... <connectionStrings> <add name="APIContext" connectionString="Offline=False;Profile=C:\profiles\Coinbase.apip;Authscheme=OAuth;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 ファイルを作成し、ファイル名を呼び出そうとしているCoinbase のエンティティ、例えばDeposits にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。
using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Deposits { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String Id { get; set; } } public class DepositsMap :EntityTypeConfiguration<Deposits> { public DepositsMap() { this.ToTable("Deposits"); this.HasKey(Deposits => Deposits.Id); this.Property(Deposits => Deposits.Id); } } - エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します:
public DbSet<Deposits> Deposits { set; get; } - コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例:
APIContext context = new APIContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Deposits select line;