T4模板根據數據庫表和列的Description生成代碼的summary的終極解決方案

相信不少人都用T4模版生成代碼，用T4模版生成標準代碼真的很方便。咱們常常根據表生成相關的代碼， 可是估計不少人都碰見過同一個問題， 特別是咱們在生成model的時候，代碼中model中的Summary一直沒法生成。這個問題也困擾了我好久，也找了不少方案，一直沒有更好的方法。問題以下：

解決方案

爲了生成summary須要額外的增長一個類，並在T4模版中引用這個類便可。這個類的做用是根據表名和列名提取數據表中列的description。

1. 首先查詢數據庫中全部表和列的基本信息

爲了方便起見，我在數據庫中建立了一個視圖，視圖結構以下：

 

sql 腳本以下：

SELECT   TOP (100) PERCENT COALESCE (T.name, OBJECT_NAME(C.object_id)) AS TableName, TB.TableDESC,
                C.name AS ColumnName, TYPE_NAME(C.user_type_id) AS DataType, D.definition AS DefaultSetting,
                C.is_nullable AS IsNullable, C.max_length AS MaxLength, COLUMNPROPERTY(C.object_id, C.name, 'PRECISION')
                AS Precision, P.value AS ColumnDESC
FROM      sys.columns AS C LEFT OUTER JOIN
                sys.table_types AS T ON T.type_table_object_id = C.object_id LEFT OUTER JOIN
                sys.default_constraints AS D ON C.object_id = D.parent_object_id AND
                D.parent_column_id = C.column_id LEFT OUTER JOIN
                sys.extended_properties AS P ON (P.major_id = C.object_id OR
                P.major_id = T.user_type_id) AND P.minor_id = C.column_id AND P.name = 'MS_Description' LEFT OUTER JOIN
                    (SELECT   INFORMATION_SCHEMA.TABLES.TABLE_NAME AS TableName, P.value AS TableDESC
                     FROM      INFORMATION_SCHEMA.TABLES LEFT OUTER JOIN
                                     sys.extended_properties AS P ON
                                     OBJECT_ID(INFORMATION_SCHEMA.TABLES.TABLE_SCHEMA + '.' + INFORMATION_SCHEMA.TABLES.TABLE_NAME)
                                      = P.major_id AND P.minor_id = 0
                     WHERE   (INFORMATION_SCHEMA.TABLES.TABLE_TYPE = 'BASE TABLE')) AS TB ON COALESCE (T.name,
                OBJECT_NAME(C.object_id)) = TB.TableName
WHERE   (COALESCE (SCHEMA_NAME(T.schema_id), OBJECT_SCHEMA_NAME(C.object_id)) = 'dbo')
ORDER BY TableName

 

2.在代碼中計算description

 

3.T4模版調用

前面已經建立了一個類，這個類很簡單，就是根據表名和列名獲取對應的description。如今只要在T4模版中引用這個類便可。代碼中要注意兩點。直接上代碼：

1. 必需要在T4模板的頭部引用上面類的dll，不然沒法引用命名空間。我用的是相對路徑。其中$(SolutionDir)表示的solution所在的文件夾。

2.引用命名空間，下圖中紅線部分2行

在T4模板中直接調用方法便可，這樣就能夠根據表個列表獲取到相應的description做爲類的summary了。

 

這裏提到一點，T4模版的代碼中這個我用了一個replace，是由於我在寫列描述的時候有換行，因此我把數據庫中的換行轉換成了summary中的換行，效果以下：

 

生成的代碼的demo

跟你們提供幾個生成代碼的截圖吧，怎麼樣全部的summary都已經根據數據庫生成出來了吧

 

總結

我的認爲這個方法是最簡單的方法也是最有效的了，應該沒有比這個在簡單了。歡迎你們拍磚