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

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

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

   Microsoft Exchange への接続

   Exchange への接続には2つのスキーマがあります。

   • Microsoft Graph
   • Exchange Web Services（EWS）（非推奨）
     Note：Microsoft は、Exchange Online ユーザーに対してMicrosoft Graph への切り替えを推奨しています。

   Microsoft Graph とEWS を切り替えるには、Schema をMSGraph またはEWS（非推奨）に設定します。

   Microsoft Exchange OnPremises への認証

   Microsoft Exchange OnPremises は、Basic（デフォルト）、Digest、Negotiate、NTLM 認証をサポートします。

   Basic（デフォルト）

   Microsoft Exchange OnPremises では、Basic がデフォルトの認証として設定されます。 Basic 認証を使用するには、以下のプロパティを設定します。
   • AuthScheme：Basic。
   • User：ユーザーのログインID。
   • Password：ユーザーのログインパスワード。

   他の認証方法については、ヘルプドキュメントの「はじめに」を参照してください。

   Microsoft Exchange Online への認証

   Microsoft Exchange Online は、複数のOAuth ベースの認証をサポートしています。 Microsoft Graph を介してExchange Online に接続する場合は、Schema をMSGraph に設定します。

   認証方法の詳細は、ヘルプドキュメントの「はじめに」を参照してください。

   
   <configuration>
      ... <connectionStrings>
       <add name="ExchangeContext" connectionString="Offline=False;User='myUser@mydomain.onmicrosoft.com';Password='myPassword';Server='https://outlook.office365.com/EWS/Exchange.asmx';Platform='Exchange_Online';" providerName="System.Data.CData.Exchange" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Exchange" type="System.Data.CData.Exchange.ExchangeProviderServices, System.Data.CData.Exchange.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているMicrosoft Exchange のエンティティ、例えば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 GivenName { get; set; }
   }
   public class ContactsMap :EntityTypeConfiguration<Contacts> {
   	public ContactsMap() {
   		this.ToTable("Contacts");
   		this.HasKey(Contacts => Contacts.Id);
   		this.Property(Contacts => Contacts.GivenName);
   	}
   }
   

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

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

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

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