詳解ASP.NET MVC 3新的Layout佈局系統

 

今天我們談到的是ASP.NET MVC 3中有關新的Layout佈局系統,在MVC3當中我們可以利用新的Layout佈局系統來代替掉原來在MVC2當中使用的MasterPage。

AD:


I:回憶MVC2當中MasterPage那些事

大家先看下面的代碼:

  1. <!------------Begin--------------> 
  2. <!-- Master文件 --> 
  3. <%@ Master Language="C#"   
  4.     Inherits="System.Web.Mvc.ViewMasterPage" %> 
  5. Master head  
  6. <asp:ContentPlaceHolder ID="MainContent" runat="server" /> 
  7. Master1...  
  8. <asp:ContentPlaceHolder ID="OtherContent" runat="server" /> 
  9. Master2...  
  10. <asp:ContentPlaceHolder ID="AnyContent" runat="server" /> 
  11. Master3...  
  12. <!-------------End---------------> 
  13.  
  14.  
  15. <!------------Begin--------------> 
  16. <!-- 某個View文件 --> 
  17. <%@ Page Language="C#"   
  18.     MasterPageFile="~/Views/Shared/Site.Master"   
  19.     Inherits="System.Web.Mvc.ViewPage" %> 
  20. <asp:Content ID="Content1" ContentPlaceHolderID="MainContent" runat="server"> 
  21. MainContent...  
  22. </asp:Content> 
  23.  
  24. <asp:Content ID="Content2" ContentPlaceHolderID="OtherContent" runat="server"> 
  25. OtherContent...  
  26. </asp:Content> 
  27.  
  28. <asp:Content ID="Content3" ContentPlaceHolderID="AnyContent" runat="server"> 
  29. AnyContent...  
  30. </asp:Content> 
  31. <!-------------End---------------> 
  32. <!------------Begin--------------> 
  33. <!-- 最後傳回給客戶端的文件 --> 
  34. Master head  
  35. MainContent...  
  36. Master1...  
  37. OtherContent...  
  38. Master2...  
  39. AnyContent...  
  40. Master3...  
  41. <!-------------End---------------> 

我們可以看到在Master中ContentPlaceHolder服務端控件起到了一個佔位符的作用.最後輸出的,其實是在View當中的Content服務端控件內的內容,接下來開始介紹Layout.

II:ASP.NET MVC3 新的Layout佈局系統

在MVC3當中我們可以利用新的Layout佈局系統來代替掉原來在MVC2當中使用的MasterPage(當然在MVC3當中,如果你是繼續使用ASPX視圖引擎的話,那麼還是可以用回原來的MasterPage,然後~~~~然後~你會和runat=”server”保持着從.NET 1.x到.NET 4.0以來從沒有間斷過的合作關係,可謂緣分呀!).

我們在VS2010 MVC3項目中創建Item時,從創建嚮導中可以看到以下新增的幾個Item

下面進行逐一介紹:

Layout頁:

該傢伙其實就相當於原來的Master文件.爲站點的統一主題界面和減少大部分冗餘的Html,head,body標記曾作出過很大的貢獻.可謂是功不可莫啊!MasterPage他的誕生是在.NET 2.0版本!在服役到.NET4.0版本後出現了一個新成員[Layout]去向他挑戰.MasterPage能否經得起新成員的挑戰呢?這個還是得留各位觀衆做詳細對比吧!

Partial頁:

相當於原來的UserControl.它可以爲你減輕不少需要重複勞動的時間!

View頁:

就是View啦.創建它時.一般都是在不需要使用Layout/MasterPage的時候.

View Page with Layout:

等同於原來的View Content Page.它的功能只是爲了實現原來在Layout/MasterPage下所定義的佔位符.當然在原來的MasterPage中如果你沒有實現原先定義的佔位符<asp:ContentPlaceHolder />,那麼在最終合併輸出的時候MasterPage佔位符<asp:ContentPlaceHolder />那裏就會輸出空.

以上這4個新成員都是可以利用新的Razor視圖引擎進行工作.如果你還沒了解Razor那麼可以參考我的另外一編文章

