基于CodeSmith提高开发效率

原创李丙龙之家技术

关注“之家技术”，获取更多技术干货

总篇151篇 2022年第26篇

CodeSmith简介

CodeSmith 是一种基于模板的代码生成工具，它使用类似于 ASP.NET 的语法来生成任意类型的代码或文本。与其他许多代码生成工具不同，CodeSmith 不要求您订阅特定的应用程序设计或体系结构。使用 CodeSmith，可以生成包括简单的强类型集合和完整应用程序在内的任何东西。当您生成应用程序时，您经常需要重复完成某些特定的任务，例如编写数据访问代码或者生成自定义集合。CodeSmith 在这些时候特别有用，因为您可以编写模板自动完成这些任务，从而不仅提高您的工作效率，而且能够自动完成那些最为乏味的任务。CodeSmith 附带了许多模板，包括对应于所有 .NET 集合类型的模板以及用于生成存储过程的模板，但该工具的真正威力在于能够创建自定义模板。

为什么要用代码生成器

²代码生成器生成代码可以减少人为手误书写的bug

²可以提高代码开发效率，简化开发流程

²可以使输出文档、代码规范化

代码生成模板编写

生成模板采用asp.net的语法编写，语法简单易懂，对熟悉 asp.net 开发人员很友好。即使没有做个 asp.net 开发也可以简单学习后进行模板编写。

1. 编写模板的基础需要引入数据表，在模板中可以很简单的引入一些生成代码的配置项

1.<%@ CodeTemplate Language="C#" TargetLanguage="Java" Src="" Inherits="" Debug="False" Description="" ResponseEncoding="UTF-8" %>  
2.<%@ Property Name="package" Type="System.String" Default="Che168.Model" Optional="False" Category="Strings" Description="实体类命名空间" %>  
3.<%@ Property Name="SourceTable" Type="SchemaExplorer.TableSchema" Optional="False" Category="Configs" Description="源表" %>  
4.<%@ Property Name="SourceTable2" Type="SchemaExplorer.TableSchema"  Optional="True" Category="Configs" Description="字段备注来源表" %>  
5.<%@ Property Name="SourceTable3" Type="SchemaExplorer.TableSchema"  Optional="True" Category="Configs" Description="字段备注来源表" %>  
6.<%@ Property Name="SourceTable4" Type="SchemaExplorer.TableSchema"  Optional="True" Category="Configs" Description="字段备注来源表" %>
7.<%@ Property Name="IsSpringBoot" Type="System.Boolean" Category="Configs" Description="是否是SpringBoot bean，如果是，则生成api说明备注" %>

Name：注册的配置的引用名称

Description：配置项的说明

Type：为控件的类型，支持内置以及 .net 的类型

SchemaExplorer.TableSchema：为选择数据源表

System.String：为文字输入控件

Optional：是否可选， False为必填

IsSpringBoot：是我们选择生成的bean是否要生成 swagger 说明

2.引入配置项之后就可以继续编写代码模板

比如生成java的bean

1.package <%=package%>import java.util.*;  
2. <%if(IsSpringBoot){ %>  
3.import io.swagger.annotations.*;  
4.<%} %>  
5.  
6./** 
7.*  <%=SourceTable.Description%>bean 
8.*/  
9.public class <%= SourceTable.Name%>  
10.{     
11.    <% foreach (ColumnSchema column in SourceTable.Columns) { %>        
12.    /**<%=  column.Description %>*/  
13.    <%if(IsSpringBoot){ %>  
14.    @ApiModelProperty(value = "<%= column.Description %>", name = "<%= column.Name.ToLower() %>")  
15.    <%} %>  
16.    <%= GetJavaType(column.DataType) %> <%= column.Name.ToLower() %> ;  
17.    <% } %>     
18.      
19.    <% foreach (ColumnSchema column in SourceTable.Columns) { %>        
20.      
21.    public void set<%=column.Name.ToLower().ToPascalName() %> (<%= GetJavaType(column.DataType) + " "+column.Name.ToLower() %> ) { this.<%= column.Name.ToLower()+" = "+ column.Name.ToLower()%>; }  
22.      
23.    public <%= GetJavaType(column.DataType) %> get<%=column.Name.ToLower().ToPascalName() %> () { return this.<%= column.Name.ToLower() %>;}  
24.    <% } %>         
25.}  
26.  
27.<script runat="template">  
28./// <summary>  
29.    /// 由DbType获取对应的Java 的 Type  
30.    /// </summary>  
31.    /// <param name="dbtype"></param>  
32.    /// <returns></returns>  
33.    public static string GetJavaType(System.Data.DbType dbtype)  
34.    {  
35.        switch (dbtype)  
36.        {  
37.            case DbType.Int16:   
38.            case DbType.UInt16:  
39.            case DbType.Int32:   
40.            case DbType.UInt32: return "Integer";  
41.            case DbType.Int64:   
42.            case DbType.UInt64: return "long";  
43.            case DbType.Byte: return "Integer";  
44.            case DbType.Date:  
45.            case DbType.DateTime:  
46.            case DbType.DateTime2: return "Date";  
47.            case DbType.String:  
48.            case DbType.StringFixedLength:  
49.            case DbType.AnsiString:  
50.            case DbType.AnsiStringFixedLength: return "String";  
51.            case DbType.Decimal: return "BigDecimal";  
52.            case DbType.Double:   
53.            //case DbType.Currency: return "Double";  
54.            case DbType.Currency: return "BigDecimal";  
55.            default: return "String" ;  
56.        }  
57.    }  
58.</script>

