草庐IT

基于CodeSmith提高开发效率

轻风博客 2023-03-28 原文

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/

 

作者|李丙龙

CodeSmith基于nbspsectionDbType敏捷开发

有关基于CodeSmith提高开发效率的更多相关文章

  1. ruby - 使用 C 扩展开发 ruby​​gem 时，如何使用 Rspec 在本地进行测试？ - 2

    我正在编写一个包含C扩展的gem。通常当我写一个gem时，我会遵循TDD的过程，我会写一个失败的规范，然后处理代码直到它通过，等等......在“ext/mygem/mygem.c”中我的C扩展和在gemspec的“扩展”中配置的有效extconf.rb，如何运行我的规范并仍然加载我的C扩展？当我更改C代码时，我需要采取哪些步骤来重新编译代码？这可能是个愚蠢的问题，但是从我的gem的开发源代码树中输入“bundleinstall”不会构建任何native扩展。当我手动运行rubyext/mygem/extconf.rb时，我确实得到了一个Makefile(在整个项目的根目录中)，然后当

  2. Ruby Sinatra 配置用于生产和开发 - 2

    我已经在Sinatra上创建了应用程序，它代表了一个简单的API。我想在生产和开发上进行部署。我想在部署时选择，是开发还是生产，一些方法的逻辑应该改变，这取决于部署类型。是否有任何想法，如何完成以及解决此问题的一些示例。例子:我有代码get'/api/test'doreturn"Itisdev"end但是在部署到生产环境之后我想在运行/api/test之后看到ItisPROD如何实现？ 最佳答案 根据SinatraDocumentation:EnvironmentscanbesetthroughtheRACK_ENVenvironm

  3. ruby - 是否可以覆盖 gemfile 进行本地开发？ - 2

    我们的git存储库中目前有一个Gemfile。但是，有一个gem我只在我的环境中本地使用(我的团队不使用它)。为了使用它，我必须将它添加到我们的Gemfile中，但每次我checkout到我们的master/dev主分支时，由于与跟踪的gemfile冲突，我必须删除它。我想要的是类似Gemfile.local的东西，它将继承从Gemfile导入的gems，但也允许在那里导入新的gems以供使用只有我的机器。此文件将在.gitignore中被忽略。这可能吗？ 最佳答案 设置BUNDLE_GEMFILE环境变量:BUNDLE_GEMFI

  4. ruby - 在 Windows 机器上使用 Ruby 进行开发是否会适得其反？ - 2

    这似乎非常适得其反，因为太多的gem会在window上破裂。我一直在处理很多mysql和ruby​​-mysqlgem问题(gem本身发生段错误，一个名为UnixSocket的类显然在Windows机器上不能正常工作，等等)。我只是在浪费时间吗？我应该转向不同的脚本语言吗？ 最佳答案 我在Windows上使用Ruby的经验很少，但是当我开始使用Ruby时，我是在Windows上，我的总体印象是它不是Windows原生系统。因此，在主要使用Windows多年之后，开始使用Ruby促使我切换回原来的系统Unix，这次是Linux。Rub

  5. ruby-on-rails - 在 Rails 开发环境中为 .ogv 文件设置 Mime 类型 - 2

    我正在玩HTML5视频并且在ERB中有以下片段:mp4视频从在我的开发环境中运行的服务器很好地流式传输到chrome。然而firefox显示带有海报图像的视频播放器，但带有一个大X。问题似乎是mongrel不确定ogv扩展的mime类型，并且只返回text/plain，如curl所示:$curl-Ihttp://0.0.0.0:3000/pr6.ogvHTTP/1.1200OKConnection:closeDate:Mon,19Apr201012:33:50GMTLast-Modified:Sun,18Apr201012:46:07GMTContent-Type:text/plain

  6. 世界前沿3D开发引擎HOOPS全面讲解——集3D数据读取、3D图形渲染、3D数据发布于一体的全新3D应用开发工具 - 2

    无论您是想搭建桌面端、WEB端或者移动端APP应用，HOOPSPlatform组件都可以为您提供弹性的3D集成架构，同时，由工业领域3D技术专家组成的HOOPS技术团队也能为您提供技术支持服务。如果您的客户期望有一种在多个平台（桌面/WEB/APP，而且某些客户端是“瘦”客户端）快速、方便地将数据接入到3D应用系统的解决方案，并且当访问数据时，在各个平台上的性能和用户体验保持一致，HOOPSPlatform将帮助您完成。利用HOOPSPlatform，您可以开发在任何环境下的3D基础应用架构。HOOPSPlatform可以帮您打造3D创新型产品，HOOPSSDK包含的技术有：快速且准确的CAD

  7. 程序员如何提高代码能力？ - 2

    前言作为一名程序员，自己的本质工作就是做程序开发，那么程序开发的时候最直接的体现就是代码，检验一个程序员技术水平的一个核心环节就是开发时候的代码能力。众所周知，程序开发的水平提升是一个循序渐进的过程，每一位程序员都是从“菜鸟”变成“大神”的，所以程序员在程序开发过程中的代码能力也是根据平时开发中的业务实践来积累和提升的。提高代码能力核心要素程序员要想提高自身代码能力，尤其是新晋程序员的代码能力有很大的提升空间的时候，需要针对性的去提高自己的代码能力。提高代码能力其实有几个比较关键的点，只要把握住这些方面，就能很好的、快速的提高自己的一部分代码能力。1、多去阅读开源项目，如有机会可以亲自参与开源

  8. 叮咚买菜基于 Apache Doris 统一 OLAP 引擎的应用实践 - 2

    导读：随着叮咚买菜业务的发展，不同的业务场景对数据分析提出了不同的需求，他们希望引入一款实时OLAP数据库，构建一个灵活的多维实时查询和分析的平台，统一数据的接入和查询方案，解决各业务线对数据高效实时查询和精细化运营的需求。经过调研选型，最终引入ApacheDoris作为最终的OLAP分析引擎，Doris作为核心的OLAP引擎支持复杂地分析操作、提供多维的数据视图，在叮咚买菜数十个业务场景中广泛应用。作者｜叮咚买菜资深数据工程师韩青叮咚买菜创立于2017年5月，是一家专注美好食物的创业公司。叮咚买菜专注吃的事业，为满足更多人“想吃什么”而努力，通过美好食材的供应、美好滋味的开发以及美食品牌的孵

  9. 【鸿蒙应用开发系列】- 获取系统设备信息以及版本API兼容调用方式 - 2

    在应用开发中，有时候我们需要获取系统的设备信息，用于数据上报和行为分析。那在鸿蒙系统中，我们应该怎么去获取设备的系统信息呢，比如说获取手机的系统版本号、手机的制造商、手机型号等数据。1、获取方式这里分为两种情况，一种是设备信息的获取，一种是系统信息的获取。1.1、获取设备信息获取设备信息，鸿蒙的SDK包为我们提供了DeviceInfo类，通过该类的一些静态方法，可以获取设备信息，DeviceInfo类的包路径为：ohos.system.DeviceInfo.具体的方法如下：ModifierandTypeMethodDescriptionstatic StringgetAbiList​()Obt

  10. 基于C#实现简易绘图工具【100010177】 - 2

    C#实现简易绘图工具一.引言实验目的:通过制作窗体应用程序(C#画图软件),熟悉基本的窗体设计过程以及控件设计,事件处理等,熟悉使用C#的winform窗体进行绘图的基本步骤,对于面向对象编程有更加深刻的体会.Tutorial任务设计一个具有基本功能的画图软件**·包括简单的新建文件,保存,重新绘图等功能**·实现一些基本图形的绘制,包括铅笔和基本形状等,学习橡皮工具的创建**·设计一个合理舒适的UI界面**注明:你可能需要先了解一些关于winform窗体应用程序绘图的基本知识,以及关于GDI+类和结构的知识二.实验环境Windows系统下的visualstudio2017C#窗体应用程序三.

随机推荐