DIV CSS 佈局教程網

在獨立 JS 檔案中使用 Razor:RazorJS 類庫介紹
編輯:關於JavaScript     

在 View 裡搭配 JavaScript 是很常見的做法,此時可以直接寫入 Razor 語法來呼叫 .NET 的方法:

<script>
var currDate = '@DateTime.Now'; // 直接呼叫 .NET 方法
console.log(currDate)
</script>

但如果想把同樣的邏輯搬到一個獨立的 .js 檔案裡,這招就行不通了——MVC 的視圖引擎只解析 Razor view,不會去編譯 .js 檔。要在外部檔案中如願,可以借助一個開源的第三方類庫。

RazorJS

專案名稱就叫 RazorJS,原始碼託管在 Bitbucket:

https://bitbucket.org/djsolid/razorjs

也可以直接用 NuGet 安裝,這是我推薦的方式:

PM> Install-Package RazorJS

它能做什麼

安裝之後,就能在 .js 檔案裡使用所有 .NET 支援的方法,開頭那段程式碼原封不動搬進外部檔案也能跑。此外還可以引入 .NET 的命名空間,例如要讀取文字檔內容時直接 using System.IO:

@using System.IO;
var s = 'Hello at @DateTime.Now \n @File.ReadAllText(System.Web.Hosting.HostingEnvironment.MapPath("~/web.config"))';

執行後就能在 JavaScript 裡取得 web.config 的全部內容。

背後的原理

它並不是自己發明了一套機制,而是藉助名為 RazorEngine 的類庫。RazorEngine 是一個獨立的 Razor 解析引擎,能力相當完整,甚至可以讓你在 WinForm 中直接使用 Razor 語法。

這其實是個很有價值的能力:完全脫離 web 環境去使用 Razor,就能靈活地製作各類範本。舉例來說,寄送通知信的信件範本可以直接寫上 .NET 方法甚至自有的物件,再由程式動態帶入資料產生內容,不必再手忙腳亂地拼字串。這不是本文重點,但值得一記。

使用方式

若透過 NuGet 安裝,web.config 會自動設定妥當,這也是建議用 NuGet 的原因;手動組裝則需自行補上好幾處設定,安裝完成後比對一下差異即可理解。

引用時只需一行語法:

<p>
    @Html.RazorJSInline("~/Scripts/Example.js")
</p>

但要注意,web.config 裡有一段白名單設定,只有放在指定目錄下的 JS 檔才能用這方式引用:

<razorJSSettings handlerPath="~/razorjs.axd">
  <allowedPaths>
    <add path="~/Scripts" />
  </allowedPaths>
</razorJSSettings>

兩個限制

第一,不能用 HTML Helper。因為底層是 RazorEngine 而非完整的 MVC 引擎,所有以 @Html 開頭的方法都無法使用。

第二,註解裡的程式碼一樣會被執行。這點特別容易中埋伏。RazorJS 不做 JS 語法層級的解析,因此你把某段 .NET 呼叫用 // 或 /* */ 註解掉,它照樣會被編譯執行;一旦那段程式碼有誤,整個 JS 就會中斷並丟出錯誤。別以為「註解掉就沒事了」。

想繞過 @Html 限制的話

這就得改原始碼了,喜歡折騰的可以試試。把 RazorJS 的原始碼直接當成另一個專案加入自己的方案中,或自行修改後重新編譯出 DLL 皆可。

開啟 HtmlTemplateBase.cs,在此加入的方法都能在 JS 中直接呼叫。原始碼裡已封裝了一個 Href 方法,用來把相對路徑轉為用戶端可用的 URL。依同樣思路,就能補上自己需要的方法。以下示範一個動態取得多語系資源字串的做法:

public class HtmlTemplateBase : TemplateBase
{
    // 手工取得資源檔的 ResourceManager
    private static ResourceManager resources =
        (ResourceManager)System.Type.GetType("RazorJS.Resource")
            .GetProperty("ResourceManager").GetValue(null, null);

    public HtmlTemplateBase()
    {
        Url = new UrlHelper(HttpContext.Current.Request.RequestContext);
    }

    public string Href(string originalUrl)
    {
        return Extensions.ResolveUrl(originalUrl);
    }

    public string GetLangText(string langKey)
    {
        // 依 key 回傳對應語系字串
        return resources.GetString(langKey);
    }

    public UrlHelper Url { get; set; }
}

之後在 JS 裡就能直接取值:

var s = '@GetLangText("CoderBlog")';
console.log(s);

執行後,畫面上輸出的就是 CoderBlog 這個 key 所對應的翻譯文字。如此一來,多語系的前端訊息也能與後端共用同一份資源檔,維護成本明顯下降。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved