今すぐお試しください!

製品の詳細CData ADO.NET Provider for Smaregi を確認して、無償評価版をダウンロード:

今すぐダウンロード

Entity Framework 6 からSmaregi データに連携

この記事は、Entity Framework のcode-first アプローチを使って、Smaregi に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。



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

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

    スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。

    • スマレジにログイン後、[設定]->[システム連携]->[スマレジAPI 設定]に移動します。
    • [API受信設定]セクションにある[受信機能を利用する]を[利用する]に変更し、[アクセストークンの生成]をクリックし、AccessToken を取得します。
    • 次に必要なAPI アクセスを有効にするため、[機能設定]セクションで必要な機能を[利用する]に変更します。

    ContractId: アカウントの契約ID。これは受信設定セクションでも確認できます。
    AccessToken: 受信設定セクションのアクセストークン。

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