詳解模版引擎XTemplate與代碼生成器XCode(源碼)
模版引擎XTemplate與代碼生成器XCode是本文要介紹的內容,主要是來學習模版引擎XTemplate是一個仿T4設計的引擎,功能上基本與T4一致(模版語法上完全兼容T4,模版頭指令部分兼容)。
自己設計模版引擎,就是為了代碼生成器、網站模版、郵件模版等多種場合,也就是要能拿出來單獨使用、功能強大并且容易控制的。T4是個很好的引擎,但是它的設計基本上傾向于vs,幾乎不顧別的場合。
XTemplate特點如下:
1、完全使用C#作為模版語言。跟ASP、ASP.Net頁面的解析一樣,把<##>標簽外的文本內容當作字符串,用一個StringBuilder,標簽內作為C#原生代碼,拼在一起編譯,進行模版替換時,實質上就是執行編譯后的程序集,這就是XTemplate的核心原理!網絡上現有的許許多多模版引擎,要么采用標簽替換,要么自創模版語言,這些都增加了使用者的學習難度。XTemplate使用C#作為模版語言,這個世界安靜了!
2、支持“調試”。不是運行時調試,而是XTemplate能夠把模版編譯的中間類文件以及程序集等輸出,方便檢查錯誤。如果把模版編譯后的程序集保存下來,可以在沒有模版文件的情況下直接使用模版功能。
3、不需要ASP.Net支持。有部分模版引擎,是模擬一個ASP.Net服務器,然后以ASP.Net作為模版來實現,這就要求有一個ASP.Net服務器作為宿主,限制了模版引擎的使用范圍。
4、支持批量編譯。可以把多個模版放入模版處理器,進行一次編譯(所有模版類都編譯到一個程序集里面去)。
5、支持類成員。模版內容默認情況下將會統一編譯到一個類的Render方法里面去,但是有時候我們需要給這個類增加一些屬性和方法,此時可以使用<#! #>標簽,序數為單數表示開始,序數為偶數表示結束,所以不限制類成員代碼的位置(T4要求只能寫在模版的***面)。
6、支持自定義基類。默認情況下,所有編譯生成的模版類都繼承自TemplateBase,你也可以創建自己的模版基類,然后在模版頭通過指令,或者通過外部宿主指定自定義的模版基類,模版中可以直接使用自定義模版基類的成員(因為繼承嘛),比如代碼生成器XCode中的XCodeBase。
7、自動引用宿主程序集。T4在使用上***的麻煩就是引用外部程序集和命名空間,畢竟不是在vs里面編寫C#代碼。XTemplate在編譯的時候,自動引用宿主(就是調用者,比如XCode)的所有應用程序集,同時引用大部分常用的明明空間,因為這樣,生成的類很臃腫,但是編譯的時候,編譯器會自動去掉無用的引用。XTemplate從完成到現在為止,還沒有用過引用程序集和命名空間的問題,因為一般來說,模版中需要用到的程序集,宿主里面一般都有用到,非常符合我們的使用習慣。
8、與宿主的良好交互。在XTemplate中,編譯的模版程序集是直接加載在默認域,這點與T4不同,T4會新建一個域,應該是為了防止模版代碼弄臟默認域的數據吧(比如干擾vs運行)。因為在同一個域,XTemplate與宿主進行交互,就不需要“***”(跨域)了。XTemplate的處理過程分為分析、編譯和執行三步,都可以由外部控制,比如有時候我們只是需要檢查一下模版的語法,只需要檢查一下模版語法是否正確,這個時候編譯一下就可以了。
9、更多的特點需要大家來發現!
XCode使用XTemplate代碼(后面有XCode的項目代碼):
- Dictionary<String, Object> data = new Dictionary<string, object>();
- data["Config"] = Config;
- data["Tables"] = Tables;
- data["Table"] = table;
- // 聲明模版引擎
- Template tt = new Template();
- Template.Debug = Config.Debug;
- foreach (String item in ss)
- {
- if (item.EndsWith("scc", StringComparison.Ordinal)) continue;
- String tempFile = item;
- if (!Path.IsPathRooted(tempFile) && !tempFile.StartsWith(TemplatePath, StringComparison.OrdinalIgnoreCase))
- tempFile = Path.Combine(TemplatePath, tempFile);
- String content = File.ReadAllText(tempFile);
- // 添加文件頭
- if (Config.UseHeadTemplate && !String.IsNullOrEmpty(Config.HeadTemplate))
- content = Config.HeadTemplate + content;
- tt.AddTemplateItem(item, content);
- }
- tt.Process();
- // 編譯模版
- tt.Compile();
- List<String> rs = new List<string>();
- foreach (String item in ss)
- {
- if (item.EndsWith("scc", StringComparison.Ordinal)) continue;
- //String content = RenderFile(table, item, data);
- String content = tt.Render(item, data);
- // 計算輸出文件名
- String fileName = Path.GetFileName(item);
- String className = CutPrefix(table.Name);
- className = FixWord(className);
- String remark = table.Description;
- if (String.IsNullOrEmpty(remark)) remark = ENameToCName(className);
- if (Config.UseCNFileName && !String.IsNullOrEmpty(remark)) className = remark;
- fileNamefileName = fileName.Replace("類名", className).Replace("類說明", remark).Replace("連接名", Config.EntityConnName);
- fileName = Path.Combine(OuputPath, fileName);
- File.WriteAllText(fileName, content, Encoding.UTF8);
- rs.Add(content);
- }
XTemplate設計圖(我喜歡先做圖再編碼)單擊放大:
小結:詳解模版引擎XTemplate與代碼生成器XCode(源碼)的內容介紹完了,希望通過本文的學習能對你有所幫助!