生成されたコード
次に、実際に動作しているアプリケーションのコードを見ていきましょう。
画面の動作
まず、全体的な画面の動作は、ASP.NET Dynamic Dataおよびモデルバインドとモデル検証で行われています(リスト1)。
<%@ Page Title="LocationInsert" Language="C#" MasterPageFile="~/Site.Master" CodeBehind="Insert.aspx.cs" Inherits="MRRS_Scaffolding.LocationActions.Insert" %> <asp:Content runat="server" ID="Content1" ContentPlaceHolderID="HeadContent"> </asp:Content> <asp:Content runat="server" ID="Content2" ContentPlaceHolderID="MainContent"> <div> <h2>Insert Location</h2> <asp:ValidationSummary runat="server" CssClass="validation-summary-errors" /> <asp:FormView runat="server" ItemType="MRRS_Scaffolding.Models.Location" DefaultMode="Insert" InsertItemPosition="FirstItem" InsertMethod="InsertItem" OnItemCommand="ItemCommand" RenderOuterTable="false"> <InsertItemTemplate> <fieldset> <ol> <asp:DynamicEntity runat="server" Mode="Insert" /> </ol> <asp:Button runat="server" ID="InsertButton" CommandName="Insert" Text="Insert" /> <asp:Button runat="server" ID="CancelButton" CommandName="Cancel" Text="Cancel" CausesValidation="false" /> </fieldset> </InsertItemTemplate> </asp:FormView> </div> </asp:Content>
具体的には「DynamicEntity」コントロールによって、実行時にLocationクラスから表示、入力用のコントロール群が生成されています。従って、DynamicData\EntityTemplateフォルダーの各種テンプレートファイルを編集することで、その表示をカスタマイズできます(図3)。そのやり方については後述します。
ナビゲーション
Scaffoldingで生成されたリスト画面で選択したデータは、どのようにして編集画面などに渡されているのでしょうか? それを調べるために、まずはリスト画面を見てみましょう(リスト2)。
<asp:HyperLink runat="server" NavigateUrl='<%# FriendlyUrl.Href("~/Views/Location/Edit", Item.Id) %>' Text="edit" />
NavigateUrlプロパティに設定されたデータバインド式に「FriendlyUrl」という見慣れない型があります。これは「ASP.NET Friendly URLs」という新たなライブラリの型です。
「ASP.NET Friendly URLs」は、WebフォームアプリケーションのURLルーティングをサポートしてくれるライブラリです。従来は表1のようなURLルーティングをWebフォームアプリケーションで行おうとすると、Global.asaxファイル内などにRoutes.MapPageRouteメソッドを使って大量の設定を記述する必要がありました。しかも、URLルーティングが必要な画面全部について行わなければいけないため、メンテナンスも大変でした。
操作 | ルーティング元URL | ルーティング先URL |
---|---|---|
参照 | ~/Views/Location/Default | Views/Location/Default.aspx |
追加 | ~/Views/Location/Insert | Views/Location/Insert.aspx |
編集 | ~/Views/Location/Edit/{id} | Views/Locations_Edit.aspx?id={id} |
削除 | ~/Views/Location/Delete/{id} | Views/Location_Delete.aspx?id={id} |
Friendly URLsは「セグメント」という考えを使って、その設定をサポートしてくれます。
例を見てみましょう。リスト2で使用しているFriendlyUrl.Hrefメソッドは、第一引数で指定したURLに第二引数以降(可変長引数)を"/"で区切って連結してURLを作成してくれます。リスト2の例では、Item.Idが1だとすると、"~/Views/Location/Edit/1"というURLが生成されます。
このURLがどのように解釈されるかというと、URLの末尾から順に"/"で区切られた階層を上りつつ、対応するaspxファイルを探します。見つかったところで、それより下の階層の"/"で区切られた値を末尾から順に「Segment(セグメント)」に追加します。"~/Views/Location/Edit/1"の例では、"~/Views/Location/Edit"のところで対応するaspxファイルが見つかり、"1"がセグメントに追加されます。
こうして設定されたセグメントの値は、遷移先の編集画面で簡単に取り出すことができます(リスト3)。
// This is the Select methd to selects a single Location item with the id // USAGE: <asp:FormView SelectMethod="GetItem"> public MRRS_Scaffolding.Models.Location GetItem([FriendlyUrlSegmentsAttribute(0)]int? Id) { if (Id == null) { return null; } using (var context = new MRRSContext()) { return context.Location.Find(Id); } }
編集画面では、モデルバインドによりSelect処理としてGetItemメソッドを呼ぶようになっています。そのGetItemメソッドの引数には、モデルバインド用の属性として「FriendlyUrlSegmentAttribute(0)」が指定されています。これは前述のセグメントの最初の値のうち、最初のものをid引数にバインドするという指定です。従って、"~/Views/Location/Edit/1"というURLを元に編集画面に遷移してきた場合、1がid引数に渡されます。前述のとおり、セグメントは末尾から設定されるため、例えば"~/Views/Location/Edit/1/2/3"というURLで遷移してきた場合、セグメントの値は["3", "2", "1"]のように設定されることになるので、注意が必要です。
以上の動作を図4にまとめます。
なお、Friendly URLsについては、以下のblogエントリで詳しく紹介されています。blogエントリ内で参照されている別エントリも併せて参照すると、このライブラリの意義が分かりやすいと思います。