由淺入深：自己動手開發模板引擎——置換型模板引擎（三）

受到群里兄弟們的竭力邀請，老陳終於決定來分享一下.NET下的模板引擎開發技術。本系列文章將會帶您由淺入深的全面認識模板引擎的概念、設計、分析和實戰應用，一步一步的帶您開發出完全屬於自己的模板引擎。關於模板引擎的概念，我去年在百度百科上錄入了自己的解釋（請參考：模板引擎）。老陳曾經自己開發了一套網鳥Asp.Net模板引擎，雖然我自己並不樂意去推廣它，但這已經無法阻擋群友的喜愛了！

在上一篇我們以簡單明快的方式介紹了置換型模版引擎的關鍵技術——模板標記的流式解析。采用流式解析可以達到相當好的解析性能，因為它基本上只需要對字符串（模板）掃描一次就可以完成所有代碼的解析。不像String.Split()和正則表達式那樣會造成很多迭代效應。今天我們引入一個較為復雜的示例，然后封裝一個實用級別的模板引擎。封裝就意味着使用者無需了解內部如何實現，只需要知道如何引用即可（為了降低門檻，本文沒有進行高級封裝和重構，這些內容在下一篇文章中放出）。

概述

題外話：在某公司入職之后，我曾經非常抱怨其CRM系統代碼架構的糟糕程度，其中比較重要的一點是不倫不類的面向對象/過程的編碼以及各種無法重用或無意重用的代碼。一位同事便向我請教，如何編寫面向對象的應用程序呢？實際上面向對象首先是一種深度思維的結果，方法就只有一個：把一切都當作對象！

回到我們今天的話題，想做好面向對象的設計，首先要明確一下我們要做什么——我們要做的是一個模板引擎。它應當能夠解析一些模板代碼，然后根據外部業務數據生成我們期望的結果。當不關心如何實現這些需求的時候，可以先定義一個接口（暫時不要關心這個接口定義是否合理，否則哪里來的重構？）：

/// <summary>
/// 定義模板引擎的基本功能。
/// </summary>
public interface ITemplateEngine
{
    /// <summary>
/// 解析模板。
/// </summary>
/// <param name="templateString">包含模板內容的字符串。</param>
    void Parser(string templateString);

    /// <summary>
/// 設定變量標記的值。
/// </summary>
/// <param name="key">鍵名。</param>
/// <param name="value">值。</param>
    void SetValue(string key, object value);

    /// <summary>
/// 處理模板並輸出結果。
/// </summary>
/// <returns>返回包含業務數據的字符串。</returns>
    string Process();
}

定義了模板引擎的基本功能，我們就試着實現一下。為了讓大家接觸到更多的流式解析技巧，本例對上一篇文章中的標記語法做了更改，使其更為復雜。如果您仔細觀察上面的接口定義，會發現SetValue()方法的value參數被定義為object。我們的目標是滿足如下需求：

[TestFixture]
public sealed class TemplateEngineUnitTests
{
    private const string _templateString = "[<time>{CreationTime:yyyy年MM月dd日 HH:mm:ss}</time>] <a href=\"{url}\">{title}</a>";
    private const string _html = "[<time>2012年04月03日 16:30:24</time>] <a href=\"http://www.ymind.net/\">陳彥銘的博客</a>";

    [Test]
    public void ProcessTest()
    {
        var templateEngine = new TemplateEngine();
        templateEngine.Parser(_templateString);
        templateEngine.SetValue("url", "http://www.ymind.net/");
        templateEngine.SetValue("title", "陳彥銘的博客");
        templateEngine.SetValue("CreationTime", new DateTime(2012, 4, 3, 16, 30, 24));

        var html = templateEngine.Process();

        Trace.WriteLine(html);

        Assert.AreEqual(html, _html);
    }
}

有經驗的朋友可能已經發現了，這不是個單元測試么？是的，在這里老陳使用了測試驅動開發的思路（我會盡量的在我的博文中給大家分享各方面的經驗技巧，這才是傳說中的干貨！）。測試驅動開發有什么好處？很顯然，有了單元測試代碼，我們就很明確的知道我們要做什么了，而且單元測試本身就是一個demo。你還需要文檔嗎？文檔在很多時候並不是必要的，但在某些時候又是非要不可的，要區別對待。

