ASP.NET WebフォームとMVC2の同居 - サイトマップパス

前回の投稿にて、既存の ASP.NET Webフォームアプリプロジェクトに、ASP.NET MVC2 実装を追加し、サイトマップパス サーバーコントロールが使えるというところまで駒を進めた。

さてそのサイトマップパスコントロール。

ここでは、割と一般的に使われているであろうと想像する、既定の XmlSiteMapProvider を使った場合を前提に話を進める。

前回の投稿でも書いたとおり、XmlSiteMapProvider は、Request.RawUrl をキーに ~/Web.sitemap に記述された URL を探索しているだけである。
なので、特に凝ったことをしないのであれば、Webフォームに限らず ASP.NET MVC のビューページでも使えてしまう。

例えば、~/Web.sitemap に

<siteMapNode url="Book/Index" title="書籍一覧"/>

と設定しておけば、BooksController コントローラクラスの Index アクションメソッドの呼出、すなわち、http://host/Book/Index という URL にアクセスしたときに、サイトマップパスにはちゃんと「書籍一覧」と表示されるわけだ。

Webフォームであろうと MVC であろうと、単に 要求 URL に基づいて、"Book/Index" を Web.sitemap から探しているだけなのである。

しかし。

ここでこの書籍一覧ページから、各書籍の詳細ページへジャンプするとしよう。

URLは、例えば http://host/Book/Detail/1 となる。
最後の "/1" は書籍のIDと思って頂きたい。
すなわち、Detail アクションメソッドの引数 id に "1" が渡されるわけだ。

ではサイトマップパスに「書籍一覧 > 詳細」と表示されるようにするために、web.sitemap をどう書けばよいだろうか?

<siteMapNode url="Book/Index" title="書籍一覧">
　<siteMapNode url="Book/Detail" title="詳細"/>
</siteMapNode>

は不正解。

XmlSiteMapProvider は Web.sitemap から url="Book/Detail/1" の siteMapNode を探して、見つけられずに終わってしまうのだ。

XmlSiteMapProvider は 要求 URL のうち、どこが「パラメータ」「引数」なのかは、さすがにわからない。
Webフォーム世代のプロバイダなので、ルーティングテーブルを参照することなどないのだ。
せいぜいわかっているのは、クエリ文字列くらいである。

ということで、web.sitemap をどういじったところで、この問題は解決しない。

じゃぁどうするか?

ここでは、アクションに対するパラメータを、ルートテーブルで切り出すのをあきらめて、クエリ文字列で渡すようにした。
Global.asax.cs 中で、MVC 用のルーティングを追加しているが、これを次のように変更する。

routes.MapRoute(
　"Default", // Route name
　"{controller}/{action}", // URL with parameters
　new { controller = "Home", action = "Index" } // Parameter defaults

"/{id}" を消してしまったのがおわかり頂けるだろうか。

これで詳細ページの URL は http://host/Book/Detail?id=1 となる。
XmlSiteMapProvider も、クエリ文字列は切り離して web.sitemap を探索するので、siteMapNode url="Book/Detail" 要素を見つけることができ、無事、サイトマップパスに「書籍一覧 > 詳細」と表示されるようになった。

MVC 的にその解決策はどうなのか、って?

たしかにそのとおりではある。

まぁ、そこにこだわる場合は、サイトマッププロバイダを自作するという方法もある。
ルーティングテーブルの設定を参照しつつ、適切な siteMapNode を探索し返すわけだ。
XmlSiteMapProvider から派生して作れば、そんなに難しいことはないはずだ。

また、CodePlex にもなにか気になる名前のプロジェクトが存在しているので、もしかしたらこれが解になるかもしれない。
http://mvcsitemap.codeplex.com/
「既存の Web フォーム実装との同居」という要件を満たせるかどうかは微妙だが...。

今回の要件では、そこまでこだわる必要はないと判断し、とりあえずルーティングテーブルへの登録から "{id}" を省くことでよしとした。


これでサイトマップパスも安泰...と思いきや、まだサイトマップパスが破綻するシナリオが残されていた!

(続く)