[[Open棟梁Project>http://opentouryo.osscons.jp/]] - [[マイクロソフト系技術情報 Wiki>http://techinfoofmicrosofttech.osscons.jp/]] -[[戻る>ASP.NET MVC]] * 目次 [#n8bb5f94] #contents *概要 [#qe050a8a] *モジュール化の考え方 [#qfa205f4] まず、Model と View と Controller の役割について整理する。 -Model: アプリケーションの基礎となるデータ構造、およびそのデータを取得・加工する業務ロジック -View: Model が保持するデータを参照し、ユーザーに表示するもの -Controller: ユーザーからの入力を受け取り、Model に対してデータの取得・加工を指示する。~ その結果を受けて、View に表示を指示する。 **ModelとViewの関係 [#u005fdca] Model (0..1) <---> (1) View ***Model (0) <---> (1) View [#aca38037] View が、Model が保持するデータを何も表示しない状態。(静的なページなど?) ***Model (1) <---> (1) View [#d22aa019] View が、Model が保持するデータを参照し、ユーザーに表示している状態。~ ただし、View が参照できるのは「Model のプロパティ」のみであり、View から直接 Model のメソッドが呼ぶことはしない。 **ControllerとViewの関係 [#xc23cbb6] View (1..*) <---> (1) Controller ***View (1) <---> (1) Controller [#va1ffd01] 1 つの View に対して、1 つの Controller を対応させる考え方。~ その View からは、対応する Controller へのみリクエストを送る。~ Controller の処理の結果は、対応する View にのみ指示を送る、というもの。~ Controller の処理の結果を、別の View に表示させたい場合は、~ Controller.RedirectToAction メソッドなどを使用して、その View に対応した Controller に処理をリダイレクトする。 乱暴な言い方をすれば、従来の ASP.NET の WebForm に近い考え方、と言えるかもしれない。 -画面 (*.aspx) が、View に相当する -コードビハインド (*.aspx.cs, *.aspx.vb) が、Controller に相当する -画面を遷移するときは、Response.Redirect メソッドを使用して処理をリダイレクトする -メリット --従来の ASP.NET の経験がある人には、とっつきやすい可能性がある。 -デメリット --Controller クラスの数が膨大になる可能性がある。 ***View (1..*) <---> (1) Controller [#n9abe57a] 複数の View に対して、1 つの Controller を対応させる考え方。 たとえば、受注処理を行うアプリケーションを考えると、「受注作成画面」・「受注内容更新画面」・「受注削除画面」など、~ 複数の View に分かれていても、同じ「受注」業務=受注エンティティに関するリクエストは 1 つの Controller が受け付ける、という考え方。~ -[[スキャフォールディング(scaffolding)>ASP.NET MVCの用語#e701b267]] --[[スキャフォールディング(scaffolding)>ASP.NET MVCの用語#e701b267]]が、この考え方を採用している。~ (1 つの Model に対して、その Model に関するリクエストを受け付ける 1 つの Controller、および CRUD を行う 4 つの View が作成される) --スキャフォールディングの場合、M/V/C それぞれの多重度は、以下のようになる。 ---View (4) <---> (1) Model~ (1 つの Model に対して、CRUD を行う View がそれぞれ作成される) ---Controller (1) <---> (1) Model~ (1 つの Model に対して、その Model に関するリクエストを受け付ける Controller が 1 つ作成される) ---View (4) <---> (1) Controller~ (CRUD を行う 4 つの View は、1 つの Controller にのみリクエストを送る) --しかし、1 つの View で、CRUD 全てを実現できる (CRUD ごとに View が分かれない) 場合は、以下のようになる。~ ---View (1) <---> (1) Model ---Controller (1) <---> (1) Model ---View (1) <---> (1) Controller --メリット ---まとまった業務ごとに Controller を作るので、Controller の数を抑えられる。 --デメリット ---複数の View からの処理をすべて 1 つの Controller で受け付けるため、その Controller のコード量が多くなる可能性がある。 **モジュール化の要約 [#j2c8410a] CRUD を 1 つの View で行うか?View を分けるか?など、画面設計にも関係するので、メリット/デメリットを考慮の上、どちらを採用するかを決定する。~ ***スキャフォールディング方式 [#td62a820] -View (1..*) <---> (1) Model -Controller (1) <---> (1..*) Model -View (1..*) <---> (1) Controller ***View ごとに Controller を作成する方式 [#se3008cd] -View (1..*) <---> (1) Model -Controller (1) <---> (1..*) Model -View (1) <---> (1) Controller *Controller の作成 [#ra660e99] **モジュール化 [#t796c394] [[モジュール化の要約>#j2c8410a]]で紹介した、 -[[スキャフォールディング方式>#td62a820]] -[[View ごとに Controller を作成する方式>#se3008cd]] 何れかの方針に合わせて、Controllerを作成する。 **利用可能な属性 [#pb75e024] ***HTTP メソッド属性 [#qa67aa3b] Action Methodには、特定の HTTP メソッドのみを受け入れる属性を付与することができる。 AcceptVerbs 属性([AcceptVerbs(HttpVerbs.Post)] 等)が用意されていたが、~ MVC 2 からはHttpGet, HttpPost, HttpPut, HttpDeleteという4つの属性が追加された。 -[HttpGet] メソッド属性 --概要 ---Get メソッドのみ受け入れる。 ---それ以外の HTTP メソッドは受け入れない(404 が返る)。 --ユースケース ---Get で別画面に画面遷移する場合 ---入力項目が無い状態で、同一画面内で状態遷移する場合 -[HttpPost] メソッド属性 --概要 ---Post メソッドのみ受け入れる。 ---それ以外の HTTP メソッドは受け入れない(404 が返る)。 --ユースケース ---フォームの入力項目を Controller に Post する場合。 ---Post で別画面に画面遷移する場合。 なお、メソッド属性を指定しなかった場合、~ そのAction Methodはすべての HTTP メソッドを受け入れる。 ***ActionName属性 [#mbf9d5ab] Action Method名と、外部に公開するAction Nameとを別にする。 例えば |項番|Action Method名|ActionName|処理の内容|h |1|Delete|Delete|削除画面の初期表示処理| |2|DeleteConfirmed|Delete|削除処理の実行| ***ValidateAntiForgeryToken属性 [#y1268547] CSRF対策に使用する。 -View @using (Html.BeginForm()) { @* トークンを埋め込む *@ @Html.AntiForgeryToken() } -Controller // トークンを検証する [HttpPost, ActionName("Delete")] [ValidateAntiForgeryToken] public ActionResult DeleteConfirmed() { ・・・ } -参考 --連載:ASP.NET MVC入門:第4回~ フィルタ属性による認証/キャッシュ/セキュリティ対策の実装 (5/5) - @IT~ http://www.atmarkit.co.jp/ait/articles/0908/14/news041_5.html --ASP.NET のセキュリティ対策について考える - しばやん雑記~ http://blog.shibayan.jp/entry/20120526/1338001863 --ASP.NET の組み込み機能を活用し、Web 攻撃を回避する~ https://msdn.microsoft.com/ja-jp/library/ms972969.aspx *Model の作成 [#r127e540] **モジュール化 [#eba3e05a] [[モジュール化の考え方>#qfa205f4]]のように、Model には 2 つの意味がある。 -アプリケーションの基礎となるデータ構造 --POCO として作成する。 --XXXXViewModelという名称を付与する。 -そのデータを取得・加工する業務ロジック --通常の業務ロジック・クラスとして作成する。 **利用可能な属性 [#yb8830b1] テンプレート・ヘルパーと呼ばれる(System.ComponentModel.DataAnnotations)。~ ViewやControllerのスキャフォールディング生成の動作を制御する属性。 -第6回 テンプレート機能でビュー開発を効率化 - @IT~ http://www.atmarkit.co.jp/fdotnet/aspnetmvc3/aspnetmvc3_07/aspnetmvc3_07_01.html -ASP.NET MVC の ModelMetadata は奥が深い - しばやん雑記~ http://blog.shibayan.jp/entry/20120108/1326030354 ***DataType属性 [#w26b6337] 型情報 [DataType(DataType.XXXX)] -DataType 列挙体 (System.ComponentModel.DataAnnotations)~ https://msdn.microsoft.com/ja-jp/library/system.componentmodel.dataannotations.datatype.aspx ***Display属性 [#af7225e4] 表示名(Label表示用のViewヘルパーに使用される) -Name --[DisplayName("xxxx")] --[Display(Name = "xxxx")] -ResourcesType(国際化対応用) --[Display(Name = "xxxx", ResourceType = typeof(yyyy))] ***DisplayFormat属性 [#u40f1f5d] フォーマットの指定。 [DisplayFormat(DataFormatXXXX="YYYY")] -DisplayFormatAttribute クラス (System.ComponentModel.DataAnnotations)~ https://msdn.microsoft.com/ja-jp/library/system.componentmodel.dataannotations.displayformatattribute.aspx --ApplyFormatInEditMode --ConvertEmptyStringToNull --DataFormatString --NullDisplayText --, etc. ***UIHint属性 [#kbd81af8] -独自の表示/編集テンプレートを準備する。 -例えばDateTime型を指定したEditorForで~ 使用するjQuery UIのDatepickerを適用する。 ***DisplayColumn属性 [#dda2f14b] -Model間のRelationを設定した際、Modelの表示名に使用しているColumn。 -Model間のRelationは、オブジェクト参照で設定する。 *View の作成 [#m019c385] **モジュール化 [#c1b7f428] -View には、 --画面全体を表す「全体 View」と、 --画面の一部分のみを表す「部分 View」がある。~ -部分 View ~ 部分 View は、「Partial View」ともいわれ、以下の用途で使われる。 --画面の共通化のため~ ASP.NET のユーザーコントロールのように、共通的な画面コンポーネントを部品化しておくもの。 --Ajax.BeginForm の部分更新の範囲を表すため~ Ajax.BeginForm を使用した非同期処理の場合、部分更新の範囲を部分 View で定義する。 **Razer、ASPX の使い分け[#m195fa6e] View には、Model のプロパティ参照用、if 文や for 文などの制御用にサーバー処理を埋め込むことができる。~ サーバー処理の記法に、Razer 構文、ASPX 構文がある。 ||ASPX|Razor|h |インライン式 (プロパティの値を表示する場合など)|<%: Model.Property1 %>|@Model.Property1| |インライン式 (エスケープ処理をスキップし、プロパティの値をそのまま表示する場合)|<%= Model.Property1 %>|@Html.Raw(Model.Property1)| |コードブロック (ロジックを直接 View に記述する場合) (C#)|<% string str = "あいうえお"; %>|@{ string str = "あいうえお"; }| |コードブロック (ロジックを直接 View に記述する場合) (VB)|<% Dim str As String = "あいうえお" %>|@Code&br; Dim str As String = "あいうえお"&br;End Code| **BeginForm の使い分け [#sf5c2980] ASP.NET MVC には、<form> タグを生成する Viewヘルパーが 2 種類ある。~ BeginForm ヘルパーは引数にコントローラー名、アクション名が付与でき、指定したアクションメソッドにリクエストを送ることができる。 ***HTML.BeginForm [#y7008c56] 通常の <form> タグを生成する場合に使用する。 -全体更新が多数を占める場合 (アクションメソッドの結果として、View 全体を更新する場合)。 -画面リフレッシュにより、リクエスト・レスポンスのステータスを明確にしたい場合。 ***Ajax.BeginForm [#b0eaca55] <form> タグに Ajax リクエスト用の属性が付与され、リクエストが非同期で処理される。 -部分更新が多数を占める場合 (アクションメソッドの結果として、View の一部分のみを更新する場合)。 -サーバー側処理が非常に重い業務の場合 (Ajax は非同期処理のため)。 -画面入力状態を保持したまま POST 送信したい場合 --ViewState がサポートされない MVC で、情報復元処理を割愛したい場合。 -リクエスト・レスポンスのサイズを削減して、性能向上を図りたい場合。 -画面リフレッシュによる、画面のちらつきなどをなくしたい場合。 ***参考 [#q5e2db0d] -ajaxの使いどころ~ http://okwave.jp/qa/q8112782.html -Html.BeginForm() vs Ajax.BeginForm() in MVC3 - CodeProject~ http://www.codeproject.com/Articles/429164/Html-BeginForm-vs-Ajax-BeginForm-in-MVC3 **From タグの切り方 [#j1aac0c9] 画面設計によるが、以下を考慮する。 -1 View に対して 1 Form? -1 View に対して複数 Form? 複数 Form の場合は Form をネストさせないこと。~ #HTML の仕様で Form のネストは禁止されている。 **Viewヘルパーの使い分け [#f9430132] ***HTMLヘルパー(Html.xxxx と Html.xxxxFor [#c3297525] -Html.xxxxFor~ --ポスト時にModelデータを復元する場合。 --例えばエラー発生時に、自画面の再表示(≒ポストバック)をする場合。 -Html.xxxx~ 上記以外は、Html.xxxxで良い。 ***グリッド生成用のViewヘルパー [#j629d667] ASP.NET MVC でグリッドのある View を作成する場合、以下の 3 種類が考えられる。 -[[WebGrid>https://msdn.microsoft.com/ja-jp/library/system.web.helpers.webgrid.aspx]] クラスを使用する~ ソートやページングが容易に実装できる反面、レンダリング部分は多少ブラックボックスになる -<table> タグを自前で生成し、<tr> タグをループで実装する~ ASP.NET の Repeater コントロールのような処理の実装方法(Razorなぶん楽)。 -jqGrid など、OSS ライブラリを使用する。 ***テンプレートに対応したViewヘルパー [#s2b28732] -Viewヘルパー --EditFor ---HTMLヘルパーの第二引数でテンプレートを指定できる。 ---UIHint属性で指定したテンプレートが使用される。~ 属性の優先度は、UIHint属性 -> DataType属性 -> 実際のデータ型 --DisplayForModel、EditForModel ---Model単位にテンプレートを決定する。 -テンプレート名とテンプレート配置場所 --DisplayTemplates ---~/View/Shared/DisplayTemplates/DataType名 or Model名.cshtml ---~/View/Controller名/DisplayTemplates/DataType名 or Model名.cshtml --EditorTemplates ---~/View/Shared/EditorTemplates/DataType名 or Model名.cshtml ---~/View/Controller名/EditorTemplates/DataType名 or Model名.cshtml ***カスタムViewヘルパー [#uf401f54] **画面遷移の方法 [#ycae9af6] [[モジュール化の要約>#j2c8410a]]で紹介した、[[スキャフォールディング方式>#td62a820]]、[[View ごとに Controller を作成する方式>#se3008cd]]ともに、リクエストの処理フローは以下のようになる。 +View から、対応する Controller にリクエストを送る~ (書こうと思えば、任意の Controller にリクエストを送ることはできるが、View と Controller の関係が複雑になるのでオススメしない) +Controller はリクエストを受け付け、Model に処理を指示する +Model は業務ロジックを実行し、データを更新する +Controller は View に表示を指示する ここで、''どの View に表示の指示をするか''によって、使用する ActionResult クラスが変わる。 -その Controller に対応する View に、表示を指示する場合 --ViewResult を使用する -別の Controller に対応する View に、表示を指示する場合 --RedirectToActionResult または RedirectToRouteResult を使用する *フォルダ構成 [#c0d7785c] **既定のフォルダ構成 [#zdede462] ASP.NET MVC のテンプレートには、グルーピングを目的に、既定で以下のフォルダ構成となっている。~ それぞれのフォルダには、以下のようにファイルを配置することが推奨されている。 |フォルダ名|配置されるファイル|備考|h |App_Start|起動時に、初期設定を行うモジュール|-| |Contents|CSS|BundleConfig が使用しているため、既定の CSS ファイルは変更しない| |Controllers|Controller|-| |Models|Model|-| |Scripts|JavaScript|BundleConfig が使用しているため、既定の JavaScript ファイルは変更しない| |Views|View|対応する Controller 名のフォルダ以下に、View のファイルを配置する&br;例&br;Views\(コントローラー名)\Index.cshtml| **Area (区分)による分割 [#re760150] Area (区分) とは、ASP.NET MVC アプリケーションを論理的に分割する仕組みのことである。~ (ASP.NET MVC プロジェクトをシステム全体とすると、Area ごとにサブシステム (のようなもの) に分割できる。~ App_Start のマップルートが追加されるような感じ、と理解すると分かりやすいかもしれない) *情報の持ち回り・状態管理方式 [#i6db0cb0] -ViewState~ 利用不可能 (必要であれば、自前で ViewState に相当するものする必要がある) -Hidden~ 使用可能 -Session~ 使用可能 *チェック処理方式 [#hc015ceb] **クライアント [#i39f251f] JavaScript でのチェック。~ [[jQuery Validation プラグイン>https://jqueryvalidation.org/]]なども使用可能。 **サーバ [#k1290bb8] Action メソッド内でのチェック。~ 個別にチェックロジックを実装するか、アノテーションを使用したチェックが可能。 -お楽しみはこれからだ! --ASP.NET MVC RCの入力検証~ http://takepara.blogspot.jp/2009/02/aspnet-mvc-rc.html --強力になったDefaultModelBinder~ http://takepara.blogspot.jp/2009/02/defaultmodelbinder.html --DataAnnotationsだけでの入力検証の盲点~ http://takepara.blogspot.jp/2009/02/dataannotations.html -こんなこともできるもよう(Entity Frameworkが必要)。 --ASP.NET MVC 3における検証まわりの改善点 (3-4):CodeZine~ http://codezine.jp/article/detail/6176?p=3 --ASP.NET MVC 4 ことはじめ(5)モデルと足場 - アーキテクチャをスマートに。~ http://d.hatena.ne.jp/architect-wat/20130512/1368360044 *脆弱性 [#jd31de6d] **サニタイジング [#m59baf7f] -HTML ヘルパーを使用すると、自動的にサニタイジングが行われる。 -Model のプロパティを直接 View に表示する場合は、自前でのサニタイジングが必要。 **リクエスト検証 [#ra245005] -requestValidationMode を MVC でも利用可能。~ http://stackoverflow.com/questions/6206540/what-does-requestvalidationmode-2-0-actually-do ---- Tags: [[:ASP.NET MVC]]