Entity Framework 6 からGoogle Cloud Storage データに連携

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

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

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

   ユーザーアカウントでの認証

   ユーザー資格情報の接続プロパティを設定することなく接続できます。InitiateOAuth をGETANDREFRESH に設定したら、接続の準備が完了です。

   接続すると、Google Cloud Storage OAuth エンドポイントがデフォルトブラウザで開きます。ログインして権限を付与すると、OAuth プロセスが完了します。

   サービスアカウントでの認証

   サービスアカウントには、ブラウザでユーザー認証を行わないサイレント認証があります。サービスアカウントを使用して、企業全体のアクセススコープを委任することもできます。

   このフローでは、OAuth アプリケーションを作成する必要があります。詳しくは、ヘルプドキュメントを参照してください。以下の接続プロパティを設定したら、接続の準備が完了です：

   • InitiateOAuth: GETANDREFRESH に設定。
   • OAuthJWTCertType: PFXFILE に設定。
   • OAuthJWTCert: 生成した.p12 ファイルへのパスに設定。
   • OAuthJWTCertPassword: .p12 ファイルのパスワードに設定。
   • OAuthJWTCertSubject: 証明書ストアの最初の証明書が選ばれるように"*" に設定。
   • OAuthJWTIssuer: 「サービスアカウント」セクションで「サービスアカウントの管理」をクリックし、このフィールドをサービスアカウントID フィールドに表示されているE メールアドレスに設定。
   • OAuthJWTSubject: サブジェクトタイプが"enterprise" に設定されている場合はエンタープライズID に設定し、"user" に設定されている場合はアプリユーザーID に設定。
   • ProjectId: 接続するプロジェクトのID に設定。

   これで、サービスアカウントのOAuth フローが完了します。

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