1.Layout頁基礎:

如果你有使用MasterPage的經驗,你將會記得如下的幾個東西

A:<%@ Master %>

B:<%@ Page %>

C:<asp:ContentPlaceHolder />

D:<asp:Content />

但是在Layout中,以上的這些東西將會消失.(作者不排除有WebPages和WebForms兼容工作的可能性)

取而代之的新功能是:

A.Layout屬性:等同於原來的MasterPageFile屬性.

B.@RenderBody()方法:直接渲染整個View到佔位符處,而不需要原來所使用的<asp:Content />.

C.@RenderPage()方法:渲染指定的頁面到佔位符處.

D.@RenderSection方法:聲明一個佔位符,和原來的<asp:ContentPlaceHolder />功能類似.

E.@section標記:對@RenderSection方法聲明的佔位符進行實現,和原來的<asp:Content />功能類似.

1.1.@RenderBody()方法的使用

首先在~/Views/Shared/下創建一個名爲_MyLayout.cshtml的LayoutPage文件,並將默認的內容替換爲如下:

  1. <!DOCTYPE html> 
  2. <html> 
  3. <head> 
  4.     <title>@ViewBag.Title</title> 
  5. </head> 
  6. <body> 
  7.     <div> 
  8.         開始渲染Body<br /> 
  9.         @RenderBody()  
  10.         渲染Body結束<br /> 
  11.     </div> 
  12. </body> 
  13. </html> 

然後打開在~/Views/Home/Index.cshtml文件並替換爲如下的內容:

  1. @{  
  2.     ViewBag.Title = "首頁";  
  3. }  
  4.  
  5. <div> 
  6.     這裏就是渲染Body啦.~~不需要寫神馬&lt;asp:Content /&gt;,其實因爲RenderBody()不在有歧義.  
  7. </div> 

最後輸出截圖爲:

這個與之前MasterPage的代碼量相比之下減少了許多,而更爲簡潔明瞭.

最後別忘記把~/Views/_ViewStart.cshtml中的Layout屬性改爲:

Layout = "~/Views/Shared/_MyLayout.cshtml";喔.

在此,你或許會有疑問了.在_Layout中定義的RenderBody()是Render那個頁啊?

答:其實最後Render頁的歸屬就是Render你所訪問的那個頁,比如你訪問/Home/Index.那麼Render就是Home控制器下的Index.cshtml這個文件, 如果訪問的是/Ohter/SomePage時,那麼Render的是Ohter控制器下的SomePage這個.cshtml!

