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

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

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

   それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

   アクセストークンによる接続

   アクセストークン経由の接続には、以下の2つのステップが必要です。

   1. Shopify の管理画面でアクセストークンを作成
   2. アクセストークンを使用して認証

   アクセストークンの作成

   まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。

   1. 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
   2. Develop apps をクリックしてCreate an app を選択します
   3. Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
   4. Save をクリックします
   5. Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです：
      • unauthenticated_read_content
   6. Save をクリックします
   7. API Credentials を選択します
   8. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
   9. Admin API Access token のアクセストークンをコピーします。注意：トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください

   アクセストークンによる認証

   続いて、アクセストークンで認証するには、以下のプロパティを設定してください。

   • AuthScheme：AccessToken に設定
   • AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定

   OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

   
   <configuration>
      ... <connectionStrings>
       <add name="ShopifyContext" connectionString="Offline=False;AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;" providerName="System.Data.CData.Shopify" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Shopify" type="System.Data.CData.Shopify.ShopifyProviderServices, System.Data.CData.Shopify.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Shopify.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はShopifyContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class ShopifyContext :DbContext {
   	public ShopifyContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<ShopifyContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているShopify のエンティティ、例えばCustomers にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class Customers {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String FirstName { get; set; }
   }
   public class CustomersMap :EntityTypeConfiguration<Customers> {
   	public CustomersMap() {
   		this.ToTable("Customers");
   		this.HasKey(Customers => Customers.Id);
   		this.Property(Customers => Customers.FirstName);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<Customers> Customers { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   ShopifyContext context = new ShopifyContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Customers select line;