用 StringTemplate重新制作代码生成工具

放假没事干，重做了一下以前做的代码生成工具（在《基于CodeSmith的数据处理代码生成工具》中提到），正确来说，以前的是CodeSmith的模板，必须安装该软件才能使用，很不爽。（文/Stephen.Huang）

　　这次用StringTemplate来生成模板，而自己则负责写以前CodeSmith负责做的东西，如获取数据库，表，列的Schema，并封装成一个一个类。

　　制作这个代码生成工具时，考虑到的和遇到的一些问题总结一下：

　　1.必需适应各种不同的数据库

　　a)使用DbProviderFactory来创建各种对象，如DbParameter。想起以前一直都是hardcode SqlParameter。DbProviderFactory会根据数据库驱动的不同，创建不同的对象，如 providerName="System.Data.SqlClient"时，用 DbProviderFactory.CreateParameter,会创建SqlParameter类型的对象。

　　b)把MS的SqlHelper改写（不知道是不是MS写的），全部改写成System.Data.Common下的数据库对象（DbProviderFactory Create出来的对象,用DbType而不用SqlDbType），并只保留一些常用的方法（事实上是全部改写很麻烦），如 PrepareParameter，ExecuteReader，ExecuteNonQuery，ExecuteDataSet（ExecuteDataSet 还是尽量避免使用的，留下来以防万一）。

　　c)在获取Schema时遇到的问题-命名规范：Select * from 表名，表名中出现保留字时，不同的数据库可能不一样，比较难解决，不同的数据库解决方法可能不同。SqlServer中需要为表名加上"[]"（如果表名中包含了"["或"]"中任意一个，还需要特殊处理，自己一般不会这样来给表命名，忽略- -）。

　　d)在获取Schema时遇到的问题2:当SQL2005里面遇到视图如[HumanResouce].[vEmployee]，则 select * from vEmployee无效，必须要select * from [HumanResouce].[vEmployee]，不知道其他数据库是什么情况- -看来要做成通用的，真的很难，还是以后根据实际情况再改吧:)

　　e)使用DbDataReader.GetSchemaTable才会遇到上述c、d这两个需要写sql才能获取schema的问题。还有一种方法是使用DbConnection.GetSchema来获取字段的信息，但是此方法比较繁琐，本人尚未成功地获取Primary key和identity Column等的详细信息(T_T)，有空再研究研究。

　　f)从数据库中取出的原始信息，为适应各种数据库建立不同TableWrapper和CoumnWrapper（即使用原始信息对不同数据库进行封装），对不同的程语编言建立各种别名（如用CSharpAlias类能够把System.Int32转变成int），对不同的数据库创建不同的 sql模板（有待完成）。

　　2.使用何种模板引擎

　　这里选择了StringTemplate。为什么？因为学习简单，使用也简单，功能很强大。当使用 stringTemplate.SetAttribute("pkColumns", tableWrapper.PkColumns); 后，可以在模板里访问PkColumns里面的public Field和Property。包含判断和循环的语法。支持嵌套模板。

　　还差一个可视化使用界面，懒，暂时先将就使用一下- -

　　附上模板的代码：（下载地址）

1. using System;
   
2. using System.Configuration;
   
3. using System.Data;
   
4. using System.Data.Common;
   
5. using System.Collections.Generic;
   
6. 
   
7. namespace
   
