CodeSmith 使用教程(2): 编写第一个代码模板

迷南。 2023-10-16 19:07 31阅读 0赞

在[CodeSmith 使用教程(1): 概述][CodeSmith _1_]我们通过使用CodeSmith从数据库自动生成NHiberate代码，可以了解到使用CodeSmith自动生成代码的基本步骤：

1.  选择使用合适的模板，CodeSmith随开发包自带了大量常用的模板，如果找不到合适的模板，CodeSmith支持自定义模板。
2.  为模板选择合适的参数设置。
3.  自动生成代码（可以为任意类型的代码，C\#，Java, .XML 文本等）

[![20130103001][]][20130103001 1]

其核心为代码模板文件，随CodeSmith自带了不少常用的模板，可以通过模板浏览器来查询，此外网上也有很多第三方开发的模板，在使用前可以先查查是否已有现成的模板，或是可以通过修改现有的模板来完成自动生成代码的需要。

在开发应用时，很多人都喜欢通过复制以前的项目中的代码，然后通过修改以满足新项目，这些重用的代码通常具有很多共性（可以想想C++的模板类，C\#的Generic等），CodeSmith就是用来为这些具有相似性的代码创建模板，然后通过设置属性（代码直接的不同点），就可以自动创建所需代码。

本例通过一个简单的例子来介绍创建一个自定义代码模板的方法。CodeSmith提供了Visual Studio的集成开发环境的支持，本例也是通过创建模板自动生成简化每个的C\#项目都需要的 AssemblyInfo.cs，在开发C\# 应用时，一般是通过手工修改AssemblyInfo.cs的中属性（或者是Copy & Paste ：-）).

首先我们使用Visual Studio创建一个C\# HelloWorld下面（Console或是WinForm项目都可以），可以打开项目中的 AssemblyInfo.cs

