Entity Framework4.1 Code First なエンティティをWCF Data Services で公開するとエラー

おそらく近いうちに解決されるであろう、今だけ旬(?)なネタ。

まずはおさらいから。

ADO.NET Entity Framework 4.1 "Code First"

先日正式リリースとなった ADO.NET Entity Framework 4.1。

これは Microsoft が提供する、データベースアクセスに用いる .NET Framework のライブラリ。
なかでもこのバージョン 4.1 のウリは、"Code First" と呼ばれる実装技法が使えるようになったこと。

すなわち、

1. データベースのテーブルに保存する要素を表現する、素(す)のクラスを書く。
2. 次に、Entity Framework が提供する DbContext クラスから派生した独自のコンテキストクラスを書く。
3. この独自のコンテキストクラスのプロパティとして、同じく Entity Framework が提供する DbSet<T> 型のプロパティを、型引数を上述の "素のクラス" に指定して追記する。
4. こうしておくと、この独自コンテキストクラスのオブジェクトを使ってデータベースアクセスする処理を実行すると、上述の "素のクラス" に対応するテーブルがデータベースもろとも自動で生成されて動き出す。

というものである。

データベースを先に用意しなくていいのだ。

C#プログラムであれば、C#のコードだけ書くだけで、データベースのお膳立てが Entity Framework によって行われるのだ。

目的や用途にもよるので、なんにでも Code First 式の実装をお勧めはしかねる。
しかしこの軽いノリは、とくに立ち上げが急がれる小さめの Web サービスプロジェクトや、プロトタイピングなどではメリットも大きい。

入門には、正式リリース前の内容だが ScottGu のブログの翻訳記事や、「まめしば雑記」の「ASP.NET MVC3 開発入門」から「モデルをコードファーストで作成」などが参考になる。


WCF Data Services

かつては、ADO.NET Data Services というテクノロジであったと記憶しているが、昔話はさておき。

これは、LINQ to SQL のデータコンテキストや Entity Framework のエンティティセットを、簡単に OData 形式で HTTP プロトコル上に公開できてしまうフレームワークである。

OData とはつまるところ、しかるべき書式に則った XML 形式で HTTP 上に公開されるデータで、これに REST 形式な Web アクセスで取得/追加/変更/削除ができる、という仕掛けだ。

OData によってインターネット上に公開されているデータ（サイト）はこちらの "Live OData Services" などが参考になる。

で、その OData を .NET アプリで公開するためのフレームワークとしてあるのが WCF Data Services。

以下の手順で、あっという間に、LINQ to SQL や Entity Framework を使って実装したデータを OData 形式で公開できるようになるのだ。

1. Visual Studio 2010 で C# による Web アプリを開発していたとする。
2. その Web アプリプロジェクトでは、すでに Entity Framework によるデータアクセスのコードを実装済みであるとする（コンテキストクラスの名前を MyDB としよう）。
3. アイテムの新規追加ダイアログを開く。すると、追加するアイテムのなかに「WCF Data Service」というものがある。
4. これをそのWebアプリプロジェクトに追加（例えば MyData.svc としよう）。
5. こうしてプロジェクトに追加された C# ソースコード MyData.svc.cs を開くと、すでにひな形が出来上がっている。
6. このひな形をコメントに従って以下のとおりに書き換え。

public class MyData : DataService<MyDB>{

...

config.SetEntitySetAccessRule("*", EntitySetRights.AllRead);

以上で、「http://localhost:1234/MyData.svc」にアクセスすると、もう早速、OData 形式で、MyDB が公開されるのだ。



で、なにが問題?

かように非常に便利で強力な WCF Data Services と、そのデータの供給源である Entity Framework との組み合わせである。

しかし、なんと、

先に述べた Entity Framework の最新バージョン、4.1 の Code First 形式で実装したデータコンテキストを、WCF Data Services で OData 公開しようとすると、エラーになってしまった

のだ。

あんまりよく調査せずに、いきなり他力本願で Twitter 上でつぶやいてみた。

すると、なんと大変ありがたいことに、早速助けの手をさしのべて下さった人たちがいた（こちらとこちら）。

まずひとつめは、実装したデータコンテキストにさらに手を加えること（CreateDataSource メソッドをオーバーライドして回避コードを実装する）で対応できるとのこと。

出典はこちら。

「無聊を託つ」
http://takepara.blogspot.com/2011/03/blog-post.html

もうひとつは、WCF Data Service の、公式リリース前である CTP 版がすでにこの問題に対応済みなのでそれを利用する、という方法。

Microsoft Download Center - Microsoft WCF Data Services March 2011 CTP 2 for .NET Framework 4 and Silverlight 4
http://www.microsoft.com/downloads/en/details.aspx?FamilyID=60fb0117-8cea-4359-b392-6b04cdc821be

まだ CTP 版、すなわち Comunity Technology Preview 版ということで、あくまでも開発コミュニティに対する、技術の先行公開であり、正式リリースではないため普通には使えないと思う。
が、今後の対応の事前実証や早期評価、実験的に使うにはいいだろう。

また、このように WCF Data Services の改築も着々と進んでいるということは、上記 CTP 版もいずれ正式リリースされるのであろうことから、時間が経てば自然と解決する問題と言えそうだ。
（そういう意味で、このブログエントリは、いずれ古いものとなるはず。）

ちなみに、上記 WCF Data Services Mar.2011 CTP2 版を使って解決するには次の手順。

1. まずは上記リンクを頼りに、WCF Data Services Mar.2011 CTP2 版のインストーラを入手の上、インストール。
2. WCF Data Services を使っている Web アプリのプロジェクトにおいて、System.Data.Services と System.Data.Services.Client の二つのアセンブリの参照設定を削除。
3. 代わりに、上記でインストールした CTP 版のアセンブリが C:\Program Files\WCF Data Services Mar 2011 CTP2\bin\.NETFramework フォルダに格納されているので、この中から Microsoft.Data.Services.dll と Microsoft.Data.Services.Client.dll を参照設定に追加。

以上で、プロジェクトを再ビルドして実行すると、無事、Entity Framework 4.1 Code First なデータコンテキストを OData で公開できるようになる。