ASP.NET MVC擴展自定義視圖引擎支持多模板&動態換膚skins機制

来源:http://www.cnblogs.com/itliuyang/archive/2017/05/18/6872048.html
-Advertisement-
Play Games

ASP.NET mvc的razor視圖引擎是一個非常好的.NET MVC框架內置的視圖引擎。一般情況我們使用.NET MVC框架為我們提供的這個Razor視圖引擎就足夠了。但是有時我們想在我們的項目支持多模板&skins機制,比如我們可能會有多套的模板,也就是多個View風格,而我們只需要改一下配置 ...


ASP.NET mvc的razor視圖引擎是一個非常好的.NET MVC框架內置的視圖引擎。一般情況我們使用.NET MVC框架為我們提供的這個Razor視圖引擎就足夠了。但是有時我們想在我們的項目支持多模板&skins機制,比如我們可能會有多套的模板,也就是多個View風格,而我們只需要改一下配置文件就可以輕鬆的改變頁面的風格和模板。實現這個功能有兩種方式:

一、使用介面IViewEngine自己完成一個類似Razor視圖引擎的功能。

二、繼承類RazorViewEngine類,重寫它的一些方法達到自定義視圖引擎的目的。

顯然方法二是最簡單的,因此我們選最簡單方式實現這個功能。

1、首先,我們定義一個一些基礎的輔助類

標示支持Skin特性類:

1 using System;
2 /// <summary>
3 /// 用於標示支持Skin換膚的特性
4 /// </summary>
5 public class SupportSkinAttribute : Attribute
6 {
7     
8 }

風格配置結點讀取類:

 1 using System;
 2 using System.Configuration;
 3 using System.Web;
 4  
 5 public class Utils
 6 {
 7     private static string _skinName;
 8  
 9     public static string SkinName
10     {
11         get
12         {
13             if (!string.IsNullOrEmpty(_skinName))
14             {
15                 return _skinName;
16             }
17             //模板風格
18             _skinName = ConfigurationManager.AppSettings["Skin"];
19             return _skinName;
20         }
21     }
22 }

Helper類:

 1 public class CustomViewEngineHelper
 2 {
 3     internal static string[] AddNewLocationFormats(IEnumerable<string> defaultLocationFormats,IEnumerable<string> newLocationFormats)
 4     {
 5         List<string> allItems = new List<string>(newLocationFormats);
 6         foreach (string s in defaultLocationFormats)
 7         {
 8             allItems.Add(s);
 9         }
10  
11         return allItems.ToArray();
12     }
13  
14  
15     internal static string OverrideMasterPage(string masterName, ControllerContext controllerContext)
16     {
17         if (NeedChangeMasterPage(controllerContext))
18         {
19             masterName = Utils.SkinName;
20         }
21  
22         return masterName;
23     }
24  
25     private static bool NeedChangeMasterPage(ControllerContext context)
26     {
27         SupportSkinAttribute attr = Attribute.GetCustomAttribute(context.Controller.GetType(), typeof (SupportSkinAttribute)) as SupportSkinAttribute;
28         return null != attr;
29     }
30 }

2、然後,定義CustomRazorViewEngine類

CustomRazorViewEngine.cs:

 1 public class CustomRazorViewEngine : RazorViewEngine
 2 {
 3     public CustomRazorViewEngine()
 4     {
 5         string[] mastersLocation = new[]{string.Format("~/skins/{0}/views/{0}.cshtml", Utils.SkinName)};
 6         MasterLocationFormats = CustomViewEngineHelper.AddNewLocationFormats(
 7             new List<string>(MasterLocationFormats),
 8             mastersLocation);
 9  
10         string[] viewsLocation = new[]{ string.Format("~/skins/{0}/Views/{{1}}/{{0}}.cshtml",Utils.SkinName)};
11         //視圖文件位置路徑的格式
12         ViewLocationFormats =
13             PartialViewLocationFormats =
14             CustomViewEngineHelper.AddNewLocationFormats(new List<string>(ViewLocationFormats), viewsLocation);
15     }
16  
17     //查找視圖文件
18     public override ViewEngineResult FindView(ControllerContext controllerContext,string viewName,string masterName,bool useCache)
19     {
20         masterName = CustomViewEngineHelper.OverrideMasterPage(masterName,controllerContext);
21         return base.FindView(controllerContext,viewName, masterName,useCache);
22     }
23 }

