CodeSmith入门教程之编写数据库模板

zoukankan html css js c++ java

CodeSmith入门教程之编写数据库模板

编写一个数据库驱动的模板
现在我们已经认识了哪些怎么样使用CodeSmith配合我们工作的要素，
我们接着学如何生成你可能下载CodeSmith首先想要生成的东西。
数据访问逻辑可能是程序中最多余的部分，使用CodeSmith你可
以自动生成相当正规的数据访问层代码。最后章节你可以看到如何
编写一个简单的支持参数的模板，但是现在我们打算看看如何
通过使用CodeSmith的SchemaExplorer组件编写模板。SchemaExplorer
组件是一个程序集，它提供了多个可以用来浏览你数据库内容的类。
通过使用SchemaExplorer组件你可以浏览表和存储过程以及取到数据
类型，唯一列，列名等信息。
作为一个如何使用SchemaExplorer的例子，我们打算编写一个根据
表列自动生成存储过程的模板。开始编写模板前我们应该编写一个
希望模板生成的文本内容，这样我们可以使用这些文本作为模板的
开始。下面是我们期望生成的文本：
程序代码

[复制到剪贴板]
CODE:

-----------------------------------------------------------------
-- Date Created: Thursday, December 04, 2003
-- Created By: Generated by CodeSmith 51aspx.com
-----------------------------------------------------------------
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

这是一个更新Northwind数据库Orders表的存储过程，因为是一个
十分普通的存储过程，所以是一个很好的代码生成模型。模板的目
标是从表里读取信息然后自动生成对应的存储过程，当然可以适用
其他表不仅仅是本表。
首先在模板里创建CodeTemplate标签描述模板名字和说明。
<%@ CodeTemplate Language="C#" TargetLanguage="T-SQL"
Description="Generates a update stored procedure." %>
接着我们需要调用包含了SchemaExplorer的程序集，此类有利
于我们通过程序集标签访问数据库。
<%@ Assembly Name="SchemaExplorer" %>
我们需要使用import标签导入SchemaExplorer的命名空间，载入SchemaExplorer
程序集，以便我们可以在模板里访问它的类，
<%@ Import Namespace="SchemaExplorer" %>
因为我们打算从表里读数据，我们需要在模板里增加
一个TableSchema类型的属性。
<%@ Property Name="SourceTable" Type="SchemaExplorer.TableSchema"
Category="Context"
Description="Table that the stored procedures should be based on." %>
当我们执行模板时，这个属性允许我们选择一个数据库和表格。我们可以参考这个属性
去检测表和创建基于表的内容和属性的我们的模板。
接着开始些输出文本的模板节点。第一个节点是如下可见的文件头。
-----------------------------------------------------------------
-- Date Created: <%= DateTime.Now.ToLongDateString() %>
-- Created By: Generated by CodeSmith
-----------------------------------------------------------------
代码和最后例子里的类似，我们使用DateTime对象为我们的文件生
成时间。然后我们需要创建存储过程脚本的首行：
Create PROCEDURE dbo.Update<%= SourceTable.Name %>
在本行里我们使用早先定义的 SourceTable的Name属性，它将插入
我们在测试的表名，因此本例中因为我们对应的是Orders表所以
存储过程将是UpdateOrders.
接下来我们为存储过程创建参数列表，因为我们要创建一个更新的存储
过程我们需要表的每个列名做参数。使用TableSchema 对象我们可以循
环表中的列读出列名和列的数据类型，使用值去创建我们的列表。
程序代码
程序代码
<% for (int I = 0; I < SourceTable.Columns.Count; i++) { %>
<%= GetSqlParameterStatement(SourceTable.Columns) %>
<% if (I < SourceTable.Columns.Count - 1) { %>,<% } %>
<% } %>
AS