在這裏可能有的朋友沒有接觸過MVC.在此補個基礎,在默認的路由設置選項下:

  1. public static void RegisterRoutes(RouteCollection routes)  
  2. {  
  3.     routes.IgnoreRoute("{resource}.axd/{*pathInfo}");  
  4.  
  5.     routes.MapRoute(  
  6.         "Default"// Route name  
  7.         "{controller}/{action}/{id}"// URL with parameters  
  8.         new { controller = "Home", action = "Index", id = UrlParameter.Optional } 
  9. // Parameter defaults  
  10.     );  
  11.  

請求地址:http://localhost/Home/Index的工作流程爲下圖(這裏沒有考慮Layout):

如果這個RenderBody滿足不了你的業務需求,請放心,在此介紹另外一個Render方式RenderPage().它可以讓你指定要Render的頁.

1.2.@RenderPage()方法的使用

在~/Views/Home/文件夾下新建立一個ViewPage1.cshtml文件,將內容改爲如下:

  1. <div> 
  2.     這裏是~/Views/Home/ViewPage1.cshtml,老規矩:還是不用寫&lt;asp:Content /&gt; 
  3. </div> 

並在原來的_MyLayout.cshtml文件中增加幾行代碼變成下面的這個樣子:

  1. <!DOCTYPE html> 
  2.  
  3. <html> 
  4. <head> 
  5.     <title>@ViewBag.Title</title> 
  6. </head> 
  7. <body> 
  8.     <div> 
  9.         開始渲染Body<br /> 
  10.         @RenderBody()  
  11.         渲染Body結束<br /> 
  12.         <br /> 
  13.         開始渲染其他頁<br /> 
  14.         @RenderPage("~/Views/Home/ViewPage1.cshtml")  
  15.         渲染其他頁結束<br /> 
  16.           
  17.     </div> 
  18. </body> 
  19. </html> 

我們來看最終的輸出效果:

在這裏記住:@RenderBody()只能在_Layout.cshtml中使用一次,而@RenderPage()則可以使用多次!

好了在這裏如果還有不明白的朋友們.我下面上個圖說明Render的工作原理

如果想要了解在Layout中如何使用類似於原來MasterPage中的<asp:ContentPlaceHolder /><asp:Content />功能請繼續往下看.

III:在Layout佈局系統中實現類似於原來MasterPage功能的實現方式

好,寫到這裏開始介紹上一章節中沒有介紹完的兩個東西:@RenderSection方法和@section標記

1.@RenderSection()方法等價於<asp:ContentPlaceHolder />,用途爲在Layout中聲明一個佔位符.

操作:在原來的_MyLayout.cshtml文件中更改內容爲如下:

  1. @{  
  2.     //some code  
  3. }  
  4. <!DOCTYPE html> 
  5.  
  6. <html> 
  7. <head> 
  8.     <title>@ViewBag.Title</title> 
  9. </head> 
  10. <body> 
  11.     <div> 
  12.         開始渲染Body<br /> 
  13.         @RenderBody()  
  14.         渲染Body結束<br /> 
  15.         <br /> 
  16.         開始渲染其他頁<br /> 
  17.         @RenderPage("~/Views/Home/ViewPage1.cshtml")  
  18.         渲染其他頁結束<br /> 
  19.         <br /> 
  20.         HOHO,開始學習Section了<br /> 
  21.         開始渲染Section<br /> 
  22.         聲明方式1(推薦):SectionA:<br /> 
  23.         @RenderSection("SectionA", false)  
  24.         -------<br /> 
  25.           
  26.         聲明方式2:SectionB:<br /> 
  27.         @{  
  28.             if (IsSectionDefined("SectionB"))  
  29.             {  
  30.                 @RenderSection("SectionB")  
  31.             }  
  32.         }  
  33.         -------<br /> 
  34.         渲染Sction結束<br /> 
  35.     </div> 
  36. </body> 
  37. </html> 

在~/Views/Home/Index.cshtml中更改爲如下內容:

  1. @{  
  2.     ViewBag.Title = "首頁";     
  3.     //  
  4.     // some code  
  5.     //  
  6. }  
  7. @section SectionA{  
  8.     <div>這裏是SectionA:也不需要寫神馬runat="server"啊,有木有</div> 
  9. }  
  10. @section SectionB{  
  11.     <div>這裏是SectionB:也不需要寫神馬&lt;asp:Content /&gt啊,有木有</div> 
  12. }  
  13. <div> 
  14.     這裏就是渲染Body啦.~~不需要寫神馬&lt;asp:Content /&gt;,其實因爲RenderBody()不在有歧義.  
  15. </div> 

最後顯示的頁面效果:

 

問:爲什麼爲什麼要推薦方式1呢?
答:因爲RenderSection()方法有2個重載.

如果使用第一個只接受一個string類型參數的重載的話.~如果你在具體的View中沒有利用@section來定義實現的話,運行會報錯.所以需要配合另外一個方法IsSectionDefined()來使用,才能防止報錯.

而使用第2個重載就可以利用第二個bool類型的參數指明該Section是否爲必須的.所以可以在使用該RenderSection方法的時候直接利用第二個重載,再把bool參數值設爲false,即使你在具體的View中沒有聲明實現@section,運行起來也一如既往地蛋定,不Show黃頁.

IV:關於前篇文章中有熱心的觀衆朋友們問到如何在Layout(MasterPage)中讀取數據庫並初始化頁面的問題的解答

在這裏只是做個一簡單的示範,新建一個類文件,替換如下:

  1. using System;  
  2. using System.Collections.Generic;  
  3. using System.Linq;  
  4. using System.Web;  
  5. using System.Data;  
  6. using System.Data.SqlClient; //在這裏就用ADO.NET方式吧.EF我接觸不久!  
  7.  
  8. namespace Mvc3Application1  
  9. {  
  10.     public class ReaderSQL_Date  
  11.     {  
  12.         private static readonly string _SQL_CONN_STR = "server=.\\mssqlserver,1433;uid=sa;pwd=yourpwd;database=student;";  
  13.  
  14.         public static IList<StudentEntity> GetAllStudent()  
  15.         {  
  16.             //這裏僅僅是做演示,生產環境並不這樣寫  
  17.             using (SqlConnection conn = new SqlConnection(_SQL_CONN_STR))  
  18.             {  
  19.                 SqlCommand cmd = conn.CreateCommand();  
  20.                 cmd.CommandType = CommandType.Text;  
  21.                 cmd.CommandText = "SELECT [Sno],[Sname],[Sage] FROM [dbo].[STUDENT]";  
  22.  
  23.                 IList<StudentEntity> result = new List<StudentEntity>();  
  24.                 conn.Open();  
  25.                 using (SqlDataReader sdr = cmd.ExecuteReader())  
  26.                 {  
  27.                     while (sdr.Read())  
  28.                     {  
  29.                         result.Add(new StudentEntity  
  30.                         {  
  31.                             S_No = sdr.GetInt32(0),  
  32.                             S_Name = sdr.GetString(1),  
  33.                             S_Age = sdr.GetInt32(2)  
  34.                         });  
  35.                     }  
  36.                 }  
  37.                 //SqlConnection.ClearPool(conn); //可選清理連接池.  
  38.  
  39.                 return result;  
  40.             }  
  41.         }  
  42.     }  
  43.  
  44.     public class StudentEntity  
  45.     {  
  46.         public int S_No { getset; }  
  47.         public string S_Name { getset; }  
  48.         public int S_Age { getset; }  
  49.     }  

_MyLayout.cshtml替換如下:

  1. @{  
  2.     IList<Mvc3Application1.StudentEntity> studentEntities = Mvc3Application1.ReaderSQL_Date.GetAllStudent();  
  3. }  
  4. <!DOCTYPE html> 
  5.  
  6. <html> 
  7. <head> 
  8.     <title>@ViewBag.Title</title> 
  9. </head> 
  10. <body> 
  11.     <div> 
  12.  
  13.         @{  
  14.             <table> 
  15.                 <tr> 
  16.                     <th>學號</th> 
  17.                     <th>姓名</th> 
  18.                     <th>年齡</th> 
  19.                 </tr> 
  20.                 @foreach (Mvc3Application1.StudentEntity item in studentEntities)  
  21.                 {  
  22.                     <tr> 
  23.                         <td>@item.S_No</td> 
  24.                         <td>@item.S_Name</td> 
  25.                         <td>@item.S_Age</td> 
  26.                     </tr> 
  27.                 }  
  28.             </table> 
  29.         }  
  30.  
  31.         開始渲染Body<br /> 
  32.         @RenderBody()  
  33.         渲染Body結束<br /> 
  34.         <br /> 
  35.         開始渲染其他頁<br /> 
  36.         @RenderPage("~/Views/Home/ViewPage1.cshtml")  
  37.         渲染其他頁結束<br /> 
  38.         <br /> 
  39.         HOHO,開始學習Section了<br /> 
  40.         開始渲染Section<br /> 
  41.         聲明方式1(推薦):SectionA:<br /> 
  42.         @RenderSection("SectionA", false)  
  43.         -------<br /> 
  44.           
  45.         聲明方式2:SectionB:<br /> 
  46.         @{  
  47.             if (IsSectionDefined("SectionB"))  
  48.             {  
  49.                 @RenderSection("SectionB")  
  50.             }  
  51.         }  
  52.         -------<br /> 
  53.         渲染Sction結束<br /> 
  54.     </div> 
  55. </body> 
  56. </html> 

最終顯示:

原文鏈接:http://www.cnblogs.com/highend/archive/2011/04/18/asp_net_mvc3_layout.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章