**\[csharp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  using System.Reflection;
2.  using System.Runtime.CompilerServices;
3.  using System.Runtime.InteropServices;
4.  
5.  // General Information about an assembly is controlled through the following
6.  // set of attributes. Change these attribute values to modify the information
7.  // associated with an assembly.
8.  \[assembly: AssemblyTitle("HelloWorld")\]
9.  \[assembly: AssemblyDescription("")\]
10. \[assembly: AssemblyConfiguration("")\]
11. \[assembly: AssemblyCompany("Microsoft")\]
12. \[assembly: AssemblyProduct("HelloWorld")\]
13. \[assembly: AssemblyCopyright("Copyright © Microsoft 2013")\]
14. \[assembly: AssemblyTrademark("")\]
15. \[assembly: AssemblyCulture("")\]
16. 
17. // Setting ComVisible to false makes the types in this assembly not visible
18. // to COM components. If you need to access a type in this assembly from
19. // COM, set the ComVisible attribute to true on that type.
20. \[assembly: ComVisible(false)\]
21. 
22. // The following GUID is for the ID of the typelib if this project is exposed to COM
23. \[assembly: Guid("72797715-64b9-4bab-a49f-f55e8a0a18d7")\]
24. 
25. // Version information for an assembly consists of the following four values:
26. //
27. // Major Version
28. // Minor Version
29. // Build Number
30. // Revision
31. //
32. // You can specify all the values or you can default the Build and Revision Numbers
33. // by using the '\*' as shown below:
34. // \[assembly: AssemblyVersion("1.0.\*")\]
35. \[assembly: AssemblyVersion("1.0.0.0")\]
36. \[assembly: AssemblyFileVersion("1.0.0.0")\]

using System.Reflection;
    using System.Runtime.CompilerServices;
    using System.Runtime.InteropServices;
    
    // General Information about an assembly is controlled through the following
    // set of attributes. Change these attribute values to modify the information
    // associated with an assembly.
    [assembly: AssemblyTitle("HelloWorld")]
    [assembly: AssemblyDescription("")]
    [assembly: AssemblyConfiguration("")]
    [assembly: AssemblyCompany("Microsoft")]
    [assembly: AssemblyProduct("HelloWorld")]
    [assembly: AssemblyCopyright("Copyright © Microsoft 2013")]
    [assembly: AssemblyTrademark("")]
    [assembly: AssemblyCulture("")]
    
    // Setting ComVisible to false makes the types in this assembly not visible
    // to COM components.  If you need to access a type in this assembly from
    // COM, set the ComVisible attribute to true on that type.
    [assembly: ComVisible(false)]
    
    // The following GUID is for the ID of the typelib if this project is exposed to COM
    [assembly: Guid("72797715-64b9-4bab-a49f-f55e8a0a18d7")]
    
    // Version information for an assembly consists of the following four values:
    //
    //      Major Version
    //      Minor Version
    //      Build Number
    //      Revision
    //
    // You can specify all the values or you can default the Build and Revision Numbers
    // by using the '*' as shown below:
    // [assembly: AssemblyVersion("1.0.*")]
    [assembly: AssemblyVersion("1.0.0.0")]
    [assembly: AssemblyFileVersion("1.0.0.0")]

为了使用CodeSmith，我们在HelloWorld中添加CodeSmith的项目文件并创建一个模板文件AssemblyInfo.cst  
[![20130103002][]][20130103002 1]创建好的项目文件如下：  
[![20130103003][]][20130103003 1]

编写CodeSmith的代码模板和编写Asp.Net 的Page非常类似，CodeSmith支持以C\#，VB.Net和JavaScript做为脚本语言来编写模板，本例使用C\#做为脚本语言（源代码/语言），计划生成的也是C\#语言（目标代码/语言），打开AssemblyInfo.cst，修改代码为

**\[csharp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  <%@ CodeTemplate Language="C\#" TargetLanguage="C\#" Description="Create an AssemblyInfo.cs file." %>

<%@ CodeTemplate Language="C#" TargetLanguage="C#" Description="Create an AssemblyInfo.cs file." %>

每个CodeSmith的代码模板都是以[CodeTemplate][]开始，定义代码模板使用的源语言，目标语言和简单的描述。

然后将这个模板添加到CodeSmith项目中，可以右键单击codesmith.csp ,选择Add output

![20121022002.png][]

这时CodeSmith的项目将创建好了，但单击”Generate code” 不会生成任何代码，因为我们的代码模板AssemblyInfo.cst 没做任何事。

创建代码模板可以从生成的结果开始，可以直接先把要生成的代码复制到代码模板AssemblyInfo.cst中，比如：

**\[csharp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  using System.Reflection;
2.  using System.Runtime.CompilerServices;
3.  //
4.  // Created: 1/1/2013
5.  // Author: James Shen
6.  //
7.  \[assembly: AssemblyTitle("User storage utility")\]
8.  \[assembly: AssemblyDescription("Helps manage data in Isolated Storage files.")\]
9.  \[assembly: AssemblyConfiguration("Retail")\]
10. \[assembly: AssemblyCompany("Guidebee Pty Ltd, Inc.")\]
11. \[assembly: AssemblyProduct("StorageScan")\]
12. \[assembly: AssemblyCopyright("Copyright (c) Guidebee Pty Ltd.")\]
13. \[assembly: AssemblyCulture("")\]
14. \[assembly: AssemblyVersion("1.0.\*")\]
15. \[assembly: AssemblyFileVersion("1.0")\]
16. \[assembly: AssemblyDelaySign(true)\]

using System.Reflection;
    using System.Runtime.CompilerServices;
    //
    // Created: 1/1/2013
    // Author: James Shen
    //
    [assembly: AssemblyTitle("User storage utility")]
    [assembly: AssemblyDescription("Helps manage data in Isolated Storage files.")]
    [assembly: AssemblyConfiguration("Retail")]
    [assembly: AssemblyCompany("Guidebee Pty Ltd, Inc.")]
    [assembly: AssemblyProduct("StorageScan")]
    [assembly: AssemblyCopyright("Copyright (c) Guidebee Pty Ltd.")]
    [assembly: AssemblyCulture("")]
    [assembly: AssemblyVersion("1.0.*")]
    [assembly: AssemblyFileVersion("1.0")]
    [assembly: AssemblyDelaySign(true)]

可以把要生成的代码模板的内容分成三部分：

*  固定内容
 *  可以通过代码动态生成的部分（如上面的日期）
 *  需要用户提供属性配置的部分

此时如果使用Codesmith 的Generate Codes, 将自动生成AssemblyInfo.cs (缺省为模板名），不过AssemblyInfo.cs位置不是我们所需的Properties/AssemblyInfo.cs, 这可以通过重载代码模板的GetFileName方法来实现：

**\[csharp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  <%@ CodeTemplate Language="C\#" TargetLanguage="C\#"
2.  Description="Create an AssemblyInfo.cs file." %>
3.  ...
4.  <script runat="template">
5.  public override string GetFileName() \{
6.  return "Properties/AssemblyInfo.cs";
7.  \}
8.  </script>

<%@ CodeTemplate Language="C#" TargetLanguage="C#"
      Description="Create an AssemblyInfo.cs file." %>
    ...
    <script runat="template">
    public override string GetFileName() {
        return "Properties/AssemblyInfo.cs";
    }
    </script>

这样在使用CodeSmith项目的Generate Codes，就自动覆盖原来的Properties/AssemblyInfo.cs文件。 内容就是模板中的代码部分。  
但每次生成的代码都是固定的，作为模板来说没有什么灵活性，下面我们可以通过检查模板的内容，觉定那些内容是可变的。比如AssemblyInfo.cs的日期和Assembly的各个属性对于不同的项目来说是可变的。  
这些可变的内容其中一部分可以通过代码自动生成（如日期），有一部分需要用户来配置，比如AssemblyTitle，AssemblyDescription等。  
对于日期部分可以通过C\#代码实现如下：

**\[csharp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  // Created: <%= DateTime.Now.ToLongDateString() %>

// Created: <%= DateTime.Now.ToLongDateString() %>

可以看出来CodeSmith的模板文件如AssemblyInfo.cst 和Asp.Net的Page文件中功能是非常类似，可以通过<%= 和%>直接嵌入C\#代码（或VB.Net，JavaScripts)。

对于属性来说，可以通过先定义属性：

**\[csharp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  <%@ Property Name="Author" Type="System.String" Description="Lead author of the project." %>
2.  <%@ Property Name="Title" Type="System.String" Description="Title of the project." %>
3.  <%@ Property Name="Description" Type="System.String" Description="Description of the project." %>
4.  <%@ Property Name="Configuration" Type="System.String" Default="Debug" Description="Project configuration." %>
5.  <%@ Property Name="Company" Type="System.String" Default="Guidebee Pty Ltd." %>
6.  <%@ Property Name="Product" Type="System.String" Description="Product Name." %>
7.  <%@ Property Name="Version" Type="System.String" Default="1.0.\*" Description=".NET assembly version." %>
8.  <%@ Property Name="FileVersion" Type="System.String" Default="1.0" Description="Win32 file version." %>

<%@ Property Name="Author" Type="System.String" Description="Lead author of the project." %>
    <%@ Property Name="Title" Type="System.String" Description="Title of the project." %>
    <%@ Property Name="Description" Type="System.String" Description="Description of the project." %>
    <%@ Property Name="Configuration" Type="System.String" Default="Debug" Description="Project configuration." %>
    <%@ Property Name="Company" Type="System.String" Default="Guidebee Pty Ltd." %>
    <%@ Property Name="Product" Type="System.String" Description="Product Name." %>
    <%@ Property Name="Version" Type="System.String" Default="1.0.*" Description=".NET assembly version." %>
    <%@ Property Name="FileVersion" Type="System.String" Default="1.0" Description="Win32 file version." %>

属性定义通过Property 定义，Name定义属性名，Type为属性的数据类型，Default定义属性的缺省值， Description可以定义属性的作用及说明。

然后就可以在C\#代码中使用这些属性，完整的代码模板如下：

**\[csharp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  <%@ CodeTemplate Language="C\#" TargetLanguage="C\#" Description="Create an AssemblyInfo.cs file." %>
2.  <%@ Property Name="Author" Type="System.String" Description="Lead author of the project." %>
3.  <%@ Property Name="Title" Type="System.String" Description="Title of the project." %>
4.  <%@ Property Name="Description" Type="System.String" Description="Description of the project." %>
5.  <%@ Property Name="Configuration" Type="System.String" Default="Debug" Description="Project configuration." %>
6.  <%@ Property Name="Company" Type="System.String" Default="Guidebee Pty Ltd." %>
7.  <%@ Property Name="Product" Type="System.String" Description="Product Name." %>
8.  <%@ Property Name="Version" Type="System.String" Default="1.0.\*" Description=".NET assembly version." %>
9.  <%@ Property Name="FileVersion" Type="System.String" Default="1.0" Description="Win32 file version." %>
10. using System.Reflection;
11. using System.Runtime.CompilerServices;
12. //
13. // Created: <%= DateTime.Now.ToLongDateString() %>
14. // Author: <%= Author %>
15. //
16. \[assembly: AssemblyTitle("<%= Title %>")\]
17. \[assembly: AssemblyDescription("<%= Description %>")\]
18. \[assembly: AssemblyConfiguration("<%= Configuration %>")\]
19. \[assembly: AssemblyCompany("<%= Company %>")\]
20. \[assembly: AssemblyProduct("<%= Product %>")\]
21. \[assembly: AssemblyCopyright("Copyright (c) <%= DateTime.Now.Year.ToString() %> <%= Company %>")\]
22. \[assembly: AssemblyCulture("")\]
23. \[assembly: AssemblyVersion("<%= Version %>")\]
24. \[assembly: AssemblyFileVersion("<%= FileVersion %>")\]
25. \[assembly: AssemblyDelaySign(true)\]

<%@ CodeTemplate Language="C#" TargetLanguage="C#" Description="Create an AssemblyInfo.cs file." %>
    <%@ Property Name="Author" Type="System.String" Description="Lead author of the project." %>
    <%@ Property Name="Title" Type="System.String" Description="Title of the project." %>
    <%@ Property Name="Description" Type="System.String" Description="Description of the project." %>
    <%@ Property Name="Configuration" Type="System.String" Default="Debug" Description="Project configuration." %>
    <%@ Property Name="Company" Type="System.String" Default="Guidebee Pty Ltd." %>
    <%@ Property Name="Product" Type="System.String" Description="Product Name." %>
    <%@ Property Name="Version" Type="System.String" Default="1.0.*" Description=".NET assembly version." %>
    <%@ Property Name="FileVersion" Type="System.String" Default="1.0" Description="Win32 file version." %>
    using System.Reflection;
    using System.Runtime.CompilerServices;
    //
    // Created: <%= DateTime.Now.ToLongDateString() %>
    // Author:  <%= Author %>
    //
    [assembly: AssemblyTitle("<%= Title %>")]
    [assembly: AssemblyDescription("<%= Description %>")]
    [assembly: AssemblyConfiguration("<%= Configuration %>")]
    [assembly: AssemblyCompany("<%= Company %>")]
    [assembly: AssemblyProduct("<%= Product %>")]
    [assembly: AssemblyCopyright("Copyright (c) <%= DateTime.Now.Year.ToString() %> <%= Company %>")]
    [assembly: AssemblyCulture("")]
    [assembly: AssemblyVersion("<%= Version %>")]
    [assembly: AssemblyFileVersion("<%= FileVersion %>")]
    [assembly: AssemblyDelaySign(true)]

此时如果需要“Generate output” 首先要配置代码模板的属性，这通过”Manage output” 来完成，

[![20130103004][]][20130103004 1]

次数如果打开codesmith.csp 文件可以看到为AssemblyInfo.cst 配置的属性内容：

**\[csharp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  <?xml version="1.0" encoding="utf-8"?>
2.  <codeSmith xmlns="http://www.codesmithtools.com/schema/csp.xsd">
3.  <propertySets>
4.  <propertySet name="AssemblyInfo" template="AssemblyInfo.cst">
5.  <property name="Configuration">Debug</property>
6.  <property name="Company">Guidebee Pty Ltd.</property>
7.  <property name="Version">1.0.\*</property>
8.  <property name="FileVersion">1.0</property>
9.  <property name="Author">James Shen</property>
10. <property name="Title">Code smith Demo</property>
11. <property name="Description">My First Template code</property>
12. <property name="Product">SandCastle</property>
13. </propertySet>
14. </propertySets>
15. </codeSmith>

<?xml version="1.0" encoding="utf-8"?>
    <codeSmith xmlns="http://www.codesmithtools.com/schema/csp.xsd">
      <propertySets>
        <propertySet name="AssemblyInfo" template="AssemblyInfo.cst">
          <property name="Configuration">Debug</property>
          <property name="Company">Guidebee Pty Ltd.</property>
          <property name="Version">1.0.*</property>
          <property name="FileVersion">1.0</property>
          <property name="Author">James Shen</property>
          <property name="Title">Code smith Demo</property>
          <property name="Description">My First Template code</property>
          <property name="Product">SandCastle</property>
        </propertySet>
      </propertySets>
    </codeSmith>

生成代码如下：

**\[csharp\]** [ view plain][view plain] [copy][view plain] [print][view plain] [?][view plain]

1.  using System.Reflection;
2.  using System.Runtime.CompilerServices;
3.  //
4.  // Created: Thursday, 3 January 2013
5.  // Author: James Shen
6.  //
7.  \[assembly: AssemblyTitle("Code smith Demo")\]
8.  \[assembly: AssemblyDescription("My First Template code")\]
9.  \[assembly: AssemblyConfiguration("Debug")\]
10. \[assembly: AssemblyCompany("Guidebee Pty Ltd.")\]
11. \[assembly: AssemblyProduct("SandCastle")\]
12. \[assembly: AssemblyCopyright("Copyright (c) 2013 Guidebee Pty Ltd.")\]
13. \[assembly: AssemblyCulture("")\]
14. \[assembly: AssemblyVersion("1.0.\*")\]
15. \[assembly: AssemblyFileVersion("1.0")\]
16. \[assembly: AssemblyDelaySign(true)\]

using System.Reflection;
    using System.Runtime.CompilerServices;
    //
    // Created: Thursday, 3 January 2013
    // Author:  James Shen
    //
    [assembly: AssemblyTitle("Code smith Demo")]
    [assembly: AssemblyDescription("My First Template code")]
    [assembly: AssemblyConfiguration("Debug")]
    [assembly: AssemblyCompany("Guidebee Pty Ltd.")]
    [assembly: AssemblyProduct("SandCastle")]
    [assembly: AssemblyCopyright("Copyright (c) 2013 Guidebee Pty Ltd.")]
    [assembly: AssemblyCulture("")]
    [assembly: AssemblyVersion("1.0.*")]
    [assembly: AssemblyFileVersion("1.0")]
    [assembly: AssemblyDelaySign(true)]

本例 [下载][Link 1]

[CodeSmith _1_]: http://www.imobilebbs.com/wordpress/archives/3549
[20130103001]: http://www.imobilebbs.com/wordpress/wp-content/uploads/2013/01/20130103001.png
[20130103001 1]: http://www.imobilebbs.com/wordpress/archives/4182/attachment/20130103001
[view plain]: http://blog.csdn.net/mapdigit/article/details/8471967#
[20130103002]: http://www.imobilebbs.com/wordpress/wp-content/uploads/2013/01/20130103002.png
[20130103002 1]: http://www.imobilebbs.com/wordpress/archives/4182/attachment/20130103002
[20130103003]: http://www.imobilebbs.com/wordpress/wp-content/uploads/2013/01/20130103003.png
[20130103003 1]: http://www.imobilebbs.com/wordpress/archives/4182/attachment/20130103003
[CodeTemplate]: http://docs.codesmithtools.com/display/Generator/The+CodeTemplate+Directive
[20121022002.png]: http://www.imobilebbs.com/wordpress/wp-content/uploads/2012/10/20121022002.png
[20130103004]: http://www.imobilebbs.com/wordpress/wp-content/uploads/2013/01/20130103004.png
[20130103004 1]: http://www.imobilebbs.com/wordpress/archives/4182/attachment/20130103004
[Link 1]: http://www.imobilebbs.com/download/codesmith/HelloWorld.zip