我们需要创建一个带参数的更新表的SQL语句。因此我需要再循环
列集合，但是应该用NonPrimaryKeyColumns 集合替换normal
columns 进行。我们这样做是因为我们仅想更行非主建列。我们
将在更新语句的where条件中用主键列。
程序代码
程序代码
Update [<%= SourceTable.Name %>] SET
<% for (int I = 0; I < SourceTable.NonPrimaryKeyColumns.Count; i++) { %>
[<%= SourceTable.NonPrimaryKeyColumns.Name %>] = @<%= SourceTable.NonPrimaryKeyColumns.Name %><% if (I < SourceTable.NonPrimaryKeyColumns.Count - 1) { %>,<% } %>
<% } %>

下列的语句中我们要创建SET列表，列表包含了列名和参数名，下面是
CodeSmith执行后生成的文本：
程序代码
程序代码
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

模板的最后部分我们需要编写update语句的where字句。
再次的使用列循环，但是这次我们从表的主见列中循环
来生成where字句。
程序代码
程序代码
Where
<% for (int I = 0; I < SourceTable.PrimaryKey.MemberColumns.Count; i++) { %>
<% if (I > 0) { %>AND <% } %>
[<%= SourceTable.PrimaryKey.MemberColumns.Name %>] = @
<%= SourceTable.PrimaryKey.MemberColumns.Name %>
<% } %>
下面是CodeSmith生成的文本：
程序代码
程序代码
Where

[OrderID] = @OrderID
下面是完整的模板：
程序代码
程序代码
<%@ 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>
-----------------------------------------------------------------
-- Date Created: <%= DateTime.Now.ToLongDateString() %>
-- Created By: Generated by CodeSmith
-----------------------------------------------------------------
Create PROCEDURE dbo.Update<%= SourceTable.Name %>
<% for (int I = 0; I < SourceTable.Columns.Count; i++) { %>
<%= GetSqlParameterStatement(SourceTable.Columns) %><% if (I < SourceTable.Columns.Count - 1) { %>,<% } %>
<% } %>
AS
Update [<%= SourceTable.Name %>] SET
<% for (int I = 0; I < SourceTable.NonPrimaryKeyColumns.Count; i++) { %>
[<%= SourceTable.NonPrimaryKeyColumns.Name %>] = @<%= SourceTable.NonPrimaryKeyColumns.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.Name %>] = @<%= SourceTable.PrimaryKey.MemberColumns.Name %>
<% } %>

当我们在CodeSmith中载入模板的时候可以看见 SourceTable 属性
，属性在右边包含了一个按钮，你可以通过选择一个表来运行存储
过程生成的模板。下面是界图：
点右边的按钮去选择一个表，你可以看见如下图：
在界图中你可以配置你的数据源（通过选择展开按钮选择另一
个数据库）。接着选你想要模板生成代码的表。选择表点生成
后下面的文本将被生成：
程序代码
程序代码
-----------------------------------------------------------------
-- Date Created: Saturday, December 06, 2003
-- Created By: Generated by CodeSmith
-----------------------------------------------------------------
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

本模板可以生成任意数据库任意表的更新存储过程。
结论
真心的希望这个快速帮助可以为你使用CodeSmith提供
足够的信息和例子.CodeSmith是一个十分有力和省时的工具，
希望你可以在你的工程中发现更多的用处就像我们一样。
CodeSmith是不是让你又偷懒了，而效率又提高了？

查看全文

相关阅读:
Creating a Simple Direct2D Application
关于ssh加密方式的理解
 关于2147217913 从 char 数据类型到 datetime 数据类型的转换导致 datetime 值越界的问题解决方法
 关于 win2003中ASP.Net 的edit configuration 无法使用的答疑
 vc 用ado访问Oracle数据库的代码示例
 手工移除vs6的VSS绑定
 关于:无法执行值从 char 到 char 的隐性转换，因为该值的排序规则因排序规则冲突而未能解决
 vs2003 无法进行调试的经历
 关于如何在VMware上安装Puppy Linux
VB: DataGrid 的列可见问题

原文地址：https://www.cnblogs.com/juan/p/1429474.html