如何用CodeSmith减少代码重复编写 - 中国WEB开发者网络 (http://www.webasp.net) -- 技术教程 (http://www.webasp.net/article/) --- 如何用CodeSmith减少代码重复编写 (http://www.webasp.net/article/27/26088.htm) |
| -- 作者:未知 -- 发布日期: 2005-08-30 |
|
上次简单介绍了下CodeSmith,今天做些详细介绍(转),希望可以对大家有帮助: CodeSmith 是一种语法类似于asp.net的基于模板的代码生成器,程序可以自定义模板,从而减少重复编码的劳动量,提高效率。 <%@ CodeTemplate Language="C#" TargetLanguage="C#" Description="Generates a simple class " %>![]() 然后声明几个变量,用来为了能够在以后生成的代码嵌入,这里声明了三个名为NameSpace,ClassName,Contxt的变量。其他参数一目了然就不再说明了, <%@ Property Name="NameSpace" Type="String" Category="Context" Description="The namespace to use for this class" %> <%@ Property Name="ClassName" Type="String" Category="Context" Description="The name of the class to generate" %> <%@ Property Name="DevelopersName" Type="String" Category="Context" Description="The name to include in the comment header" %>接下来建立将要生成代码的框架,在适当位置引用刚刚声明的变量名 using System; namespace <%=NameSpace %> { /// <summary> /// Summary description for <%=ClassName %>. /// </summary> public class <%=ClassName %> { public <%=ClassName %>() { } } }最后,打开CodeSmith Explorer.exe,加载此模板,并且在属性对话框中任意更改声明的变量名,按Generate按钮生成合适的代码 CREATE PROCEDURE dbo.UpdateOrders @OrderID int, @CustomerID nchar(5), @EmployeeID int, @OrderDate datetime, @RequiredDate datetime, @ShippedDate datetime, @ShipVia int, @Freight money, @ShipName nvarchar(40), @ShipAddress nvarchar(60), @ShipCity nvarchar(15), @ShipRegion nvarchar(15), @ShipPostalCode nvarchar(10), @ShipCountry nvarchar(15) AS UPDATE [Orders] SET [CustomerID] = @CustomerID, [EmployeeID] = @EmployeeID, [OrderDate] = @OrderDate, [RequiredDate] = @RequiredDate, [ShippedDate] = @ShippedDate, [ShipVia] = @ShipVia, [Freight] = @Freight, [ShipName] = @ShipName, [ShipAddress] = @ShipAddress, [ShipCity] = @ShipCity, [ShipRegion] = @ShipRegion, [ShipPostalCode] = @ShipPostalCode, [ShipCountry] = @ShipCountry WHERE [OrderID] = @OrderID![]() 第一步还是创建一个CodeTemplate指示,注意TargetLanguage属性改为了T-SQL,因为创建的SQL语言代码 <%@ CodeTemplate Language="C#" TargetLanguage="T-SQL" Description="Generates a update stored procedure." %>然后加载SchemaExplorer组件,并导入SchemaExplorer命名空间,看这里是不是和asp.net很像 <%@ Assembly Name="SchemaExplorer" %> <%@ Import Namespace="SchemaExplorer" %>接下来声明变量,因为要从数据库表中读取框架所以 Type 属性为SchemaExplorer.TableSchema <%@ Property Name="SourceTable" Type="SchemaExplorer.TableSchema" Category="Context" Description="Table that the stored procedures should be based on." %>![]() 下面就要写实际将要输出代码部分的模板了。 CREATE PROCEDURE dbo.Update<%=SourceTable.Name %>第二步为存储过程创造将要声明的参数列表 //开始循环遍历每列 <% for (int i = 0; i < SourceTable.Columns.Count; i++) { %> //传递每列给GetSqlParameterStatement函数 <%= GetSqlParameterStatement(SourceTable.Columns[i]) %> //循环结束条件 <% if (i < SourceTable.Columns.Count - 1) { %>,<% } %> <% } % > AS定义GetSqlParameterStatement方法接受列参数返回参数名,和字段类型,注意函数要放在 <script runat="template">![]() public string GetSqlParameterStatement(ColumnSchema column)![]() { string param = "@" + column.Name + " " + column.NativeType; switch (column.DataType) { case DbType.Decimal: { param += "(" + column.Precision + ", " + column.Scale + ")"; break; } default: { if (column.Size > 0) {param += "(" + column.Size + ")"; } break; } } return param; } </script>![]() 接下来创建存储过程的Update部分,语法类似不再说明 UPDATE [<%= SourceTable.Name %>] SET<% for (int i = 0; i < SourceTable.NonPrimaryKeyColumns.Count; i++) { %> [<%= SourceTable.NonPrimaryKeyColumns[i].Name %>] = @<%= SourceTable.NonPrimaryKeyColumns[i].Name %><% if (i < SourceTable.NonPrimaryKeyColumns.Count - 1) { %>,<% } %> <% } %> //where条件,注意主键提取方法 WHERE<% for (int i = 0; i < SourceTable.PrimaryKey.MemberColumns.Count; i++) { %> <% if (i > 0) { %>AND <% } %> [<%= SourceTable.PrimaryKey.MemberColumns[i].Name %>] = @<%= SourceTable.PrimaryKey.MemberColumns[i].Name %> <% } %> ![]() 最终为模板为如下形式 <%@ CodeTemplate Language="C#" TargetLanguage="T-SQL" Description="Generates a update stored procedure." %> <%@ Property Name="SourceTable" Type="SchemaExplorer.TableSchema" Category="Context" Description="Table that the stored procedures should be based on." %> <%@ Assembly Name="SchemaExplorer" %> <%@ Import Namespace="SchemaExplorer" %> <script runat="template"> public string GetSqlParameterStatement(ColumnSchema column) { string param = "@" + column.Name + " " + column.NativeType; switch (column.DataType) { case DbType.Decimal: { param += "(" + column.Precision + ", " + column.Scale + ")"; break; } default: { if (column.Size > 0) { param += "(" + column.Size + ")"; } break; } } return param; } </script> CREATE PROCEDURE dbo.Update<%= SourceTable.Name %> <% for (int i = 0; i < SourceTable.Columns.Count; i++) { %> <%= GetSqlParameterStatement(SourceTable.Columns[i]) %><% if (i < SourceTable.Columns.Count - 1) { %>,<% } %> <% } %> AS UPDATE [<%= SourceTable.Name %>] SET <% for (int i = 0; i < SourceTable.NonPrimaryKeyColumns.Count; i++) { %> [<%= SourceTable.NonPrimaryKeyColumns[i].Name %>] = @<%= SourceTable.NonPrimaryKeyColumns[i].Name %><% if (i < SourceTable.NonPrimaryKeyColumns.Count - 1) { %>,<% } %> <% } %> WHERE <% for (int i = 0; i < SourceTable.PrimaryKey.MemberColumns.Count; i++) { %> <% if (i > 0) { %>AND <% } %> [<%= SourceTable.PrimaryKey.MemberColumns[i].Name %>] = @<%= SourceTable.PrimaryKey.MemberColumns[i].Name %> <% } %> 将其用CodeSmith Explorer.exe打开 CREATE PROCEDURE dbo.UpdateOrders @OrderID int, @CustomerID nchar(5), @EmployeeID int, @OrderDate datetime, @RequiredDate datetime, @ShippedDate datetime, @ShipVia int, @Freight money, @ShipName nvarchar(40), @ShipAddress nvarchar(60), @ShipCity nvarchar(15), @ShipRegion nvarchar(15), @ShipPostalCode nvarchar(10), @ShipCountry nvarchar(15) AS UPDATE [Orders] SET [CustomerID] = @CustomerID, [EmployeeID] = @EmployeeID, [OrderDate] = @OrderDate, [RequiredDate] = @RequiredDate, [ShippedDate] = @ShippedDate, [ShipVia] = @ShipVia, [Freight] = @Freight, [ShipName] = @ShipName, [ShipAddress] = @ShipAddress, [ShipCity] = @ShipCity, [ShipRegion] = @ShipRegion, [ShipPostalCode] = @ShipPostalCode, [ShipCountry] = @ShipCountry WHERE [OrderID] = @OrderID![]() 同样,我们可以选择其他的表创建Updata存储过程,也可以自定义其他诸如insert delete等的存储过程,是不是很方便?^-^ <script runat="template">![]() public string GetSqlParameterStatement(ColumnSchema column)![]() { string param = "@" + column.Name + " " + column.NativeType; switch (column.DataType) { case DbType.Decimal: { param += "(" + column.Precision + ", " + column.Scale + ")"; break; } default: { if (column.Size > 0) {param += "(" + column.Size + ")"; } break; } } return param; } </script>![]() 接下来创建存储过程的Update部分,语法类似不再说明 UPDATE [<%= SourceTable.Name %>] SET<% for (int i = 0; i < SourceTable.NonPrimaryKeyColumns.Count; i++) { %> [<%= SourceTable.NonPrimaryKeyColumns[i].Name %>] = @<%= SourceTable.NonPrimaryKeyColumns[i].Name %><% if (i < SourceTable.NonPrimaryKeyColumns.Count - 1) { %>,<% } %> <% } %> //where条件,注意主键提取方法 WHERE<% for (int i = 0; i < SourceTable.PrimaryKey.MemberColumns.Count; i++) { %> <% if (i > 0) { %>AND <% } %> [<%= SourceTable.PrimaryKey.MemberColumns[i].Name %>] = @<%= SourceTable.PrimaryKey.MemberColumns[i].Name %> <% } %> ![]() 最终为模板为如下形式 <%@ CodeTemplate Language="C#" TargetLanguage="T-SQL" Description="Generates a update stored procedure." %> <%@ Property Name="SourceTable" Type="SchemaExplorer.TableSchema" Category="Context" Description="Table that the stored procedures should be based on." %> <%@ Assembly Name="SchemaExplorer" %> <%@ Import Namespace="SchemaExplorer" %> <script runat="template"> public string GetSqlParameterStatement(ColumnSchema column) { string param = "@" + column.Name + " " + column.NativeType; switch (column.DataType) { case DbType.Decimal: { param += "(" + column.Precision + ", " + column.Scale + ")"; break; } default: { if (column.Size > 0) { param += "(" + column.Size + ")"; } break; } } return param; } </script> CREATE PROCEDURE dbo.Update<%= SourceTable.Name %> <% for (int i = 0; i < SourceTable.Columns.Count; i++) { %> <%= GetSqlParameterStatement(SourceTable.Columns[i]) %><% if (i < SourceTable.Columns.Count - 1) { %>,<% } %> <% } %> AS UPDATE [<%= SourceTable.Name %>] SET <% for (int i = 0; i < SourceTable.NonPrimaryKeyColumns.Count; i++) { %> [<%= SourceTable.NonPrimaryKeyColumns[i].Name %>] = @<%= SourceTable.NonPrimaryKeyColumns[i].Name %><% if (i < SourceTable.NonPrimaryKeyColumns.Count - 1) { %>,<% } %> <% } %> WHERE <% for (int i = 0; i < SourceTable.PrimaryKey.MemberColumns.Count; i++) { %> <% if (i > 0) { %>AND <% } %> [<%= SourceTable.PrimaryKey.MemberColumns[i].Name %>] = @<%= SourceTable.PrimaryKey.MemberColumns[i].Name %> <% } %> 将其用CodeSmith Explorer.exe打开 CREATE PROCEDURE dbo.UpdateOrders @OrderID int, @CustomerID nchar(5), @EmployeeID int, @OrderDate datetime, @RequiredDate datetime, @ShippedDate datetime, @ShipVia int, @Freight money, @ShipName nvarchar(40), @ShipAddress nvarchar(60), @ShipCity nvarchar(15), @ShipRegion nvarchar(15), @ShipPostalCode nvarchar(10), @ShipCountry nvarchar(15) AS UPDATE [Orders] SET [CustomerID] = @CustomerID, [EmployeeID] = @EmployeeID, [OrderDate] = @OrderDate, [RequiredDate] = @RequiredDate, [ShippedDate] = @ShippedDate, [ShipVia] = @ShipVia, [Freight] = @Freight, [ShipName] = @ShipName, [ShipAddress] = @ShipAddress, [ShipCity] = @ShipCity, [ShipRegion] = @ShipRegion, [ShipPostalCode] = @ShipPostalCode, [ShipCountry] = @ShipCountry WHERE [OrderID] = @OrderID![]() 同样,我们可以选择其他的表创建Updata存储过程,也可以自定义其他诸如insert delete等的存储过程,是不是很方便?^-^ <%@ CodeTemplate Language="C#" TargetLanguage="C#" Description="Generates a simple class " %>![]() 然后声明几个变量,用来为了能够在以后生成的代码嵌入,这里声明了三个名为NameSpace,ClassName,Contxt的变量。其他参数一目了然就不再说明了, <%@ Property Name="NameSpace" Type="String" Category="Context" Description="The namespace to use for this class" %> <%@ Property Name="ClassName" Type="String" Category="Context" Description="The name of the class to generate" %> <%@ Property Name="DevelopersName" Type="String" Category="Context" Description="The name to include in the comment header" %>接下来建立将要生成代码的框架,在适当位置引用刚刚声明的变量名 using System; namespace <%=NameSpace %> { /// <summary> /// Summary description for <%=ClassName %>. /// </summary> public class <%=ClassName %> { public <%=ClassName %>() { } } }最后,打开CodeSmith Explorer.exe,加载此模板,并且在属性对话框中任意更改声明的变量名,按Generate按钮生成合适的代码 CREATE PROCEDURE dbo.UpdateOrders @OrderID int, @CustomerID nchar(5), @EmployeeID int, @OrderDate datetime, @RequiredDate datetime, @ShippedDate datetime, @ShipVia int, @Freight money, @ShipName nvarchar(40), @ShipAddress nvarchar(60), @ShipCity nvarchar(15), @ShipRegion nvarchar(15), @ShipPostalCode nvarchar(10), @ShipCountry nvarchar(15) AS UPDATE [Orders] SET [CustomerID] = @CustomerID, [EmployeeID] = @EmployeeID, [OrderDate] = @OrderDate, [RequiredDate] = @RequiredDate, [ShippedDate] = @ShippedDate, [ShipVia] = @ShipVia, [Freight] = @Freight, [ShipName] = @ShipName, [ShipAddress] = @ShipAddress, [ShipCity] = @ShipCity, [ShipRegion] = @ShipRegion, [ShipPostalCode] = @ShipPostalCode, [ShipCountry] = @ShipCountry WHERE [OrderID] = @OrderID![]() 第一步还是创建一个CodeTemplate指示,注意TargetLanguage属性改为了T-SQL,因为创建的SQL语言代码 <%@ CodeTemplate Language="C#" TargetLanguage="T-SQL" Description="Generates a update stored procedure." %>然后加载SchemaExplorer组件,并导入SchemaExplorer命名空间,看这里是不是和asp.net很像 <%@ Assembly Name="SchemaExplorer" %> <%@ Import Namespace="SchemaExplorer" %>接下来声明变量,因为要从数据库表中读取框架所以 Type 属性为SchemaExplorer.TableSchema <%@ Property Name="SourceTable" Type="SchemaExplorer.TableSchema" Category="Context" Description="Table that the stored procedures should be based on." %>![]() 下面就要写实际将要输出代码部分的模板了。 CREATE |