ASP.NET MVC 2自定义视图引擎

超、凢脫俗 2022-06-18 08:52 144阅读 0赞

在ASP.NET MVC2中，视图引擎的职责是根据参数选择并创建视图对象，视图引擎不负责视图内容的生成工作，视图内容的生成工作由视图对象来完成。  
　　在ASP.NET MVC2中，默认情况下，创建自定义的视图引擎需要实现IViewEngine接口（该接口声明在System.Web.Mvc命名空间中）。该接口声明了三个方法，具体代码如下：

![复制代码][copycode.gif]

1 
       
        public
       
         
       
        interface
       
         IViewEngine
    
       
         2 
       
        {
         
    
       
         3 
       
            ViewEngineResult FindPartialView(
    
       
         4 
       
                ControllerContext controllerContext,
    
       
         5 
       
                
       
        string
       
         partialViewName,
    
       
         6 
       
                
       
        bool
       
         useCache);
    
       
         7 
       
        
    
       
         8 
       
            ViewEngineResult FindView(
    
       
         9 
       
                ControllerContext controllerContext,
    
       
        10 
       
                
       
        string
       
         viewName,
    
       
        11 
       
                
       
        string
       
         masterName,
    
       
        12 
       
                
       
        bool
       
         useCache);
    
       
        13 
       
        
    
       
        14 
       
            
       
        void
       
         ReleaseView(
    
       
        15 
       
                ControllerContext controllerContext,
    
       
        16 
       
                IView view);
    
       
        17 
       
        }
    
       
        18

![复制代码][copycode.gif]

一般来说，几乎所有的模版引擎都会使用虚拟路径进行对视图文件的定位，并加载视图。所以如果我们使用IViewEngine的话，我们就还需要编写相应的路径处理代码。  
　　为了方便这种一般的形式，ASP.NET MVC2提供了一个基类VirtualPathProviderViewEngine，封装了一些路径处理程序。  
　　VirtualPathProviderViewEngine类是一个抽象类。该类包含了各种路径的查询模板，可以根据controller和action的值进行查询查应的视图文件。  
　　另外VirtualPathProviderViewEngine类还包含两个用于创建视图的方法，这两个方法是抽像方法，需要我们继承该类的时候实现这两个方法。  
　　使用VirtualPathProviderViewEngine类还有一个好处：它会自动的在生产环境下进行缓存。我们知道视图文件是在硬盘上存着的，而进行访问视图文件的IO操作是很费资源的。使用VirtualPathProviderViewEngine类很简单的解决了这个问题。  
　　总体来说，VirtualPathProviderViewEngine类需要我们关心的类结构声明如下：

![复制代码][copycode.gif]

1 
       
        public
       
         
       
        abstract
       
         
       
        class
       
         VirtualPathProviderViewEngine : IViewEngine
    
       
         2 
       
        {
         
    
       
         3 
       
            
       
        public
       
         
       
        string
       
        [] MasterLocationFormats { 
       
        get
       
        ; 
       
        set
       
        ; }
    
       
         4 
       
            
       
        public
       
         
       
        string
       
        [] PartialViewLocationFormats { 
       
        get
       
        ; 
       
        set
       
        ; }
    
       
         5 
       
            
       
        public
       
         
       
        string
       
        [] ViewLocationFormats { 
       
        get
       
        ; 
       
        set
       
        ; }
    
       
         6 
       
        
    
       
         7 
       
            
       
        protected
       
         
       
        abstract
       
         IView CreatePartialView(
    
       
         8 
       
                ControllerContext controllerContext,
    
       
         9 
       
                
       
        string
       
         partialPath);
    
       
        10 
       
        
    
       
        11 
       
            
       
        protected
       
         
       
        abstract
       
         IView CreateView(
    
       
        12 
       
                ControllerContext controllerContext,
    
       
        13 
       
                
       
        string
       
         viewPath,
    
       
        14 
       
                
       
        string
       
         masterPath);
    
       
        15 
       
        }
    
       
        16

![复制代码][copycode.gif]

也就是说，继承VirtualPathProviderViewEngine类需我们提供各种视图文件路径的查询模板，以及创建视图的方法。在视图文件路径模板中我们可以使用\{0\}、\{1\}的方式分别为Action名称和Controller名称提供占位符。  
　　从上面VirtualPathProviderViewEngine类的结构中我们可以看到，这两个抽像方法需要返回一个实现了IView接口的类的对象。所以，这里我们还要实现一个实现IView接口的自定义的视图对象类。  
　　IView接口的声明如下：

1 
       
        public
       
         
       
        interface
       
         IView
    
       
        2 
       
        {
         
    
       
        3 
       
            
       
        void
       
         Render(ViewContext viewContext, TextWriter writer);
    
       
        4 
       
        }

这里我们只要实现一个Render()方法即可。  
　　Render()方法需要两个参数：viewContext和writer，这个方法的功能是根据viewContext中的数据生成视图内容，把生成的内容写到writer对象中。

全部完成以后我们还要注册我们自定义的视图引擎，方法是在Global.asax文件中的Application\_Start()方法中使用ViewEngines类里的Engines集合来添加我们自定义的视图引擎。当然，在添加之前我们可以先清理掉ASP.NET MVC默认的视图引擎。代码如下：

1 
        
         ViewEngines.Engines.Clear();
    
        
         2 
        
         ViewEngines.Engines.Add(
        
         new
        
          MyViewEngine());

[copycode.gif]: /images/20220618/ec1b7c05cc6d4f70935e18ea9771601e.png