上面代碼是最核心的部分,我們在CustomRazorViewEngine類構造函數中就按照我們自定約定規則重寫了MasterLocationFormats(~/skins/{0}/views/{0}.cshtml)和ViewLocationFormats(~/skins/{0}/Views/{{1}}/{{0}}.cshtml)屬性,最後在FindView方法中重寫了master的文件名。

如果風格名為lanhu,將按照以下的規則來創建視圖文件:

1、MasterLocationFormats(Layout)路徑為:~/skins/lanhu/views/lanhu.cshtml

2、ViewLocationFormats(視圖文件)路徑為:~/skins/lanhu/Views/{1}/{0}.cshtml,其中{1}和{0}分別表示Controller和Action的名字。

3、最後,註冊CustomRazorViewEngine

最後,在Appication_Start中加入下麵的代碼,使用CustomRazorViewEngine生效

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

上面第一行是清除預設的視圖引擎,接下來把我們自定義的CustomRazorViewEngine註冊到MVC框架中使用其生效。

使用CustomRazorViewEngine提供的多模板&skins換膚機制,要在Controller類前面加上特性SupportSkin,如下代碼:

1 [SupportSkin]
2 public class HomeController
3 {
4       //省略其它代碼
5 }

這樣ASP.NET MVC視圖引擎就支持多模板&skins換膚機制了,我們只需要增加一個風格,在skins文件夾中創建自己的風格的文件夾,並添加相應的視圖。最後,在把Web.config的配置結點名為Skin的值改成,相應的風格名稱(即skins文件夾的文件夾名),我們以後想換模板就是分分鐘的事。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 1. 先去官網下載一個安裝包 ,假設目錄/APP/ido 2. cd /APP/ido 3. tar -zxvf git-2.7.2.tar.gz 4. 安裝依賴 yum -y install gcc openssl openssl-devel curl curl-devel unzip perl ...
  • #code:utf-8 import smtplib from email.mime.text import MIMEText from email.mime.multipart import MIMEMultipart from email.header import Header smtpser ...
  • Samba起源: 早期網路想要在不同主機之間共用文件大多要用FTP協議來傳輸,但FTP協議僅能做到傳輸文件卻不能直接修改對方主機的資料數據,這樣確實不太方便,於是便出現了NFS開源文件共用程式:NFS(NetworkFile System)是一個能夠將多台Linux的遠程主機數據掛載到本地目錄的服務 ...
  • 首先在linux伺服器上安裝ftp [root@host2 test]#yum -y install ftp vsftpd [root@host2 test]#service vsftpd start [root@host2 test]#chkconfig vsftpd --list [root@h ...
  • 7.1 常量 常量 是值從不變化的符號。定義常量符號時,它的值必須能夠在編譯時確定。 只能定義編譯器識別的基元類型的常量,如果是非基元類型,需把值設為null。 常量的值直接嵌入代碼,所以不能獲取常量地址,不能以傳引用的方式傳遞常量。 不能很好地支持跨程式集的版本控制(修改一個DLL中的常量值,需要 ...
  • 怎麼將XML字元串轉換為XmlDocument,並獲取部分節點值??? 總結關鍵知識點: 1-如何將XML字元串轉換為XmlDocdument:   XmlDocument xmlDocument = new XmlDocument();   xmlDocument.LoadXml(xmlSt... ...
  • ASP.NET mvc的最好的優點之一就是支持Model驗證,這個特性很方便你可以選擇在定義Model的時候在欄位中採用特性進行註解約定,也可以在代碼中自己進行手動驗證。下麵就來細說一下ASP.NET MVC Model驗證多種方式的實現。 一、瞭解什麼是ASP.NET MVC Model驗證 首先 ...
  • 前言 目前 EF Core 的最新版本為 ,所以本篇文章主要是針對此版本的一些說明。 註意:如果你要在Visual Studio 中使用 .NET Core 2.0 , 你需要至少 Visual Studio 2017 15.3 預覽版本。 安裝或升級到 EF Core 2.0 你可以通過以下命令來 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...