ケーススタディから学ぶ実践的 ASP.NET MVC 勉強会用の資料

1. ASP.NETMVCのルーティング設定を
少しだけ REST っぽくする少しだけ REST っぽくする
Id:dany1468

2. Case
今回は、ASP.NETMVCでアプリケーションを作
る中で、ルーティング設定に悩んだ経験
から、特にREST的なルーティングを構築から、特にREST的なルーティングを構築
する必要があった場合の事をケースとし
ています。

3. ASP.NETMVCのルーティング設定の復習ASP.NETMVCのルーティング設定の復習

4. routes.MapRoute(
"Default",
"{controller}/{action}/{id}",
DefaultDefinition
"{controller}/{action}/{id}",
new { controller = "Home",
action = "Index",
id = UrlParameter.Optional } );

5. Action HTTP Method URL
Index GET /books
Create GET /books/create
DefaultControllerMapping(BooksController)
Create GET /books/create
Create POST /books/create
Details GET /books/details/1
Edit GET /books/edit/1
Edit POST /books/edit/1
Delete POST /books/delete/1

6. public class BooksController : Controller
{
public ActionResult Index() { }
public ActionResult Details(int id) { }
public ActionResult Create() { }
[HttpPost]
DefaultController(BooksController)
[HttpPost]
public ActionResult Create(FormCollection collection) { }
public ActionResult Edit(int id) { }
[HttpPost]
public ActionResult Edit(int id, FormCollection collection) { }
public ActionResult Delete(int id) { }
[HttpPost]
public ActionResult Delete(int id, FormCollection collection) { }
}

7. Sample(BooksController)
@Html.ActionLink("Create Link", "Create", "Books")
@Html.ActionLink(“Create Link”, “Create”)// no controller
<a href="@Url.Action("Create", "Books")">link</a>
@using (Html.BeginForm("Create", "Books")) { }@using (Html.BeginForm("Create", "Books")) { }
<a href="/Books/Create">Create Link</a>
<a href="/books/Create">Create Link</a>
<a href="/Books/Create">link</a>
<form action="/Books/Create" method="post">/* */</form>

8. OtherNameDefinition
routes.MapRoute(
"OtherName",
"book_other/{action}/{id}","book_other/{action}/{id}",
new {controller = "Books", // fixed controller
action = "Index",
Id = UrlParameter.Optional});

9. Sample
@Html.ActionLink("Create Link", "Create", "Books")
@Html.ActionLink(“Create Link”, “Create”)// no controller
<a href="@Url.Action("Create", "Books")">link</a>
@using (Html.BeginForm("Create", "Books")) { }
NoChangeNoChange@using (Html.BeginForm("Create", "Books")) { }
<a href="/book_other/Create">Create Link</a>
<a href="/book_other/Create">Create Link</a>
<a href="/book_other/Create">link</a>
<form action="/book_other/Create" method="post"></form>
NoChangeNoChange
GET /book_other (or /books *default)

10. NestedController
(BookShelfController&BooksController)
routes.MapRoute(
"InBookShelf",
"bookshelves/{shelfId}/books/{action}/{id}","bookshelves/{shelfId}/books/{action}/{id}",
new {controller = "Books",
action = "Index",
Id = UrlParameter.Optional});
booksの部分が{controller} のプレースホルダでも同じ

11. Sample.01
@Html.ActionLink("Create Link", "Create", "Books")
@Html.ActionLink(“Create Link”, “Create”)// no controller
<a href="@Url.Action("Create", "Books")">link</a>
@using (Html.BeginForm("Create", "Books")) { }
NoChangeNoChange
<a href="/bookshelves/1234/books/Create">Create Link</a>
<a href="/bookshelves/1234/books/Create">Create Link</a>
<a href="/bookshelves/1234/books/Create">link</a>
<form action="/bookshelves/1234/books/Create"
method="post"></form>
GET /bookshelves/1234/books

