一、理解控制器
1.1、什么是控制器
控制器是包含必要的處理請求的.NET類,控制器的角色封裝了應用程序邏輯,控制器主要是負責處理請求,實行對模型的操作,選擇視圖呈現(xiàn)給用戶。
簡單理解:實現(xiàn)了IController接口,修飾符必須是public,不能是抽象的,不能是泛型的,類名必須以Controller結(jié)尾。
在MVC框架中,控制器類必須實現(xiàn)System.Web.Mvc命名空間下的IController接口,如上圖所示,這是一個非常簡單的接口,該接口僅有一個Execute方法,當請求該控制器時Execute方法被調(diào)用。通過實現(xiàn)IController接口,你可以創(chuàng)建控制器類。
1.2、控制器的作用
a、每一個針對應用程序的請求,都是通過控制器自由地選擇合適的方式來處理的,只要它不偏離到視圖(View)和模型(Model)所負責的區(qū)域。
b、不要把業(yè)務(wù)或數(shù)據(jù)存儲的邏輯放到控制器里面,也不要創(chuàng)建用戶接口。
1.3、創(chuàng)建實現(xiàn)IController接口的控制器
示例: 創(chuàng)建一個實現(xiàn)Icontroller接口的類,讀取路由數(shù)據(jù),并生成數(shù)據(jù)寫入響應。
在Controllers文件夾下創(chuàng)建一個名為MyFirstController的類,實現(xiàn)IController接口并添加如下代碼
運行該應用程序并在地址欄導航到/MyFirst,便可以看到此控制器產(chǎn)生的輸出。
創(chuàng)建一個類通過實現(xiàn)IController接口,MVC框架會將其視為一個控制器,并將請求發(fā)送給它,而且在如何處理和響應請求上沒有任何限制,這是一個很好的示例,因為它向你展示了MVC框架的可擴展性,但用這種方式編寫一個復雜的應用程序是非常困難的。
1.4、創(chuàng)建繼承于Controller類的控制器
通過System.Web.Mvc.Controller類你可以派生你的控制器,System.Web.Mvc.Controller類是大多數(shù)Web開發(fā)人員需要熟悉的,用來對請求處理提供支持的一個類,Controller提供了以下三個關(guān)鍵特性。
(1)、動作方法(Action Method):一個控制器的行為被分解成多個方法(而并非只有唯一的Execute()方法)。每個動作方法被暴露給不同的URL,并通過從輸入請求提取的參數(shù)進行調(diào)用。
(2)、動作結(jié)果(Action Result):你可以返回一個描述動作結(jié)果的對象(例如:渲染一個視圖,或重定向到一個不同的URL或動作方法),然后通過該對象實現(xiàn)你的目的。這種指定結(jié)果和執(zhí)行之間的分離簡化了單元測試。
(3)、過濾器(Filter):你可以把可重用的行為封裝成過濾器,然后通過在代碼中添加特性的的方式,把這種行為標注到一個過多個控制器或動作方法上。
除非在頭腦中有一個非常明確的需求,否則創(chuàng)建控制器最好的辦法就是通過Controller類進行派生,這也正是你在Visual Studio中添加一個控制器,Visual Studio為你所做的事情。
在Controllers文件夾下創(chuàng)建一個名為MySecondController的類,繼承與Controller類,然后添加一個動作方法TestAction并編寫如下代碼返回一個動作結(jié)果,最后再該動作方法內(nèi)右鍵添加對應的視圖。
運行應用程序并導航到/MySecond/TestAction瀏覽結(jié)果如下:
作為Controller類的一個派生類,所要做的工作是實現(xiàn)動作方法、獲取所需要的各種輸入,以對請求進行處理,并生成一個適當?shù)捻憫:竺娴膬?nèi)容將介紹數(shù)據(jù)的接收與響應。
二、控制器對數(shù)據(jù)的接收
2.1、數(shù)據(jù)來源
a、查詢字符串值 b、表單數(shù)據(jù) c、路由數(shù)據(jù)
控制器需要經(jīng)常訪問來自輸入請求的數(shù)據(jù),如查詢字符串、表單數(shù)據(jù)、以及由路由系統(tǒng)根據(jù)輸入的URL解析得到的參數(shù)的值。訪問這些數(shù)據(jù)有三種主要方式。
(1)、從上下文對象提取。
(2)、作為參數(shù)被傳遞給動作方法(Action Method)而形成的數(shù)據(jù)。
(3)、明確調(diào)用框架的模型綁定(Model Binding)功能。
注意:參數(shù)名稱是忽略大小寫的,如Request["Test"]與Request["test"]結(jié)果是一樣的。如下圖:
View部分
Controller部分
2.2、通過上下文對象獲取數(shù)據(jù)
當創(chuàng)建一個從Controller基類派生的控制器時,就能夠訪問一組非常便利的屬性,這些屬性包括:Request、Response、RouteData、HttpContext、Server等,每一個屬性都包含了請求不同方面的的信息。在Action方法里是可以使用任何Context對象來訪問這些屬性。例如:
1 public ActionResult Index() 2 { 3 string userName = User.Identity.Name; 4 string serverName = Server.MachineName; 5 string clientIP = Request.UserHostAddress; 6 DateTime dateStamp = HttpContext.Timestamp; 7 8 string oldProductName = Request.Form["OldName"]; 9 string newProductName = Request.Form["NewName"]; 10 11 ViewBag.Message = "本機的IP是:" + clientIP; 12 return View(); 13 }
可以利用VS智能感知,在動作方法中輸入this.找到這些可用的上下文信息。
2.3、使用動作(Action)方法參數(shù)
2.3.1、使用Action方法參數(shù)
下面的方式是不是比上面的方法更優(yōu)雅易讀呢?不過需要注意的是:Action方法里面是不允許有ref或out參數(shù)的,雖然編譯不會報錯但運行時會拋出一個異常。如下所示。
MySecond控制器代碼如下:
Index視圖代碼如下:
運行結(jié)果如下:
2.3.2、理解參數(shù)對象實例化
Controller基類使用叫做“值提供器(Value Provider)”和“模型綁定器(Model Binder)”的MVC框架組件來獲取動作方法的參數(shù)值。值提供器將可用的數(shù)據(jù)項集合呈現(xiàn)給控制器。有一組內(nèi)建的值提供器從Request.For
m、Request.QueryString、Request.Files、RouteData.Values獲取數(shù)據(jù)項,然后這些值會被傳遞給模型綁定器,模型綁定器會嘗試將這些數(shù)據(jù)映射成動作方法參數(shù)的數(shù)據(jù)類型。默認的模型綁定能夠創(chuàng)建和填充任何.NET類型的對象,包括自定義的類型和集合。
2.3.3、理解可選參數(shù)與必須的參數(shù)
如果MVC框架找不到引用類型參數(shù)(如:string或object)的值,動作方法仍然會被調(diào)用,但對該參數(shù)會使用一個null值,若找不到值類型參數(shù)(如:int或double)的值則會拋出一個異常,并且不會調(diào)用動作方法。
a、值類型參數(shù)是必須被賦值的。如果想讓此參數(shù)和引用類型參數(shù)一樣,可以定義成int?如:public ActionResult Index(int? num),當依然沒有值時,不會發(fā)生異常,而是會傳遞null值。
b、引用類型的參數(shù)是可選的。為了使它成為必須的(保證一個非空的值被傳遞),在動作(Action)方法上添加一些代碼拒絕null。例如,在該值等于null時,拋出一個ArgumentNullException異常。
2.3.4、指定默認參數(shù)值
如果希望處理不含動作方法參數(shù)的請求,但又不想在代碼中檢查null值或拋出異常,可以使用C#的可選參數(shù)特性來代替。如下所示:
1 public ActionResult List(string query = "all", int page = 1) 2 { 3 //此處省略代碼N行... 4 return View(); 5 }
在定義參數(shù)時,通過對參數(shù)賦值的辦法,可以將參數(shù)標記為可選的,如上訴代碼中,給query和page參數(shù)提供了默認值。MVC框架會試圖通過請求為這些參數(shù)獲取值,但如果沒有值可用,那么將用所指定的默認值代替。
對于string類型參數(shù)query,注意string類型是引用類型,這意味著不需要檢查null值。如果請求為指定查詢字符串,那么該動作(Action)方法將以字符串“all”進行調(diào)用。對于int類型參數(shù),注意int類型是值類型,在沒有page值時,請求不會導致錯誤,該方法將以默認值“1”進行調(diào)用。
三、控制器對數(shù)據(jù)的響應
3.1、理解動作結(jié)果(Action Result)
原理:
a、MVC框架接收從Action方法返回的ActionResult對象,并調(diào)用定義在ActionResult類里面ExecuteResult方法,對ActionResult進行實現(xiàn),為我們處理Response對象并生成相關(guān)的輸出。
b、MVC框架內(nèi)置了許多ActionResult類型,都是從ActionResult類派生的,能夠方便我們在Action方法里面選擇具體的返回類型,比如要呈現(xiàn)到View,可以選擇ViewResult作為Action方法的返回值。
MVC框架含有許多內(nèi)置的動作結(jié)果類型如下圖所示,所有這些類型都是派生于ActionResult,其中在Controller類中有便利的輔助器方法。下面將解釋如何使用這些結(jié)果類型。
MVC框架支持的輸出類型有: 1.視圖 2.文本數(shù)據(jù) 3.XML數(shù)據(jù) 4.JSON數(shù)據(jù) 5.文件或者二進制數(shù)據(jù) 6.返回錯誤和HTTP Codes 7.定制的ActionResult 8.重定向
3.2、通過渲染視圖(View)返回HTML
最常見的來自Action方法的響應就是生成HTML并發(fā)送給瀏覽器,為了使用動作結(jié)果(ActionResult)生成HTML,需要創(chuàng)建一個指定了要呈現(xiàn)的視圖ViewResult類的實例。我們在Home控制器中編寫如下代碼.代碼中指定了HomePage的視圖。
當MVC框架調(diào)用ViewResult對象的ExecuteResult時,就會開始對指定的View進行搜素。
使用了區(qū)域(Area),則搜索順序如下:
1、/Area/<AreaName>/Views/<ControllerName>/<ViewName>.aspx
2、/Area/<AreaName>/Views/<ControllerName>/<ViewName>.ascx
3、/Area/<AreaName>/Views/Shared/<ControllerName>/<ViewName>.aspx
4、/Area/<AreaName>/Views/Shared/<ControllerName>/<ViewName>.ascx
5、/Area/<AreaName>/Views/<ControllerName>/<ViewName>.cshtml
6、/Area/<AreaName>/Views/<ControllerName>/<ViewName>.vbhtml
7、/Area/<AreaName>/Views/Shared/<ControllerName>/<ViewName>.chtml
8、/Area/<AreaName>/Views/Shared/<ControllerName>/<ViewName>.vbhtml
如果沒有使用區(qū)域(Area)或者在前面找不到則會在下面搜索,搜索順序如下:
1、/Views/<ControllerName>/<ViewName>.aspx
2、/Views/<ControllerName>/<ViewName>.ascx
3、/Views/Shared/<ControllerName>/<ViewName>.aspx
4、/Views/Shared/<ControllerName>/<ViewName>.ascx
5、/Views/<ControllerName>/<ViewName>.cshtml
6、/Views/<ControllerName>/<ViewName>.vbhtml
7、/Views/Shared/<ControllerName>/<ViewName>.chtml
8、/Views/Shared/<ControllerName>/<ViewName>.vbhtml
只要有一個視圖找到,就停止搜索,并開始將找到的視圖(View)呈現(xiàn)給客戶端。
通過路徑來指定呈現(xiàn)的視圖(View)
這種命名約定的方法非常方便和簡捷,但是它限制了我們所能呈現(xiàn)的一些視圖。如果要呈現(xiàn)一個具體的視圖,可以提供一個明確的路徑,下面是一個例子。
當我們這樣指定一個視圖時,指定的路徑必須以“/”或者“~/”并且包含擴展名(如:.aspx)。當然不推薦這樣來使用,因為這不利于程序的擴展和維護,這是一種綁定或耦合,有違MVC設(shè)計思想,可以有其他的方法來達到同樣的效果例如:使用RedirectToAction()方法。
View輔助方法
View():返回到Action同名的視圖。
View(“viewName”):返回到此控制器的ViewName視圖。
View(“~/views/othercontroller/viewname.cshtml”):這種方式必須以~/或者/開頭,但并不建議這么做,因為可以調(diào)用RedirectToAction這樣的方法。
View(“viewname”,”layout”):呈現(xiàn)這個視圖的時候,換一個母版頁。
3.3、將數(shù)據(jù)從動作(Action)方法傳遞給視圖(View)
傳輸數(shù)據(jù)的幾種方式:1.視圖模型 2.ViewData 3.ViewBag 4.TempData
3.3.1、提供視圖模型對象
將一個對象作為View方法的參數(shù)傳遞給視圖。例如:
Controller部分
1 public ViewResult Index2() 2 { 3 DateTime date = DateTime.Now; 4 return View(date); 5 }
View部分,添加視圖時,選擇Razor視圖引擎。
1 @{ 2 ViewBag.Title = "Index2"; 3 } 4 <h2>Index</h2> 5 The day is: @(((DateTime)Model).DayOfWeek)
上面的視圖是一個沒有類型或者說是弱類型的視圖,它不知道關(guān)于視圖模型對象的任何信息,并且將它作為object對象的實例進行處理。為了得到DayOfWeek屬性的值,需要將object對象的實例強轉(zhuǎn)為DateTime,這樣做能夠?qū)崿F(xiàn)效果,但卻讓視圖變得雜亂。
我們可以通過創(chuàng)建強類型的View來改進,即在View里指定視圖模型對象的類型,只需要添加代碼:@model DateTime,如下所示:
1 @model DateTime 2 @{ 3 ViewBag.Title = "Index2"; 4 } 5 <h2>Index</h2> 6 The day is: @Model.DayOfWeek
運行結(jié)果如下:
可以發(fā)現(xiàn),使用強類型的視圖不僅讓視圖變得整潔,而且方便我們編碼,因為對屬性有智能感知。如下圖所示:
3.3.2、使用ViewBag傳遞數(shù)據(jù)
在前面我們已經(jīng)使用過了ViewBag視圖包這個特性,該特性允許你在一個動態(tài)對象上定義任意屬性,并能夠在視圖里面訪問。如下所示:
Controller部分
1 public ViewResult Index2() 2 { 3 ViewBag.Message = "Hello ViewBag!"; 4 ViewBag.Date=DateTime.Now; 5 return View(); 6 }
View 部分
1 @{ 2 Layout = null; 3 } 4 5 <!DOCTYPE html> 6 7 <html> 8 <head> 9 <meta name="viewport" content="width=device-width" /> 10 <title>Index2</title> 11 </head> 12 <body> 13 <div> 14 the message is:@ViewBag.message<br/> 15 the day is:@ViewBag.Date.DayOfWeek 16 </div> 17 </body> 18 </html>
運行效果如下:
相對于視圖模型對象方面,ViewBag有一個優(yōu)點,即它能夠很容易地發(fā)送多個對象到視圖。假如我們被限制只能使用視圖模型,那么為了實現(xiàn)相同的效果需要創(chuàng)建一個新的類型具有string和DateTime兩個類型的的成員。使用動態(tài)對象可以在視圖中輸入屬性和方法調(diào)用的任意序列。
3.3.3、使用ViewData傳遞數(shù)據(jù)
ViewData是在MVC3之前的版本中出現(xiàn)的,主要的功能類似于ViewBag,但ViewData是使用ViewDataDictionary類實現(xiàn)的而不是一個動態(tài)的類型,ViewDataDictionary類是一個常規(guī)的鍵/值對的集合,并通過Controller類的ViewData屬性訪問。如下示例:
Controller部分
1 public ViewResult Index2() 2 { 3 ViewData["message"] = "Hello ViewBag!"; 4 ViewData["Date"]=DateTime.Now; 5 return View(); 6 }
View部分
1 @{ 2 Layout = null; 3 } 4 5 <!DOCTYPE html> 6 7 <html> 8 <head> 9 <meta name="viewport" content="width=device-width" /> 10 <title>Index2</title> 11 </head> 12 <body> 13 <div> 14 the message is:@ViewData["message"]<br/> 15 the day is:@(((DateTime)ViewData["Date"]).DayOfWeek) 16 </div> 17 </body> 18 </html>
運行結(jié)果與VIewBag運行結(jié)果一致。
上面的代碼中,我們看到ViewData需要對object對象進行類型轉(zhuǎn)換,現(xiàn)在有了ViewBag以后,推薦使用ViewBag,并且盡量使用強類型視圖和視圖模型。
3.3.4、使用TempData傳遞數(shù)據(jù)
在【3.4.4、使用TempData保留重定向數(shù)據(jù)】節(jié)中會介紹使用TempData傳遞數(shù)據(jù),這里不作介紹。
3.4、執(zhí)行重定向
有一種動作(Action)方法的通常結(jié)果并不是直接產(chǎn)生輸出,而是把用戶的瀏覽器重定向?qū)Я硪粋€URL。大多數(shù)情況下,這個URL是應用程序的另一個動作(Action)方法,用來生成你希望用戶看到的輸出。
重定向的Action方法不產(chǎn)生任何的輸出,只是讓瀏覽器重新請求一個其它的URL。在MVC程序中,一般會定向到其它的Action方法來產(chǎn)生輸出。
在執(zhí)行重定向時,發(fā)送了兩個HTTP代碼中的一個到瀏覽器。
(1)、發(fā)送HTTP 302狀態(tài)編碼,代表暫時重定向。(常用類型)
(2)、發(fā)送HTTP 301狀態(tài)編碼,表示永久重定向。(使用需謹慎)
重定向的類型有:1.重定向到文本URL 2.重定向到路由系統(tǒng)的URL 3.重定向到動作(Action)方法
3.4.1、重定向到文本URL
對瀏覽器重定向最基本的方式是調(diào)用Redirect方法,它返回RedirectResult類的一個實例。如下示例:
如果希望重定的URL被表示成一個字符串,并作為參數(shù)傳遞給Redirect方法。Redirect方法發(fā)送的是一個臨時重定向??梢杂肦edirectPermanent方法發(fā)送一個永久重定向。例如:
3.4.2、重定向到路由系統(tǒng)的URL
使用重定向到文本URL的缺點是:限定了URL,當路由發(fā)生改變后,必須更新URL。幸好我們可以使用路由系統(tǒng),用RedirectToRoute方法來生成有效的URL該方法會創(chuàng)建 RedirectToRouteResult的一個實例。如下所示:
3.4.3、重定向到動作(Action)方法
使用RedirectToAction方法能夠很優(yōu)雅的重定向到一個Action方法,這個方法僅僅是對RedirectToRoute方法的封裝,讓你指定Action方法和控制器的值,而不需要創(chuàng)建一個匿名類型。如下所示:
如果想重定向到其他的控制器,需要提供一個控制器的名稱如:
注意:傳入的Action參數(shù)或控制器參數(shù)在它們被傳遞給路由系統(tǒng)之前是不會被驗證的,所以要確保目標控制器和Action方法是存在的。
3.4.4、使用TempData保留重定向數(shù)據(jù)
重定向會引起瀏覽器提交整個新的HTTP請求,這意味著無法訪問原始的請求的細節(jié)。如果想將數(shù)據(jù)從一個請求傳遞到下一個請求,可以使用TempData()方法。
TempData類似于Session,不同的是TempData在被讀取以后會被標記刪除,并且當請求被處理的時候被移除。這是一個針對想在整個重定向過程中保持短期數(shù)據(jù)的非常完美的安排。如下示例:
首先添加一個MySecond控制器,并添加對應的視圖,視圖引擎為Razor并編寫如下代碼:
MySecond控制器代碼
1 public class MySecondController : Controller 2 { 3 public ActionResult Index() 4 { 5 TempData["Message"] = "Hello TempData"; 6 TempData["Data"] = "TempData的值只能讀取一次"; 7 return View(); 8 } 9 public ActionResult TempDataTest() 10 { 11 return View(); 12 } 13 } 14
Index視圖代碼
1 @{ 2 Layout = null; 3 } 4 5 <!DOCTYPE html> 6 7 <html> 8 <head> 9 <meta name="viewport" content="width=device-width" /> 10 <title>Index</title> 11 </head> 12 <body> 13 <div> 14 the Data is:@TempData["Data"] 15 </div> 16 </body> 17 </html>
TempDataTest視圖代碼
1 @{ 2 Layout = null; 3 } 4 5 <!DOCTYPE html> 6 7 <html> 8 <head> 9 <meta name="viewport" content="width=device-width" /> 10 <title>TempDataTest</title> 11 </head> 12 <body> 13 <div> 14 the Data is:@TempData["Data"]<br/> 15 the Message is:@TempData["Message"] 16 </div> 17 </body> 18 </html>
運行結(jié)果如下:
注意:在Index里面沒有讀取TempData["Message"]的值,但是Index和TempDataTest都讀取了TempData["Data"]的值。這樣做是為了驗證TempData里面的值在不同的視圖只能讀取一次。
TempData里面的值在一次請求里面只能讀取一次。 如果我們想讀取TempData的值但是又不讓它被刪除,可以使用TempData.Peek(“Data”)方法。 如果想在保持一次TempData里面的值,可以使用TempData.Keep("Data")。
3.5、返回文本數(shù)據(jù)
Content方法參數(shù)說明: 發(fā)送的文本數(shù)據(jù)、響應的HTTP content-type header、編碼格式。 可以忽略最后兩個參數(shù),在MVC框架假定數(shù)據(jù)是HTML(content type為text/html)情況下,它會查詢一種瀏覽器聲明支持的編碼格式。