3. 数据类型转换

不同的目标语言都离不开数据类型的转换，所以我们应针对不同的目标语言书编写一个数据类型转换的方法。

比如上方的数据类型转换java类型的方法：

1.<script runat="template">  
2./// <summary>  
3.    /// 由DbType获取对应的Java 的 Type  
4.    /// </summary>  
5.    /// <param name="dbtype"></param>  
6.    /// <returns></returns>  
7.    public static string GetJavaType(System.Data.DbType dbtype)  
8.    {  
9.        switch (dbtype)  
10.        {  
11.            case DbType.Int16:   
12.            case DbType.UInt16:  
13.            case DbType.Int32:   
14.            case DbType.UInt32: return "Integer";  
15.            case DbType.Int64:   
16.            case DbType.UInt64: return "long";  
17.            case DbType.Byte: return "Integer";  
18.            case DbType.Date:  
19.            case DbType.DateTime:  
20.            case DbType.DateTime2: return "Date";  
21.            case DbType.String:  
22.            case DbType.StringFixedLength:  
23.            case DbType.AnsiString:  
24.            case DbType.AnsiStringFixedLength: return "String";  
25.            case DbType.Decimal: return "BigDecimal";  
26.            case DbType.Double:   
27.            //case DbType.Currency: return "Double";  
28.            case DbType.Currency: return "BigDecimal";  
29.            default: return "String" ;  
30.        }  
31.    }  
32.</script>

在模板中是可以书写我们自定义的方法，自定义方法用<script runat="template"> 包含起来，在模板中就可以调用了

4. 如何提取公共方法

在开发中我们不可能只生成某一种类型，比如我们需要生成model，表的增删改查语句，生成页面，但是离不开的是数据类型的转换，所以我们要把公共代码提取到某个模板文件，在各个模板引用这个文件，方法如下：

新建模板文件，将公共方法剪切到该模板文件，包含在标签中，在需要的模板引用该模板，如：<%@ Register Template="../Reference/Extends.cst" Name="ExtendsTools" MergeProperties="True" %>

那么我们这个文件就可以把上方的 GetJavaType 方法删除掉了。

模板中也可以引用外部的 c# 代码文件，<%@ Assembly Src="../Reference/SqlScriptExtend.cs" %>

模板中也可以引用外部程序集 <%@ Assembly Name="CodeSmithExtend" Path="../Reference" %> 引用之后同样可以在模板中调用引入的代码方法。

书写完模板我们编译后，模板就可以使用了，生成代码流程图如下：

经验分享

在实际的使用中，往往我们不只来源单表的代码生成，于是就可以书写支持sql。

1．首先在模板注册两个控件

2．<%@ Property Name="QuerySqlScript" Type="StringCollection" Editor="StringCollectionEditor" Category="数据源配置" Description="查询sql" Optional="True" OnChanged="QuerySqlScriptChange" %>

3．<%@ Property Name="SourceDatabase" Type="SchemaExplorer.DatabaseSchema" Category="数据源配置" Optional="True" Description="数据来源为sql查询时需要配置此数据库连接，以便生成查询列" %>

我们针对QuerySqlScript控件注册改变事件QuerySqlScriptChange

在该事件中，我们使用注册的数据源来执行我们输入的sql，来返回一个table结果，我们只需要关注列名称，然后我们用正则表达式从sql中匹配出表名称，再次分别用数据源查询sql中涉及的表的结构，此时我们将sql中的列，从获得的表结构中抽取出到我们声明的一个TableTableSchema 对象中，然后我们就可以继续在模板中使用该 TableSchema 来生成代码。

总结

同样的代码，如采用CodeSmith代码生成可减少 70% 的工作量，如 model的生成，表增删改的sql脚本，基础页面的生成，wiki的生成。

假如标准制定好，甚至可以达到不写一行代码。

同时代码生成还可以直接输出到文件。

官网地址 https://www.codesmithtools.com/

作者简介

汽车之家

李丙龙

二手车事业部-技术部

加入汽车之家二手车事业部多年，负责二手车线索、客户、交易等业务的研发工作

阅读更多：

▼ 关注「之家技术」，获取更多技术干货 ▼

继续滑动看下一个