12. Sample.02:useroutename
@Html.RouteLink("Create Link", "InBookShelf",
new { action = "Create" })
<a href="@Url.RouteUrl("InBookShelf",
new { action = "Create" })">link</a>
@using (Html.BeginRouteForm("InBookShelf",
<a href="/bookshelves/1234/books/Create">Create Link</a>
<a href="/bookshelves/1234/books/Create">link</a>
<form action="/bookshelves/1234/books/Create"
method="post"></form>
GET /bookshelves/1234/books
@using (Html.BeginRouteForm("InBookShelf",
new { action = "Create" })) { }

13. まとめ
• デフォルトはControllerとの規約で解決
• 独自のルーティングを作っても View 側で
は Controller に対する直接指定でOK。は Controller に対する直接指定でOK。
• ネストされたような Controller の構成でも、
View 側 (or デフォルト) で Controller が指
定できていれば、その Controller に対する
リクエストとして解釈してくれる。

14. REST
(RepresentationalStateTransfer)(RepresentationalStateTransfer)

15. 最近はASP.NETMVCの開発に関わらず、意識す
る事が多くなって来ました。
ASP.NETMVC4WebAPIはRESTが意識されたURLの作
りになっていますよね。
ASP.NETMVC4WebAPIはRESTが意識されたURLの作
りになっていますよね。
中でも・・・

16. RailsスタイルのRESTが比較的よく言及さ
れる印象があります。
ASP.NETMVCとRailsではどのようにルーティ
ングが違うのでしょうか？
(ASP.NETMVC4WebAPIはここでは扱わない)

17. Rails&ASP.NETMVC RoutingApproach
Action
HTTP
Method
URL
Index GET /books
Create GET /books/create
Action
HTTP
Method
URL
Index GET /books
New GET /books/new
ASP.NETMVC Rails
Create GET /books/create
Create POST /books/create
Details GET /books/details/1
Edit GET /books/edit/1
Edit POST /books/edit/1
Delete POST /books/delete/1
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1

18. Rails&ASP.NETMVC RoutingApproach
Action
HTTP
Method
URL
Index GET /books
Create GET /books/create
Action
HTTP
Method
URL
Index GET /books
New GET /books/new
ASP.NETMVC Rails
Create GET /books/create
Create POST /books/create
Details GET /books/details/1
Edit GET /books/edit/1
Edit POST /books/edit/1
Delete POST /books/delete/1
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
特にeditの部分が異なるが、それ以外にも全体として、
ASP.NETMVCはURLに動詞が入る形で構成される

19. Railsが完全にRESTだという
訳ではないと思いますが、
Railsスタイルは割りと上手くいっ
ているイメージ。
•URLがデフォルトでも違和感があまり
無い
•リソースをベースにルーティング設定
も考えられていて自然に使える

20. 復習の部分で見た通り、ASP.NET
MVCのRoutingも柔軟なのでRailsスMVCのRoutingも柔軟なのでRailsス
タイルを実現する事も可能です。

21. ASP.NETMVCでRailsスタイルのRoutingを書くASP.NETMVCでRailsスタイルのRoutingを書く

22. GoalイメージはRailsスタイル
Action
HTTP
Method
URL
Index GET /books
New GET /books/new
(Rails)
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
PUT,DELETEに関しては、HttpMethodOverrideで対応します。
Idに関しては数字限定という体で定義します。

23. public class BooksController : Controller
{
public ActionResult Index() { }
public ActionResult New() { }
public ActionResult Show(int id) { }
[HttpPost]
RailsStyleController(BooksController)
[HttpPost]
public ActionResult Create(FormCollection collection) { }
public ActionResult Edit(int id) { }
[HttpPut]
public ActionResult Update(int id, FormCollection collection) { }
public ActionResult Delete(int id) { }
[HttpDelete]
public ActionResult Destory(int id, FormCollection collection) { }
}

24. Action
HTTP
Method
URL
Index GET /books
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
@Html.ActionLink(“Link",
"Index", "Books")
<a href="/Books">Link</a>
routes.MapRoute(
"index",
"{controller}",
new { action = "index" },
new { httpMethod = new HttpMethodConstraint("GET") });

25. Action
HTTP
Method
URL
Index GET /books
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
@Html.ActionLink(“Link",
"New", "Books")
<a href="/Books/new">Link</a>
routes.MapRoute(
"new",
"{controller}/new",
new { action = "new" },
new { httpMethod = new HttpMethodConstraint("GET") });

26. Action
HTTP
Method
URL
Index GET /books
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
@using (Html.BeginForm("Create",
“Books”, FormMethod.Post)) { }
<form action="/Books"
method="post"></form>
routes.MapRoute(
"create",
"{controller}",
new { action = "create" },
new { httpMethod = new HttpMethodConstraint("POST") });

27. Action
HTTP
Method
URL
Index GET /books
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
@Html.ActionLink(“Link",
"Show", "Books“,
new { Id = 1234 })
<a href="/Books/1234">Link</a>
routes.MapRoute(
“show",
"{controller}/{id}",
new { action = “show" },
new { id = @“¥d+“,
httpMethod = new HttpMethodConstraint("GET") });

28. Action
HTTP
Method
URL
Index GET /books
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
@Html.ActionLink(“Link",
"Edit", "Books“,
new { Id = 1234 })
<a href="/Books/1234/Edit">
Link</a>
routes.MapRoute(
“edit_delete",
"{controller}/{id}/{action}",
new { action = “edit|delete” }, // delete フォームも同じ
new { id = @“¥d+“,
httpMethod = new HttpMethodConstraint("GET") });

29. Action
HTTP
Method
URL
Index GET /books
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
@using (Html.BeginForm("Update",
“Books”, new { Id = 1234 },
FormMethod.Post)) {
@Html.HttpMethodOverride(HttpVerbs.Put
)
}
<form action="/Books/1234/Update"
method="post">
<input name="X-HTTP-Method-Override"
type="hidden" value="PUT">
routes.MapRoute(
"update",
"{controller}/{id}",
new { action = "update" },
new { id = @“¥d+“,
httpMethod = new HttpMethodConstraint("PUT") });
type="hidden" value="PUT">
</form>

30. Action
HTTP
Method
URL
Index GET /books
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
@using (Html.BeginForm("Destroy",
“Books”, new { Id = 1234 },
FormMethod.Post)) {
@Html.HttpMethodOverride(HttpVerbs.Del
ete)
}
<form action="/Books/1234/Destroy"
method="post">
<input name="X-HTTP-Method-Override"
type="hidden" value=“DELETE">
routes.MapRoute(
"destory",
"{controller}/{id}",
new { action = "destroy" },
new { id = @“¥d+“,
httpMethod = new HttpMethodConstraint("DELETE")});
type="hidden" value=“DELETE">
</form>

31. Defaultの定義から考えるとルー
ティングの設定は相当数増えま
したが、素直にRailsスタイルにしたが、素直にRailsスタイルに
近づける事ができました。

32. ただし、これをさらにネストした
リソースや、少し特別なルーティ
ングを定義するだけで、同じよう
なルーティング設定を書き続けな
ければなりません。ければなりません。
そもそも、Railsではこんな大変では
ないはずです。

33. Railsにおけるルーティング指定方法
resoucesの機能を一部抜粋resoucesの機能を一部抜粋
http://railsdoc.com/routes

34. resources sample.01
resources :books
Action HTTP Method URL
これだけで、以下のURLを全て生成
Index GET /books
New GET /books/new
Create POST /books
Show GET /books/1
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1

35. resources sample.02
Action HTTP Method URL
Index GET /books
resources :books, :only => [:index]
リソースの指定はするが、アクションを限定する
resources :books, :except => [:index, :show]
Action HTTP Method URL
New GET /books/new
Create POST /books
Edit GET /books/1/edit
Update PUT /books/1
Destroy DELETE /books/1
リソースの指定はするが、アクションを一部除外する

36. resources sample.03
resources :books, :path => "/otherbooks"
Action HTTP Method URL
Index GET /otherbooks
ControllerはbooksだがURLを置き換える
Index GET /otherbooks
New GET /otherbooks/new
Create POST /otherbooks
Show GET /otherbooks/1
Edit GET /otherbooks/1/edit
Update PUT /otherbooks/1
Destroy DELETE /otherbooks/1

37. resources sample.04
ネストされたリソースを表現する
resources :bookshelves do
resources :books
end
Action HTTP Method URL
Index GET /bookshelves/:shelf_id/books
New GET /bookshelves/:shelf_id/books/new
Create POST /bookshelves/:shelf_id/books
Show GET /bookshelves/:shelf_id/books/:id
Edit GET /bookshelves/:shelf_id/books/:id/edit
Update PUT /bookshelves/:shelf_id/books/:id
Destroy DELETE /bookshelves/:shelf_id/books/:id
ネストされたリソースを表現する

38. resourcesのDSLを見るだけでも、かな
り簡単に指定ができる事が分かる。
Rails4でmatchが無くなったが、match
はASP.NETMVCの標準のルート設定に
近いもの。近いもの。
Railsはワイルドカード的にルーティ
ングがマッチしてしまう事を避け
ようとしているようである。

39. resourcesのようなDSLがある事で、ワ
イルドカードを使わなくても簡単
に指定できるようにし、開発者にに指定できるようにし、開発者に
明示的にルーティングを指定する
事を推進しようとしているのだろ
う。

40. ASP.NETMVCでも同じ事ができないか？ASP.NETMVCでも同じ事ができないか？

41. RestfulRoutingRestfulRouting

42. RestfulRoutingRestfulRouting
http://www.restfulrouting.com/

43. RestfulRouting
•RestfulRoutingforASP.NETMVC,basedontheRubyonRailsrouting
DSL.
•RailsのルーティングDSLにインスパイアされ
たプロジェクトらしいたプロジェクトらしい
•元々ASP.NETMVCはRailsのmatchに似た設定記法で
あったし(どちらが先かは知りません)、機能も近
いものがあった。
•それに加えてresouce,resources関連のDSLがサポー
トされている模様。(まだまだ絶賛開発中のようで
すが。)

44. QuickStart
http://www.restfulrouting.com/quickstart
1. Nugetでインストール
2. Routes.csが作成されるので、そこにルート定義
PM> Install-Package RestfulRouting
2. Routes.csが作成されるので、そこにルート定義
を追加していく
3. ViewEngineをRestfulRouting用に差し替える。Area
を使う場合だけでも良い。(RazorViewEngine の継
承なので差し替えても問題無い)
4. これで後は書き進めるだけ。

45. Railsのresourcesのサンプルに合わせて、
RestfulRoutingのResourcesを紹介。RestfulRoutingのResourcesを紹介。

46. resources sample.01
resources :books
Rails
RestfulRouting
map.Resources<BooksController>();
RestfulRouting

47. resources sample.02
resources :books, :only => [:index]
map.Resources<BooksController>(books => books.Only(“index”));
Rails
RestfulRouting
resources :books, :except => [:index, :show]
map.Resources<BooksController>(books => books.Only(“index”));
map.Resources<BooksController>(books => books.Except("index",
"show"));
Rails
RestfulRouting

48. resources sample.03
resources :books, :path => "/otherbooks"
Rails
RestfulRouting
map.Resources<BooksController>(
books => books.As("otherbooks"));
RestfulRouting

49. resources sample.04
resources :bookshelves do
resources :books
end
Rails
map.Resources<BookShelvesController>(
bookshelves => bookshelves.Resources<BooksController>()
);
RestfulRouting

50. RestfulRoutingまとめ
• RestfulRoutingを使えば、Railsスタイルのルーティン
グが簡単に書ける。
• Controllerとの対応関係も明確になるので、ルー
ティング設定が分かりやすくなるかも。ティング設定が分かりやすくなるかも。
•RestfulRoutingは、実装的にはRouteCollectionへの設
定のDSLでしかない。RouteHandlerやMvcHandler,
ControllerFactory等のフレームワークのパイプライン
に手を入れている訳ではないので、問題が出た
際も対応しやすい。ソースコードも大きくない。

51. ASP.NETMVCのルーティング設定を
少しだけ REST っぽくする少しだけ REST っぽくする
Id:dany1468