從零開始編寫本身的C#框架（12）——T4模板在邏輯層中的應用（一）（附源碼）

時間 2019-11-12

標籤開始編寫本身 c# 框架 t4 模板邏輯應用源碼欄目 C# 简体版

原文原文鏈接

　　對於T4模板不少朋友都不太熟悉，它在項目開發中，會幫咱們減輕很大的工做量，提高咱們的開發效率，減小出錯機率。因此學好T4模板的應用，對於開發人員來講是很是重要的。數據庫

　　園子裏對於T4模板的介紹與資料已經太多了，因此在這裏我就再也不詳細講述基礎知識了，只是說說T4模板在本框架中的具體應用與實踐。併發

　　1、建立邏輯層項目框架

　　2、添加引用函數

　　將以前添加的三個項目添加到引用工具

　　3、建立T4模板放置的文件夾，並命名爲SubSonic學習

　　4、將Solution.DataAccess項目中SubSonic文件夾下的MultipleOutputHelper.ttinclude、Settings.ttinclude、SQLServer.ttinclude以及項目根目錄下的App.config四個文件複製到邏輯層對應的位置裏，詳見下圖ui

　　5、SubSonic文件夾裏建立Test.tt模板文件，用來練習T4模板的實踐this

　　6、編寫T4模板實例，練習模板的使用編碼

　　一、練習一spa

　　咱們先添加幾行代碼　　

1 <#@ template language="C#" debug="false" hostspecific="True" #>
2 <#@ output extension=".cs" encoding="utf-8" #>
3 <#@ include file="SQLServer.ttinclude" #>
4 
5 using System;
6 
7 namespace <#=Namespace#> {
8 
9 }

　　<#@ template language="C#" debug="false" hostspecific="True" #>是T4模板指令，說明使用的語言是C#，不開啓debug模式，並將名爲 Host 的屬性添加到由文本模板生成的類中

　　<#@ output extension=".cs" encoding="utf-8" #>是T4模板的輸出指令，限制當前模板生成的文件擴展名爲.cs，存儲格式爲utf-8

　　<#@ include file="SQLServer.ttinclude" #>這是模板的工具類文件，使用 Include 指令在其餘文本模板中包含此文件，本行代碼主要功能是將SQL操做的工具類（函數）包含到代碼

　　using System; 這是輸出在cs文件中顯示的文本信息，具體功能你們一看就明白了，再也不解釋

　　namespace <#=Namespace#> 建立命名空間名稱，由於SQLServer.ttinclude文件裏使用了<#@ include file="Settings.ttinclude" #>，將SubSonic3.0模板的配置信息也同時讀取了進來，因此能夠直接使用Settings.ttinclude中設置的變量，用它來做爲命名空間名稱，詳見下圖

　　也就是說，若是你想在模板中使用一些你想要的變量的話，能夠在這些工具類或配置文件中進行定義

　　點擊保存後生成Test.cs文件內容：

　　二、練習二

　　經過練習一，咱們明白了T4模板生成代碼的簡單原理，那麼咱們增長些實用的內容來看看模板運行的效果

　　先上代碼

 1 <#@ template debug="false" hostspecific="True" language="C#" #>
 2 <#@ output extension=".cs" encoding="utf-8" #>
 3 <#@ include file="SQLServer.ttinclude" #>
 4 
 5 using System;
 6 
 7 namespace <#=Namespace#> {
 8 <#
 9     var tables = LoadTables();
10     //遍歷全部表
11     foreach(var tbl in tables){
12 #>
13     
17     public class <#=tbl.CleanName#>Table {
18         /// <summary>
19         /// 表名
20         /// </summary>
21         public static string TableName {
22             get{
23                 return "<#=tbl.CleanName#>";
24               }
25         }
26     }
27 <#
28     }
29 #>  
30 }

　　var tables = LoadTables(); LoadTables()是SQLServer.ttinclude工具類中的函數，功能是獲取數據庫中全部表和字段（已修改了該文件的代碼，能夠獲取到全部表與視圖）

　　foreach(var tbl in tables)　　遍歷全部表

　　<#=tbl.CleanName#>　　讀取表名稱

　　public class <#=tbl.CleanName#>Table　　用表名稱+Table 作爲類名

　　點擊保存後生成Test.cs文件內容：

　　三、練習三

　　經過上面練習，咱們能夠看到使用很簡單的幾行代碼，就能夠很是方便的生成咱們想要的代碼，減小咱們複製粘貼的操做，固然上面生成的東西太簡單了，咱們想經過本模板生成的類來減小強編碼，那麼就須要獲取全部字段名稱出來

 1 <#@ template debug="false" hostspecific="True" language="C#" #>
 2 <#@ output extension=".cs" encoding="utf-8" #>
 3 <#@ include file="SQLServer.ttinclude" #>
 4 
 5 using System;
 6 
 7 namespace <#=Namespace#> {
 8 <#
 9     var tables = LoadTables();
