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

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

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

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

   WordPress 接続プロパティの取得・設定方法

   現時点では、CData JDBC Driver for WordPress はセルフホスト型のWordPress インスタンスへの接続のみをサポートしています。データに接続するには、Url を自身のwordpress サイトに指定し、次に以下に説明するように認証を行います。

   URL を完全な形式で記入します。例えば、あなたのサイトが'http://localhost/wp/wordpress' でホストされている場合、URL は'http://localhost' ではなく、'http://localhost/wp/wordpress' となるべきです。 URL を完全な形式で入力しないと、'site not found' というエラーが発生します。

   WordPress は2種類の認証をサポートします。

   • Basic 認証は、テスト環境での使用が推奨されます。
   • OAuth 2.0 認証は、デスクトップアプリケーション、Web アプリケーション、またはヘッドレスマシンからのブラウザベースのアクセスをサポートします。

   Basic 認証

   Basic 認証を使用するようにWordPress を設定する前に：

   • WordPress ログインに管理者権限があることを確認してください。
   • ローカルホストで実行されているWordPress のバージョンを確認します。（WordPress 4.7 以降はネイティブでWordPress REST API サポートしていますが、それより前のバージョンでは、REST API へのアクセスを安全に行うには、Basic 認証プラグインの使用が必要です。）
   Basic 認証を構成するには：
   1. WordPress ホストにログインします。
   2. 4.7より前のバージョンのWordPress を実行している場合は、REST API プラグインをインストールしてください。
   3. Basic Authentication プラグインをインストールします。
   4. カスタムタクソノミーを作成するには、Simple Taxonomy Refreshed をインストールします。プラグインを手動でインストールしたい場合は、圧縮されたフォルダをwp-content\plugins フォルダに展開してからWordPress 管理者インターフェース経由でプラグインを有効にします。
   5. 次の接続プロパティを設定します。
      • AuthScheme：Basic。
      • Url：WordPress URL。
      • User：ユーザーネーム。
      • Password：パスワード。
   OAuth 2.0 認証についてはヘルプドキュメントを参照してください。
   <configuration> ... <connectionStrings> <add name="WordPressContext" connectionString="Offline=False;Url=http://www.yourwordpresshost.com;" providerName="System.Data.CData.WordPress" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.WordPress" type="System.Data.CData.WordPress.WordPressProviderServices, System.Data.CData.WordPress.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.WordPress.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はWordPressContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class WordPressContext :DbContext { public WordPressContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<WordPressContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているWordPress のエンティティ、例えばCategories にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Categories { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String Id { get; set; } } public class CategoriesMap :EntityTypeConfiguration<Categories> { public CategoriesMap() { this.ToTable("Categories"); this.HasKey(Categories => Categories.Id); this.Property(Categories => Categories.Id); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Categories> Categories { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： WordPressContext context = new WordPressContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Categories select line;