8. {
   
9.     public class $table.EntityName$Dao
   
10.     {
    
11.         private static ConnectionStringSettings dbSettings = DataConnection.;
    
12.         private static string connectionString = dbSettings.ConnectionString;
    
13.         private static DbProviderFactory dbFactory = DbProviderFactories.GetFactory(dbSettings.ProviderName);
    
14.         
    
15.         public static List<$table.EntityName[        DISCUZ_CODE_1        ]gt; GetAll()
    
16.         {
    
17.             var list = new List<$table.EntityName[        DISCUZ_CODE_1        ]gt;();
    
18.             DbDataReader dr = null;
    
19.             try
    
20.             {
    
21.                 dr = SqlHelper.ExecuteReader(dbFactory, connectionString
    
22.                     , CommandType.Text
    
23.                     , "select $allColumns:{$it.QualifiedColumnName$};separator=","$ from $table.QualifiedTableName[        DISCUZ_CODE_2        ]quot;);
    
24.                 while (dr != null && dr.Read())
    
25.                 {
    
26.                     var obj = new $table.EntityName$();
    
27.                     $allColumns:{obj.$it.PropName$ = Field.Get$it.SystemTypeShortName$(dr, "$it.Name[        DISCUZ_CODE_2        ]quot;);};separator="\r\n"$
    
28.                     list.Add(obj);
    
29.                 }
    
30.             }
    
31.             finally
    
32.             {
    
33.                 if (dr != null)
    
34.                 {
    
35.                     dr.Close();
    
36.                     dr.Dispose();
    
37.                 }
    
38.             }
    
39.             return list;
    
40.         }$if(table.IsTable)$
    
41.         
    
42.         public static $table.EntityName$ Get($pkColumns:{$it.SystemType$ $it.VarName$};separator=","$)
    
43.         {
    
44.             $table.EntityName$ obj = null;
    
45.             DbDataReader dr = null;
    
46.             try
    
47.             {
    
48.                 var paras = new DbParameter[]{
    
49.                     $pkColumns:{SqlHelper.PrepareParameter(dbFactory, "$it.Name[        DISCUZ_CODE_2        ]quot;, $it.DBType$, $it.VarName$)};separator=",\r\n"$
    
50.                 };
    
51. 
    
52.                 dr = SqlHelper.ExecuteReader(dbFactory, connectionString
    
53.                     , CommandType.Text
    
54.                     , "select $allColumns:{$it.QualifiedColumnName$};separator=","$ from $table.QualifiedTableName$ where $pkColumns:{$it.QualifiedColumnName$=@$it.PropName$};separator="and "[        DISCUZ_CODE_2        ]quot;, paras);
    
55.                 if (dr != null && dr.Read())
    
56.                 {
    
57.                     obj = new $table.EntityName$();
    
58.                     $allColumns:{obj.$it.PropName$ = Field.Get$it.SystemTypeShortName$(dr, "$it.Name[        DISCUZ_CODE_2        ]quot;);};separator="\r\n"$
    
59.                 }
    
60.             }
    
61.             finally
    
62.             {
    
63.                 if (dr != null)
    
64.                 {
    
65.                     dr.Close();
    
66.                     dr.Dispose();
    
67.                 }
    
68.             }
    
69.             return obj;
    
70.         }
    
71.         
    
72.         public static bool Insert($table.EntityName$ obj)
    
73.         {
    
74.             bool flag = false;
    
75.             try
    
76.             {
    
77.                 var paras = new DbParameter[]{
    
78.                     $nonIdColumns:{SqlHelper.PrepareParameter(dbFactory, "$it.Name[        DISCUZ_CODE_2        ]quot;, $it.DBType$, obj.$it.PropName$)};separator=",\r\n"$
    
79.                 };
    
80.                 SqlHelper.ExecuteNonQuery(dbFactory, connectionString
    
81.                     , CommandType.Text
    
82.                     , "insert into $table.QualifiedTableName$($nonIdColumns:{$it.QualifiedColumnName$};separator=", "$) values($nonIdColumns:{@$it.PropName$};separator=", "$)", paras);
    
83.                 flag = true;
    
84.             }
    
85.             catch (Exception)
    
86.             {
    
87.                 flag = false;
    
88.             }
    
89.             return flag;
    
90.         }
    
91.         
    
92.         public static bool Update($table.EntityName$ obj)
    
93.         {
    
94.             bool flag = false;
    
95.             try
    
96.             {
    
97.                 var paras = new DbParameter[]{
    
98.                     $allColumns:{SqlHelper.PrepareParameter(dbFactory, "$it.Name[        DISCUZ_CODE_2        ]quot;, $it.DBType$, obj.$it.PropName$)};separator=",\r\n"$
    
99.                 };
    
100.                 SqlHelper.ExecuteNonQuery(dbFactory, connectionString
     
101.                     , CommandType.Text
     
102.                     , "update $table.QualifiedTableName$ set $updateColumns:{$it.QualifiedColumnName$=@$it.PropName$};separator=", "$ where $pkColumns:{$it.QualifiedColumnName$=@$it.PropName$};separator="and "[        DISCUZ_CODE_2        ]quot;, paras);
     
103.                 flag = true;
     
104.             }
     
105.             catch (Exception)
     
106.             {
     
107.                 flag = false;
     
108.             }
     
109.             return flag;
     
110.         }
     
111.         
     
112.         public static bool Delete($pkColumns:{$it.SystemType$ $it.VarName$};separator=","$)
     
113.         {
     
114.             bool flag = false;
     
115.             try
     
116.             {
     
117.                 var paras = new DbParameter[]{
     
118.                     $pkColumns:{SqlHelper.PrepareParameter(dbFactory, "$it.Name[        DISCUZ_CODE_2        ]quot;, $it.DBType$, $it.VarName$)};separator=",\r\n"$
     
119.                 };
     
120.                 SqlHelper.ExecuteNonQuery(dbFactory, connectionString
     
121.                     , CommandType.Text
     
122.                     , "delete from $table.QualifiedTableName$ where $pkColumns:{$it.QualifiedColumnName$=@$it.PropName$};separator="and "[        DISCUZ_CODE_2        ]quot;, paras);
     
123.                 flag = true;
     
124.             }
     
125.             catch (Exception)
     
126.             {
     
127.                 flag = false;
     
128.             }
     
129.             return flag;
     
130.         }$endif$
     
131.     }
     
132. }
     

复制代码