CodeSmith(C#)简单示例及相关小知识

 

// 本文将介绍CodeSmith与数据库进行交互生成相应的存储过程，本例使用的数据库为SQL Server 2000。
// 在与数据库进行交互时，我们使用到了一个CodeSmith自带的组件SchemaExplorer，利用这个组件我们可以访问数据库的数据表、存储过程、视图等，并可以得到相应的数据类型、标识列、列的（字段）名称等信息。
// 下面这个例子是教我们如何生成一个存储过程，虽然网上有很多一样的例子，但是我是从CodeSmith中的英文帮助中自己翻译出来的：）
// 使用的是SQL Server 2000自带的Northwind数据库，生成一个关于Orders订单表的更新存储过程。

// 第一步还是指明模板使用的语言和生成的目标语言。

<%@ CodeTemplate Language="C#" TargetLanguage="T-SQL" Description="Generates a update stored procedure." %>


// 第二步就是我们要加载使用访问数据库的组件SchemaExplorer，并声明其使用的命名空间。

<%@ Assembly Name="SchemaExplorer" %>
<%@ Import Namespace="SchemaExplorer" %>


// 因为是针对表去生成存储过程，则首先要定义一个存储表名称使用的变量，然后指明这个变量类型为数据库中的表，这样我们可以通过这个数据表类型的变量得到相应的表的信息。

<%@ Property Name="SourceTable" Type="SchemaExplorer.TableSchema" Category="Context"  Description="Table that the stored procedures should be based on." %>


// 如果想访问视图的话，则将变量类型Type中的SchemaExplorer.TableSchema修改为SchemaExplorer.ViewSchema即可。
// 得到表名的方法

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) { %>,<% } %>
<% } %>


// 调用的GetSqlParameterStatement方法是用来生成参数的字符串，例如生成“@CustomerID nchar(5)”，后边紧跟的if判断是用来生成参数之间相隔使用的逗号的。
// 生成参数字符串的方法，参数为SchemaExplorer.ColumnSchema列类型

 <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>


// 下面来生成需要更新的字段，更新时仅能更新非主键字段的值，在SchemaExplorer中支持这种区别，使用SourceTable.NonPrimaryKeyColumns即可得到非主键字段的集合。

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) { %>,<% } %>
     <% } %>

// 然后再使用SourceTable.PrimaryKey.MemberColumns得到数据表中的主键集合，生成更新条件

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>
  
 -----------------------------------------------------------------
 -- 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[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 %>
       <% } %>

//循环所有列
<%foreach(ColumnSchema col inTable.Columns){ %>
public<%= col.DataType %><%=col.Name %>{ get;set; }
<% } %>