10     //遍歷全部表
11     foreach(var tbl in tables){
12 #>
13 
14     public class <#=tbl.CleanName#>Table {
15         /// <summary>
16         /// 表名
17         /// </summary>
18         public static string TableName {
19             get{
20                 return "<#=tbl.CleanName#>";
21               }
22         }
23 
24 
25 
26         //新增代碼，循環遍歷表中的全部字段，建立相應的函數
27 <#
28         foreach(var col in tbl.Columns){
29 #>
30         /// <summary>
31         /// <#=Replace(col.Description) #>
32         /// </summary>
33            public static string <#= col.Name #>{
34               get{
35               　　return "<#= col.Name #>";
36               }
37         }
38 
39 <#
40         }
41 #>                    
42 
43 
44 
45 
46     }
47 <#
48     }
49 #>  
50 }

　　foreach(var col in tbl.Columns)　　遍歷表中全部字段，獲取字段結構

　　<#=Replace(col.Description) #>　　本代碼中經過col.Description來獲取字估註釋，Replace函數是將字段註釋（說明）裏的換行符替換成對應格式

　　<#= col.Name #>　　獲取字段名稱

　　點擊保存後生成Test.cs文件內容：

　　四、練習四

　　用完上面的練習是否是感受很簡單呢。對於數據表比較少的狀況下，這種生成是徹底沒有問題的，但表多了之後都放在一個文件裏，在DEBUG調試時就會出問題了，主要緣由是代碼行數過大，因此咱們有另一種解決辦法，就是分文件生成

　　先上代碼（爲了讓你們更好的理解，會將前面例子中的一些內容刪除掉）

 1 <#@ template debug="false" hostspecific="True" language="C#" #>
 2 <#@ output extension=".cs" encoding="utf-8" #>
 3 <#@ include file="SQLServer.ttinclude" #>
 4 <#@ include file="MultipleOutputHelper.ttinclude"#> 
 5 
 6 <#
 7     //獲取全部表與視圖
 8     var tables = LoadTables();
 9     //建立多文件生成實體
10     var manager = Manager.Create(Host, GenerationEnvironment);  
11 
12     //遍歷全部表
13     foreach(var tbl in tables){
14         //判斷當前表名是不是禁用名稱（禁用的名稱能夠在Settings.ttinclude文件的ExcludeTables字符串數據中進行添加）
15         if(!ExcludeTables.Contains(tbl.Name))
16         {
17             // 設置輸出的文件名
18             manager.StartNewFile(tbl.ClassName+".cs");
19 #> 
20 using System;
21 
22 namespace <#=Namespace#> {
23 
24 }
25 
26 
27 <# 
28             // 輸出文件結束
29             manager.EndBlock();
30         } //if(!ExcludeTables.Contains(tbl.Name)) 判斷結束
31        
32     }// end foreach
33 
34     // 執行編譯，生成文件
35     manager.Process(true);  
36 #>

　　<#@ include file="MultipleOutputHelper.ttinclude"#>　　生成多文件工具類

　　var manager = Manager.Create(Host, GenerationEnvironment); 　　建立多文件生成實體

　　foreach(var tbl in tables)　　遍歷全部表，這個放在using的前面，是由於每一個單獨文件生成後都須要有using

　　其餘新增內容在代碼中都有詳細註釋了，因此這裏再也不說明

　　點擊保存後生成Test.cs文件內容：

　　再來個完整的模板代碼

 1 <#@ template debug="false" hostspecific="True" language="C#" #>
 2 <#@ output extension=".cs" encoding="utf-8" #>
 3 <#@ include file="SQLServer.ttinclude" #>
 4 <#@ include file="MultipleOutputHelper.ttinclude"#> 
 5 
 6 <#
 7     //獲取全部表與視圖
 8     var tables = LoadTables();
 9     //建立多文件生成實體
10     var manager = Manager.Create(Host, GenerationEnvironment);  
11 
12     //遍歷全部表
13     foreach(var tbl in tables){
14         //判斷當前表名是不是禁用名稱（禁用的名稱能夠在Settings.ttinclude文件的ExcludeTables字符串數據中進行添加）
15         if(!ExcludeTables.Contains(tbl.Name))
16         {
17             // 設置輸出的文件名
18             manager.StartNewFile(tbl.ClassName+".cs");
19 #> 
20 using System;
21 
22 namespace <#=Namespace#> {
23 
24     public class <#=tbl.CleanName#>Table {
25         /// <summary>
26         /// 表名
27         /// </summary>
28         public static string TableName {
29             get{
30                 return "<#=tbl.CleanName#>";
31               }
32         }
33         
34 <#
35         foreach(var col in tbl.Columns){
36 #>
37         /// <summary>
38         /// <#=Replace(col.Description) #>
39         /// </summary>
40            public static string <#= col.Name #>{
41             get{
42                 return "<#= col.Name #>";
43               }
44         }
45 
46 <#
47         }
48 #>
49     }
50 
51 }
52 
53 
54 <# 
55             // 輸出文件結束
56             manager.EndBlock();
57         } //if(!ExcludeTables.Contains(tbl.Name)) 判斷結束
58        
59     }// end foreach
60 
61     // 執行編譯，生成文件
62     manager.Process(true);  
63 #>