既存の ASP.NET Webフォームアプリに、ASP.NET MVC 2 を混在させる

諸事情により、まだ Visual Studio 2010 は利用できていない。
なので、Visual Studio 2008、すなわち、.NET 3.5 SP1 での話となるのだが、さて。

とある構築済みの ASP.NET Web フォームアプリ ( .NET3.5SP1ベース ) がある。
さらにこのWebアプリを増改築することになったのだが、その増改築部分は ASP.NET MVC2 で作り込むのが得策、という場面にでくわした。

「ASP.NET MVC はつまるところは ASP.NET」ということで、既存の ASP.NET Web フォームプロジェクトを改造し、ASP.NET MVC2 による実装を同じWebアプリ内に同居させることにした。

以下に改造の手順を記しておく。

が、その前に、リファレンス用に別途 ASP.NET MVC2 Web アプリプロジェクトを作成してディスクに保存しておくこと。

先にネタばらしてしまうが、ファイル比較ツールを使って（自分は WinMerge を好んで使ってる）、このリファレンス用 ASP.NET MVC2 プロジェクトと、既存の ASP.NET Web フォームプロジェクトとをファイル比較しながら加筆改訂していくのが妥当である。
以下の改造手順を読むと、ずいぶんとあちこちこまごま書き換えねばならず面倒に感じるが、ファイル比較ツールを使って作業を進めると、さほどでもない。


ということで、ではでは、まずは、プロジェクトファイルの改造から。

当該 ASP.NET Web アプリのプロジェクトファイル（自分の場合は C# ベースなので .csproj ) をテキストエディタで開き、 記述されているXML を手作業で少しばかり書き換える。

まずは、ルート要素 ( Project ) 直近の PropertyGroup 要素内を、下記青い字のとおり加筆。

<Project ...
　<PropertyGroup>
　　<ProjectTypeGuids>{F85E285D-A4E0-4152-9332-AB1D724D3325};{349c5851-65df-11da-9384-00065b846f21};{fae04ec0-301f-11d3-bf4b-00c04f79efbc}</ProjectTypeGuids>
　　...
　　<MvcBuildViews>false</MvcBuildViews>
　</PropertyGroup>

ProjectTypeGuids 要素になにやら GUID を書き加えたが、おそらくはこの効果で、ASP.NET MVC 特有の Visual Studio の追加機能（ソリューションエクスプローラでの ~/Controllers フォルダの右クリックで "Add Controllers..." メニューが現れたり、などなど）が出現するのだろう。

次。
プロジェクトファイル最後尾側の ProjectExtensions 要素の直前に、Target 要素 x 2つがコメントアウトされている。
そのうち、Name 属性が AfterBuild である要素をコメントアウトを外し、下記のとおり書き換える。

　<Target Name="AfterBuild" Condition="'$(MvcBuildViews)'=='true'">
　　<AspNetCompiler VirtualPath="temp" PhysicalPath="$(ProjectDir)" />
　</Target>


以上でいったん保存の上、テキストエディタは終了。
このプロジェクトファイルを Visual Studio で開く。

以下の二つのアセンブリを参照設定に追加。

System.Web.Mvc ( version は 2.0.0.0 を選ぶこと )
System.Web.Routing


次に、~/Web.config の編集。

/configuration/system.web/compilation/assemblies 要素内に、以下の3つの add 要素を書き加える。

<add assembly="System.Web.Abstractions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35"/>
<add assembly="System.Web.Routing, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35"/>
<add assembly="System.Web.Mvc, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35"/>

次は、/configuration/system.web/pages 要素内に以下のとおり namespaces 要素を追記。

<namespaces>
　<add namespace="System.Web.Mvc"/>
　<add namespace="System.Web.Mvc.Ajax"/>
　<add namespace="System.Web.Mvc.Html"/>
　<add namespace="System.Web.Routing"/>
　<add namespace="System.Linq"/>
　<add namespace="System.Collections.Generic"/>
</namespaces>

次は、/configuration/system.web の httpHandlers および httpModules の各要素内に以下の要領で add 要素を追加（青い字の箇所）。

<httpHandlers>
　<remove path="*.asmx" verb="*" />
　<add path="WebResource.axd" verb="GET" type="System.Web.Handlers.AssemblyResourceLoader" validate="true" />
　...
</httpHandlers>
<httpModules>
　...
　<add name="UrlRoutingModule" type="System.Web.Routing.UrlRoutingModule, System.Web.Routing, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35" />
</httpModules>

IIS7.xで動作させる場合は、system.WebServer 要素内の編集も行う。
下記要領で、UrlRoutingModule および UrlRoutingHandler を張り替えるよう加筆（青い字の箇所）。

­<system.webServer>
　...
　<modules>
　　...
　　<remove name="UrlRoutingModule" />
　　<add name="UrlRoutingModule" type="System.Web.Routing.UrlRoutingModule, System.Web.Routing, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35" />
　</modules>
　<handlers>
　　...
　　<remove name="UrlRoutingHandler" />
　　<add name="UrlRoutingHandler" preCondition="integratedMode" verb="*"
path="UrlRouting.axd" type="System.Web.HttpForbiddenHandler, System.Web, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
　</handlers>
</system.webServer>


次に /configuration/runtime/assemblyBinding 要素内の dependencyAssembly 要素群に、下記のとおりもう一要素を書き加える。

<dependentAssembly>
　<assemblyIdentity name="System.Web.Mvc" publicKeyToken="31bf3856ad364e35"/>
　<bindingRedirect oldVersion="1.0.0.0" newVersion="2.0.0.0"/>
</dependentAssembly>

今度は Global.asax の番。
もし Global.aspax がまだプロジェクトに追加されていなければ新規追加しておく。
Global.asax.cs 内にて以下の要領で、ASP.NET MVC では定番のルーティングの定義を書いておく。

protected override void OnApplictionStart()
{
　base.OnApplictionStart();
　AreaRegistration.RegisterAllAreas();
　RegisterRoutes(RouteTable.Routes);
}

public static void RegisterRoutes(RouteCollection routes)
{
　routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
　routes.MapRoute(
　　"Default", // Route name
　　"{controller}/{action}/{id}", // URL with parameters
　　new { controller = "Home", action = "Index", id = UrlParameter.Optional } // Parameter defaults
　　);
}

あとは ~/Controllers フォルダ、~/Views フォルダを作成。

~/Views フォルダの中に、別途リファレンス用に作り捨てておいた ASP.NET MVC2 Webアプリプロジェクトから ~/Views/Web.config をコピーしてきて、遂に完成だ。

~/Models フォルダ、~/Content フォルダはお好みで作成（まぁ、大概、~/Models フォルダは作るとは思うが）。

以上でとにもかくにも、ASP.NET Web フォームによる実装と、ASP.NET MVC 2 による実装とが同一 Web アプリに同居できるようになった。
ここから先は、追加したい機能・ページは、ASP.NET MVC2 ベースで追加していけばよい。
既存の Web フォーム部分もこれまでどおり動作し続ける。


...はずなのだが、実はまだまだ落とし穴があった。

その顛末はまた次回の投稿にて。