在ASP
NET MVC的一個開源項目MvcContrib中
為我們提供了幾個視圖引擎
例如NVelocity
Brail
NHaml
XSLT
那麼如果我們想在ASP
NET MVC中實現我們自己的一個視圖引擎
我們應該要怎麼做呢？
我們知道呈現視圖是在Controller中通過傳遞視圖名和數據到RenderView()方法來實現的好我們就從這裡下手我們查看一下ASPNET MVC的源代碼看看RenderView()這個方法是如何實現的
protected virtual void RenderView(string viewName string
masterName object viewData) {
ViewContext viewContext = new ViewContext(
ControllerContext viewName masterName viewData TempData);
ViewEngineRenderView(viewContext);
}//
這是P的源碼P略有不同原理差不多從上面的代碼我們可以看到Controller中的RenderView()方法主要是將ControllerContext viewName masterName viewData TempData這一堆東西封裝成ViewContext然後把ViewContext傳遞給ViewEngineRenderView(viewContext)嗯沒錯我們這裡要實現的就是ViewEngine的RenderView()方法
ASPNET MVC為我們提供了一個默認的視圖引擎這個視圖引擎叫做WebFormsViewEngine 從名字就可以看出這個視圖引擎是使用ASPNET web forms來呈現的在這裡我們要實現的視圖引擎所使用的模板用HTML文件吧簡單的模板示例代碼如下
＜!DOCTYPE html PUBLIC //WC//DTD XHTML Transitional//EN
transitionaldtd＞
＜html xmlns=>
＞
＜head＞
＜title＞自定義視圖引擎示例＜/title＞
＜/head＞
＜body＞
＜h＞{$ViewDataTitle}＜/h＞
＜p＞{$ViewDataMessage}＜/p＞
＜p＞The following fruit is part of a string array: {$ViewDataFruitStrings[]}＜/p＞
＜p＞The following fruit is part of an object array: {$ViewDataFruitObjects[]Name}＜/p＞
＜p＞Heres an undefined variable: {$UNDEFINED}＜/p＞
＜/body＞
＜ ml＞
下面馬上開始我們的實現首先毫無疑問的我們要創建一個ViewEngine就命名為 SimpleViewEngine 吧注意哦ViewEngine要實現IViewEngine接口
public class SimpleViewEngine : IViewEngine
{
#region Private members
IViewLocator _viewLocator = null;
#endregion
#region IViewEngine Members : RenderView()
public void RenderView(ViewContext viewContext)
{
string viewLocation = ViewLocatorGetViewLocation
(viewContext viewContextViewName);
if (stringIsNullOrEmpty(viewLocation))
{
throw new InvalidOperationException(stringFormat
(View {} could not be found
viewContextViewName));
}
string viewPath = viewContextHttpContextRequestMapPath(viewLocation);
string viewTemplate = FileReadAllText(viewPath);
//以下為模板解析
IRenderer renderer = new PrintRenderer();
viewTemplate = rendererRender(viewTemplate viewContext);
viewContextHttpContextResponseWrite(viewTemplate);
}
#endregion
#region Public properties : ViewLocator
public IViewLocator ViewLocator
{
get
{
if (this_viewLocator == null)
{
this_viewLocator = new SimpleViewLocator();
}
return this_viewLocator;
}
set
{
this_viewLocator = value;
}
}
#endregion
}
在這裡實現了IViewEngine接口提供的RenderView()方法這裡要提供一個ViewLocator的屬性ViewLocator的主要就是根據控制器中傳來的視圖名進行視圖的定位
在RenderView()方法中首先獲取視圖的路徑然後把視圖模板讀進來最後進行模板的解析然後輸出
我們再來看一下ViewLocator是如何實現的他是IViewLocator類型的也就是說SimpleViewLocator實現了IViewLocator接口SimpleViewLocator的實現代碼如下
public class SimpleViewLocator : ViewLocator
{
public SimpleViewLocator()
{
baseViewLocationFormats = new string[] { ~ iews/{}/{
~ iews/{}/{l
~ iews d/{
~ iews d/{l
};
baseMasterLocationFormats = new string[] { };
}
}
我們的SimpleViewLocator 是繼承自ASPNET MVC的ViewLocator類而ViewLocator則是實現了IViewLocator接口的由於ViewLocator已經為了完成了全部的工作這裡我們只需修改下他的ViewLocationFormats 來使用我們自己的模板文件就可以了
我們再來看一下類圖那就更加清楚了
注關於模板解析的部分代碼這裡就不說了不在討論范圍內可以自己下載代碼來看
現在我們基本完成了我們的視圖引擎那麼如何讓ASPNET MVC不要使用默認的web forms視圖引擎而使用我們自定義的視圖引擎呢？
在ASPNET MVC中所有的請求都是通過一個工廠類來創建Controller實例的這個工廠類必須實現IControllerFactory 接口默認的實現該接口的工廠類是DefaultControllerFactory這個工廠類就是我們修改默認的視圖引擎為我們的視圖引擎的入口點為了方便我們創建一個繼承自DefaultControllerFactory的SimpleControllerFactory
public class SimpleControllerFactory : DefaultControllerFactory
{
protected override IController CreateController(RequestContext
requestContext string controllerName)
{
Controller controller = (Controller)baseCreateController
(requestContext controllerName);
controllerViewEngine = new SimpleViewEngine();
//修改默認的視圖引擎為我們剛才創建的視圖引擎
return controller;
}
}
這裡只要修改controllerViewEngine為
我們自定義的ViewEngine就可以了最終的類圖大概如下
要使我們創建的控制器工廠類SimpleControllerFactory 成為默認的控制器工廠類我們必須在Globalasaxcs中的Application_Start 事件中添加如下代碼ControllerBuilderCurrentSetControllerFactory(typeof(SimpleControllerFactory));
到這裡我們已經完成了我們自己的視圖引擎
在ASPNET MVC中實現自定義的視圖引擎是很簡單的難點在於模板的解析具體大家可以研究MvcContrib中的四個視圖引擎的代碼最近要對模板引擎進行研究大家有什麼其他優秀的成熟的開源的模板引擎麻煩給小弟推薦一下先謝了
From:http://tw.wingwit.com/Article/program/net/201311/11877.html
