ASP.NET MVC：多模板支持

原文 http://www.cnblogs.com/happyframework/p/3224278.html

背景

准备写个博客练习一下WEB编程，有一个需求就是多模板支持，类似博客园的自定义模板一样，在ASP.NET MVC中如何处理这个需求呢？

需求

描述

允许自定义模板，比如：传统模板、Metro模板等

模板结构

实现思路1

重写模板引擎的默认搜索路径

         private void SetTemplate(string template)
         {
             var razorViewEngine = ViewEngines.Engines.First(x => x is RazorViewEngine) as RazorViewEngine;

             razorViewEngine.ViewLocationFormats = razorViewEngine.ViewLocationFormats.Select(x =>
             {
                 return x.Replace("~/Views", string.Format("~/Views/Front/Templates/{0}", template));
             }).ToArray();
             razorViewEngine.MasterLocationFormats = razorViewEngine.ViewLocationFormats.Select(x =>
             {
                 return x.Replace("~/Views", string.Format("~/Views/Front/Templates/{0}", template));
             }).ToArray();
             razorViewEngine.PartialViewLocationFormats = razorViewEngine.ViewLocationFormats.Select(x =>
             {
                 return x.Replace("~/Views", string.Format("~/Views/Front/Templates/{0}", template));
             }).ToArray();
         }

分析

这回导致全局的修改，或者应该增加一个搜索路径（这里就不测试了），因为有些视图是不用多模板支持的，因此这种方式不太适合。

实现思路2

为VIewResult指定路径

         public ActionResult Index(string template = "Classic")
         {
             return this.View("~/Views/Front/Templates/" + template + "/Home/Index.cshtml");
         }

分析

这种非常灵活，符合需要，但是代码看起来不够漂亮，好在MVC非常灵活，可以用Filter机制帮我们处理。

实现思路3

Filter机制

 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
 using System.Web.Mvc;
 using System.Threading;

 using Happy.Bootstrap;

 namespace Happy.Web.Mvc.Template
 {
     /// <summary>
     /// 模板相关。
     /// </summary>
     public sealed class TemplateRelevantAttribute : ActionFilterAttribute
     {
         /// <inheritdoc />
         public override void OnResultExecuting(ResultExecutingContext filterContext)
         {
             var viewResult = filterContext.Result as ViewResult;
             if (viewResult != null)
             {
                 var currentUserTemplate = this.GetCurrentUserTemplate();
                 var template = string.IsNullOrEmpty(currentUserTemplate) ? TemplateService.DefaultTemplateName : currentUserTemplate;
                 var controller = filterContext.RequestContext.RouteData.Values["Controller"].ToString();
                 var action = filterContext.RequestContext.RouteData.Values["Action"].ToString();

                 if (string.IsNullOrWhiteSpace(viewResult.ViewName))
                 {
                     viewResult.ViewName = string.Format(
                         "~/Views/{0}/{1}/{2}/{3}.{4}",
                         TemplateService.TemplateDirectoryName,
                         template,
                         controller,
                         action,
                         TemplateService.TemplateFileExtension);

                     return;
                 }
             }

             base.OnResultExecuting(filterContext);
         }

         private string GetCurrentUserTemplate()
         {
             return TemplateService.Current.GetTemplate(Thread.CurrentPrincipal.Identity.Name);
         }
     }
 }

 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;

 using Happy.Infrastructure.ExtentionMethods;

 namespace Happy.Web.Mvc.Template
 {
     /// <summary>
     /// 获取或访问<see cref="ITemplateService"/>实例的唯一入口。
     /// </summary>
     public static class TemplateService
     {
         private static readonly EmptyTemplateService _DefaultCommandService = new EmptyTemplateService();

         private static TemplateServiceProvider currentProvider = () => _DefaultCommandService;

         static TemplateService()
         {
             TemplateDirectoryName = "Templates";
             DefaultTemplateName = "Default";
             TemplateFileExtension = "cshtml";
         }

         /// <summary>
         /// 获取当前应用程序正在使用的模板服务。
         /// </summary>
         public static ITemplateService Current
         {
             get { return currentProvider(); }
         }

         /// <summary>
         /// 设置当前应用程序正在使用的模板服务提供者。
         /// </summary>
         public static void SetProvider(TemplateServiceProvider provider)
         {
             provider.MustNotNull("provider");

             currentProvider = provider;
         }

         /// <summary>
         /// 模板路径。
         /// </summary>
         public static string TemplateDirectoryName { get; set; }

         /// <summary>
         /// 默认模板。
         /// </summary>
         public static string DefaultTemplateName { get; set; }

         /// <summary>
         /// 默认模板。
         /// </summary>
         public static string TemplateFileExtension { get; set; }
     }
 }

分析

采用FIlter这种AOP机制，让调用代码看起来非常漂亮，最终就采用这种方式。

测试

代码

 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Web;
 using System.Web.Mvc;

 using Happy.Web.Mvc.Template;

 namespace Happy.MvcExample.Controllers
 {
     [TemplateRelevant]
     public class HomeController : Controller
     {
         //
         // GET: /Home/

         public ActionResult Index()
         {
             return View();
         }

         //
         // GET: /Home/

         public ActionResult ChangeTemplate(string template)
         {
             TemplateService.DefaultTemplateName = template ?? TemplateService.DefaultTemplateName;

             return this.RedirectToAction("Index");
         }
     }
 }

运行效果

备注

ViewResult的ViewName可以是绝对路径，也可以是相对路径，默认的相对路径是相对于Controller目录。