奔着這個單元測試代碼，我們基本可以明確今天的學習內容：

1. 標記格式和上一課一樣，都是“{label}”；
2. 今天加強的是允許對某些變量自定義格式化字符串，這里以日期類型為舉例。聰明的你一定想到了，就是在輸出Token流的時候需要有一段類似於dateTime.ToString("yyyy年MM月dd日 HH:mm:ss") 的代碼。
3. 由於增加了一個格式化參數的語法，在“{label}”內部又需要將format字符串分離出來，因此解析的難度加大。

模板解析

根據上一節課的內容，我們首先來分析一下解析過程中所需要使用的狀態：

/// <summary>
/// 表示詞法分析模式的枚舉值。
/// </summary>
/// <remarks>記得上次我們的命名是PaserMode么？今天我們換個更加專業的單詞。</remarks>
public enum LexerMode
{
    /// <summary>
/// 未定義狀態。
/// </summary>
    None = 0,

    /// <summary>
/// 進入標簽。
/// </summary>
    EnterLabel,

    /// <summary>
/// 脫離標簽。
/// </summary>
    LeaveLabel,

    /// <summary>
/// 進入格式化字符串。
/// </summary>
    EnterFormatString,

    /// <summary>
/// 脫離格式化字符串。
/// </summary>
    LeaveFormatString,
}

請注意，每個模式都是成對出現的，因為流式解析總會是有始有終的！哪怕某些開始和結束在物理上是重合的。但是Enter和Leave這兩個動作總是在描述同樣一件事物，我們就可以縮減對象類型（這里是指詞法分析模式），優化后定義如下：

/// <summary>
/// 表示詞法分析模式的枚舉值。
/// </summary>
/// <remarks>記得上次我們的命名是PaserMode么？今天我們換個更加專業的單詞。</remarks>
public enum LexerMode
{
    /// <summary>
/// 未定義狀態。
/// </summary>
    Text = 0,

    /// <summary>
/// 進入標簽。
/// </summary>
    Label = 1,

    /// <summary>
/// 進入格式化字符串。
/// </summary>
    FormatString = 2,
}

不過我們今天要強化的可不只是增加了一個格式化字符串這么簡單，我們還要能夠明確的了解到每個Token的位置信息和類型，這是我們下一節講解解釋型模版引擎時所需要用到的概念。Token在上一節中我們僅僅使用了一個string類型來表示，但這個滿足不了我們的需要了，我們需要自定義一個Token類型，如下：

/// <summary>
/// 表示一個 Token。
/// </summary>
public sealed class Token
{
    /// <summary>
/// 初始化 <see cref="Token"/> 對象。
/// </summary>
/// <param name="kind"><see cref="TokenKind"/> 的枚舉值之一。</param>
/// <param name="text">Token 文本。</param>
/// <param name="line">Token 所在的行。</param>
/// <param name="column">Token 所在的列。</param>
    public Token(TokenKind kind, string text, int line, int column)
    {
        this.Text = text;
        this.Kind = kind;
        this.Column = column;
        this.Line = line;
    }

    /// <summary>
/// 獲取 Token 所在的列。
/// </summary>
    public int Column { get; private set; }

    /// <summary>
/// 獲取 Token 所在的行。
/// </summary>
    public int Line { get; private set; }

    /// <summary>
/// 獲取 Token 類型。
/// </summary>
    public TokenKind Kind { get; private set; }

    /// <summary>
/// 獲取 Token 文本。
/// </summary>
    public string Text { get; private set; }
}

我們使用行數、列數、類型和文本（內容）來共同描述一個Token，這下可豐富多彩了！TokenKind明顯應該是個枚舉值，根據本例，TokenKind的定義如下：

/// <summary>
/// 表示 Token 類型的枚舉值。
/// </summary>
public enum TokenKind
{
    /// <summary>
    /// 未指定類型。
    /// </summary>
    None = 0,

    /// <summary>
    /// 左大括號。
    /// </summary>
    LeftBracket = 1,

