代码生成工具dgen使用说明
前言
项目组希望能有一个比较完善，可以生成各类代码的工具，因为之前写过所以趁这两天重新弄了个。
代码生成工具命名为dgen -> dexcoder-generator，旨在提高开发人员效率，避免重复劳动。
理论上可以生成任何想要的代码文件，包括实体类、dao、service及页面文件等，另外可以方便的实现扩展生成自己想要的东西。
为了方便开发避免重复造轮子，依赖了一些开源的第三方组件，主要为dom4j，velocity。
dgen的使用步骤为：编写配置文件 -> 编写模板文件 -> 运行。
下面就按这个顺序对dgen进行说明，并会在最后介绍如何对dgen进行自定义的扩展。
配置文件说明
dgen默认的配置文件名为dgen.xml，当然可以随意改变它，只需在启动时指定文件名即可。
dgen.xml文件是所有配置的入口，里面包含了工具运行时需要的各类信息，当配置信息较多时可以拆分成多个文件，使用include标签引入。
dgen.xml文件样例：
<?xml version="1.0" encoding="UTF-8"?><config><constants><!--生成时文件已存在是否覆盖 默认true--><constant name="overwrite" value="true"/><!--生成目标文件夹 不指定默认为运行目录--><!--<constant name="targetDir" value="/Users/liyd/project"/>--><!--是否运行在子模块 为true则生成代码的文件夹会到上一层(父模块)为基准 默认false --><constant name="runOnChildModule" value="false"/></constants><!--jdbc连接信息配置--><jdbc><property name="dialect" value="mysql"/><property name="driverClassName" value="com.mysql.jdbc.Driver"/><property name="url" value="jdbc:mysql://localhost:3306/dexcoder?useUnicode=true&characterEncoding=utf-8"/><property name="username" value="root"/><property name="password" value=""/></jdbc><!--数据类型转换映射--><converters><convert dbType="number" javaType="java.lang.Long"/><convert dbType="VARCHAR2" javaType="java.lang.String"/><convert dbType="SYS.XMLTYPE" javaType="java.lang.String"/><convert dbType="TIMESTAMP" javaType="java.util.Date"/><convert dbType="datetime" javaType="java.util.Date"/><convert dbType="BLOB" javaType="java.lang.Byte[]"/></converters><include file="demo/tableConfig.xml"/></config>
config根标签，固定。constants常量标签，可以包含任意数量的constant子标签，每一个constant子标签都定义了一个常量。jdbc数据库连接配置信息。converters数据类型转换映射。dbType指定数据库的类型，javaType指定你期望在生成Java类中的类型。include标签，引入其它的配置文件（当然也可以不引入全部写在当前配置文件当中）。
这里把它拆分成了2个文件，使用了include标签，引入的tableConfig.xml文件样例：
<?xml version="1.0" encoding="UTF-8"?><config><table name="USER" desc="用户"><task name="model"/><task name="dao"/></table><tasks><task name="model" class="com.dexcoder.dgen.generator.DefaultCodeGenerator"><property name="template" value="demo/template/model.vm"/><property name="beginFix" value=""/><property name="endFix" value=""/><property name="suffix" value=".java"/><property name="moduleName" value="dexcoder-core"/><property name="srcDir" value="src/main/java"/><property name="package" value="com.dexcoder.model"/></task><task name="dao"><property name="template" value="demo/template/dao.vm"/><property name="beginFix" value=""/><property name="endFix" value="Dao"/><property name="suffix" value=".java"/><property name="moduleName" value="dexcoder-core"/><property name="srcDir" value="src/main/java"/><property name="package" value="com.dexcoder.dao"/></task><task name="daoImpl"><property name="template" value="demo/template/daoImpl.vm"/><property name="beginFix" value=""/><property name="endFix" value="DaoImpl"/><property name="suffix" value=".java"/><property name="moduleName" value="daoDir"/><property name="srcDir" value="src/main/java"/><property name="package" value="com.dexcoder.dao.impl"/></task><task name="service"><property name="template" value="demo/template/service.vm"/><property name="beginFix" value=""/><property name="endFix" value="Service"/><property name="suffix" value=".java"/><property name="moduleName" value="serviceDir"/><property name="srcDir" value="src/main/java"/><property name="package" value="com.dexcoder.service"/></task></tasks></config>
里面主要配置了各项任务的生成参数信息，及指定了哪张表需要生成哪些代码任务。
config标签，同样固定。table指定要生成代码的表名，desc是表的备注。可以配置多个多张表一起生成。task指定了该表需要运行哪几个生成任务来生成相应的代码。
tasks任务信息配置根标签。task具体的任务信息，name指定任务名。property指定运行该任务所需要的属性信息。以下几个为必须的固定属性：template指定模板文件。beginFix生成代码文件前缀。endFix生成代码文件后缀。suffix生成代码文件的扩展名。moduleName生成代码所在模块的模块名，多模块项目时有用。srcDir生成的源代码文件夹。package包名。
运行时参数说明
模板文件的编写需要依赖于一些运行时的动态参数，所以先对运行时的参数作一下说明。
这里的运行时参数，主要是为模板文件服务的，也就是在模板文件中可以直接使用的数据。主要有下面这些：
packageName生成的代码文件所在包名。importClasses需要导入的类，是一个List<String>集合。注意这里的导入类只是生成过程中产生的一些类型(如model中的变量类型)，其它的需要在模板中自行书写。date当前日期信息。table生成表的信息。name表名。desc表备注。columns包含的列信息。name列名。camelName骆驼命名法名称，首字母小写。firstUpperName骆驼命名法名称，首字母大写。isPrimaryKey是否主键。comment列备注。dbType数据库类型。jdbcTypejdbc类型。javaTypeJava类型，例：String。javaClassJava类型class名，例：java.lang.String。
tasks当前表拥有的代码生成任务。task当前运行的任务信息。name任务名。clazz任务处理的class。pluginMap任务包含的插件，Map<String,String>类型。properties任务包含的属性，Map<String,String>类型。
除了以上固定信息外，对于在任务运行时生成的一些类，可以用以下方式访问生成的类信息，这里假设生成的类为java.model.UserInfo。
taskName请替换成实际的任务名，另外任务需要在运行之后才能用该方式访问，对于一些有类依赖的生成，例如dao最好放在service之前生成以便在service中使用生成的dao类信息。
taskName.generatedLongClassName全类名，返回java.model.UserInfo。taskName.generatedShortClassName类名，返回UserInfo。taskName.firstLowerGeneratedClassName首字母小写类名，返回userInfo。taskName.lineThroughClassName中划线分隔小写类名，返回user-info。
编写模板文件
模板采用了velocity组件来实现，根据上面介绍的动态参数可以很容易的完成模板的编写。下面是几个模板的样例。
model类模板：
package ${packageName};#foreach($im in ${importClasses})import ${im};#end/*** ${table.desc}** Author: Created by code generator* Date: ${date}*/public class ${model.generatedShortClassName} {/** serialVersionUID */private static final long serialVersionUID = ${serialVersionUID}L;#foreach($column in ${table.columns})#if(${column.comment})/** ${column.comment} */#endprivate ${column.javaType} ${column.camelName};#end#foreach($column in ${table.columns})public ${column.javaType} get${column.firstUpperCamelName}() {return ${column.camelName};}public void set${column.firstUpperCamelName}(${column.javaType} ${column.camelName}) {this.${column.camelName} = ${column.camelName};}#end}
dao接口模板，这里只生成了一个insert方法。
package ${packageName};import ${model.generatedLongClassName};/*** ${table.desc} dao接口** Author: Created by code generator* Date: ${date}*/public interface ${dao.generatedShortClassName} {/*** 新增记录** @param ${model.firstLowerGeneratedClassName}*/void insert(${model.generatedShortClassName} ${model.firstLowerGeneratedClassName});}
运行
代码调用方式
只需一行代码：
StartupGenerator.run();
指定配置文件名，文件路径相对于当前运行项目目录：
StartupGenerator.run("demo/dgen.xml");
jar包执行方式
直接运行：
java -jar codeGenerator.jar
指定配置文件名，文件路径相对于当前运行项目目录：
java -jar codeGenerator.jar demo/dgen.xml
扩展
有些时候可能默认的功能无法满足项目的需求，你可以通过编写一些自定义扩展来增强dgen的功能。
插件实现
插件演示一
这里以model类实现了序列化，生成需要serialVersionUID为例，dgen默认并没有提供，可以通过简单的插件方式来实现(该插件已内置实现)。
首先实现GeneratorPlugin接口，该接口只有一个方法：
/*** 插件执行方法** @param table 当前运行任务表配置信息* @param task 当前运行任务配置信息* @param configuration 所有的配置信息* @param templateText 模板内容* @param context 模板解析时的VelocityContext*/void execute(Table table, Task task, Configuration configuration, StringBuilder templateText,VelocityContext context);
方法的参数中可以拿到所有的想要的信息，包括表信息、任务信息、dgen配置信息、模板内容、模板解析时的VelocityContext等，按需使用即可。
下面是serialVersionUID插件的实现代码：
public void execute(Table table, Task task, Configuration configuration, StringBuilder templateText,VelocityContext context) {long serialVersionUID = Math.abs(UUID.randomUUID().getLeastSignificantBits());context.put("serialVersionUID", serialVersionUID);}
只是添加了serialVersionUID变量，这样在model模板中就可以使用了，添加下面代码即可：
/** serialVersionUID */private static final long serialVersionUID = ${serialVersionUID}L;
当然别忘了把它添加到任务配置中：
<task name="model" class="com.dexcoder.dgen.generator.DefaultCodeGenerator"><plugin name="serialVersionUIDPlugin" value="com.dexcoder.dgen.plugins.SerialVersionUIDPlugin"/><property name="template" value="demo/template/model.vm"/><property name="beginFix" value=""/><property name="endFix" value=""/><property name="suffix" value=".java"/><property name="moduleName" value="dexcoder-core"/><property name="srcDir" value="src/main/java"/><property name="package" value="com.dexcoder.model"/></task>
插件演示二
我们再来实现一个Excel表格生成插件，假设我们在生成model类的同时想生成一份表结构的Excel文件。
实现的步骤上相同，只需要修改方法实现部分即可，以下是源代码，这里对Excel生成时行了封装，不在本文讨论范围：
public void execute(Table table, Task task, Configuration configuration, StringBuilder templateText,VelocityContext context) {ExcelSheet excelSheet = new ExcelSheet();excelSheet.setSheetName("表信息");List<String> rowTitles = new ArrayList<String>();rowTitles.add("列名");rowTitles.add("列备注");rowTitles.add("数据库类型");rowTitles.add("是否主键");excelSheet.setRowTitles(rowTitles);List<ExcelRow> rowList = new ArrayList<ExcelRow>();for (Column column : table.getColumns()) {ExcelRow excelRow = new ExcelRow();excelRow.addCell(column.getName());excelRow.addCell(column.getComment());excelRow.addCell(column.getDbType());excelRow.addCell(column.getIsPrimaryKey());rowList.add(excelRow);}excelSheet.setRows(rowList);List<ExcelSheet> sheetList = new ArrayList<ExcelSheet>();sheetList.add(excelSheet);ExcelWriteTools.write(sheetList, new File("/Users/liyd/Desktop/db.xls"));}
代码生成简单自定义重写
如果使用插件的方式无法满足你的需求，可以自己实现代码生成的方法，只需要继承AbstractCodeGenerator类实现generate方法即可。
默认的生成类为DefaultCodeGenerator：
/*** 默认代码生成实现类** User: liyd* Date: 13-12-16* Time: 下午4:28*/public class DefaultCodeGenerator extends AbstractCodeGenerator {/*** 代码生成方法** @param table* @param task* @param context* @param template*/@Overridepublic void generate(Table table, Task task, VelocityContext context, StringBuilder template) {Set<String> importClasses = this.getColumnsImportClass(table.getColumns());context.put("importClasses", importClasses);context.put("date", new Date());context.put("table", table);context.put("task", task);context.put("packageName", task.getPackageName());//任务生成的类信息String generatedLongClassName = task.getGeneratedReferenceClassName(table.getName());String generatedShotClassName = task.getGeneratedShotClassName(table.getName());String firstLowerGeneratedClassName = NameUtils.getFirstLowerName(generatedShotClassName);String lineThroughClassName = NameUtils.getLineThroughName(generatedShotClassName);Map<String, String> map = new HashMap<String, String>();map.put("generatedLongClassName", generatedLongClassName);map.put("generatedShortClassName", generatedShotClassName);map.put("firstLowerGeneratedClassName", firstLowerGeneratedClassName);map.put("lineThroughClassName", lineThroughClassName);context.put(task.getName(), map);}}
可以看到只是往VelocityContext中添加了一些数据而已，在这里完全可以根据你自己的想法来实现一些特别的功能，至于如何读取模板、生成文件则不用去关心，默认都会帮你完成。
重写代码生成接口实现重写
假设上面的简单重写还无法满足需求，例如你想要对模板读取、插件运行、文件生成等方式做一些改变，那么可以直接实现接口CodeGenerator，只需要实现一个方法：
/*** 代码生成方法* @param table 当前运行表信息* @param task 当前运行任务信息* @param configuration 所有的配置信息*/void doGenerate(Table table, Task task, Configuration configuration);
参数中可以获取到运行的表、任务及所有的配置信息，可以根据自己的需要完全改写dgen的代码生成行为。
可以参考AbstractCodeGenerator和DefaultCodeGenerator中的实现。
当然，最后仍然是别忘了在任务配置中指定实现类：
<task name="model" class="com.dexcoder.dgen.test.CustomCodeGenerator">......</task>
扩展xml配置文件
有时候可能会需要在dgen.xml配置文件中添加一些新的标签以使增加的扩展功能实现的更加优雅，这个同样可以很好的支持。
只需要实现XmlElementParser接口：
public interface XmlElementParser {/*** 解析的元素名称** @return*/String getParseElementName();/*** 解析元素** @param element* @param configuration*/void parseElement(Element element, Configuration configuration);}
getParseElementName方法只需要返回该解析类解析的xml元素标签名称，当dgen运行时解析到该元素标签时便会调用parseElement方法，以完成你想要的操作。
以下是jdbc标签的解析类实现，供参考：
public class JdbcParser extends AbstractXmlElementParser {public String getParseElementName() {return "jdbc";}@Overridepublic void doParseElement(Element element, Configuration configuration) {List<Element> elements = element.elements("property");if (CollectionUtils.isEmpty(elements)) {return;}for (Element el : elements) {String name = el.attributeValue("name");String value = el.attributeValue("value");configuration.addJdbcConfig(name, value);}}}
最后，用以下代码运行：
ConfigParser configParser = new ConfigParser();//这里注册实现的xml标签解析器 JdbcParser是内置解析器默认已注册//configParser.registerParser(new JdbcParser());Configuration configuration = configParser.parseConfig(configFile);GenerationManager generationManager = new GenerationManager(configuration);generationManager.doGenerate();