    /// <summary>
    /// 右大括號。
    /// </summary>
    RightBracket = 2,

    /// <summary>
    /// 普通文本。
    /// </summary>
    Text = 3,

    /// <summary>
    /// 標簽。
    /// </summary>
    Label = 4,

    /// <summary>
    /// 格式化字符串前導符號。
    /// </summary>
    FormatStringPreamble = 5,

    /// <summary>
    /// 格式化字符串。
    /// </summary>
    FormatString = 6,
40 }

也就是說本次我們將要面對5種Token（None純粹是為了描述一個空類型）！

在往下看之前請您按照上一課中的方法自行實現一下本節課的需求，1小時之后再回來。

如果您自己推敲過了，可能會發現一個問題，即FormatString是嵌套在Label里面的，這個貌似很難區分啊！是的，本節之所以設計了這么一個需求，就是有了這么一個嵌套Token的解析過程，掌握這個技巧是至關重要的！因此，我希望您不要偷懶，自行先摸索摸索，先不要看后面的答案……

實際上，如果您曾經接觸過編譯原理的話，可能如上的難題根本就不是什么事，因為這是一個司空見慣的問題。這整個就是方法簽名即形式參數的實現，比如：

• Do()
• Do("x")
• Do("x", "y")
• Do("x", y, "z")

很眼熟很常見不是？那么在解析這些代碼的時候，由於模式會嵌套，也就意味着模式會后進先出。后進先出？！你想到了什么？ 對！就是它，不要懷疑！Stack！只不過在泛型稱霸天下的今天，我們當然要選用Stack<T>了！這里我就不再帖出自己的實現代碼了，因為太長了。

變量賦值

變量賦值很簡單，就是使用Dictionary<string, object>：

private readonly Dictionary<string, object> _variables = new Dictionary<string, object>();

/// <summary>
/// 設定變量標記的值。
/// </summary>
/// <param name="key">鍵名。</param>
/// <param name="value">值。</param>
public void SetValue(string key, object value)
{
    // 就這么簡單
    this._variables[key] = value;
}

這一小節沒有任何難度，難道說簡單一點不好么？

數據輸出

在輸出業務數據的時候，唯一的難點就是如何實現自定義格式化字符串，廢話不多說，直接上代碼：

/// <summary>
/// 處理模板並輸出結果。
/// </summary>
/// <returns>返回包含業務數據的字符串。</returns>
public string Process()
{
    var result = new StringBuilder();

    for (var index = 0; index < this._tokens.Count; index++)
    {
        var token = this._tokens[index];

        switch (token.Kind)
        {
            case TokenKind.Label:
                string value;

                // 具體的Token流是：
                // Label                       = CreationTime
                // FormatStringPreamble        = :
                // FormatString                = yyyy年MM月dd日 HH:mm:ss
                // 因此這里減去2個索引值檢查操作范圍
                if (index < this._tokens.Count - 2)
                {
                    // 實現自定義格式化字符串
                    var nextToken = this._tokens[index + 2];

                    if (nextToken.Kind == TokenKind.FormatString)
                    {
                        // 注意這里使用 IFormattable 來驗證目標類型是否實現了格式化功能
                        var obj = this._variables[token.Text] as IFormattable;

                        value = obj == null ? this._variables[token.Text].ToString() : obj.ToString(nextToken.Text, null);
                    }
                    else value = this._variables[token.Text].ToString();
                }
                else value = this._variables[token.Text].ToString();

                result.Append(value);
                break;

            case TokenKind.Text:
                result.Append(token.Text);
                break;
        }
    }

    return result.ToString();
}

總結及代碼下載

與上一課相比，本課的內容跨度較大，但學習和理解的難度尚且不是很大。我們下一節課將會對本節代碼進行重構封裝，看看重構能給我們帶來什么驚喜！

代碼下載：置換型模板引擎(3).zip

---

下集預報：本課的代碼為了讓新手容易理解所以沒有做高度封裝，下一篇博文將會對本次的代碼執行一次高度封裝，代碼理解的難度較大，將會獨立出一個詞法分析器類、模板實體類等，充分的面向對象設計。