模板开发

autoCode.xml

一个autoCode.xml配置文件示例。template说明：

  • id：模板ID，请保持唯一;
  • name: 模板名称，请保持唯一；
  • destFile：输出目录；
  • templateFile：模板相对路径，相对于模板根目录；
  • engine: 可以为 groovy, velocity, jxls(excel模板), freemarker(暂未支持)，thymeleaf(暂未支持)；
  • acceptDataModel: 可接受处理的数据模型: tableModel,json,lineList,cellList,javaSource,rawContent,xml
  • description: 模板描述，可以进行介绍；
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <autoMake
  3.         xmlns="https://cn2oo8.github.io/molicode_doc/schema/autoCode"
  4.         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  5.         xsi:schemaLocation="https://cn2oo8.github.io/molicode_doc/schema/autoCode https://cn2oo8.github.io/molicode_doc/schema/autoCode/autoCode-1.0.xsd">
  7.     <moliCodeVersion>1.0.0</moliCodeVersion>
  9.      <mavenInfo>
  10.         <modelVersion>4.0.0</modelVersion>
  11.         <groupId>com.shareyi.molicode</groupId>
  12.         <version>1.0-SNAPSHOT</version>
  13.         <artifactId>autocode-template-selfsdk</artifactId>
  14.         <name>moliCode生成自有代码的模板</name>
  15.         <description>moliCode生成自有代码的模板</description>
  17.         <developers>
  18.             <developer>
  19.                 <name>david</name>
  20.                 <email>zsb1987@foxmail.com</email>
  21.                 <organization>www.shareyi.com</organization>
  22.                 <organizationUrl>www.shareyi.com</organizationUrl>
  23.             </developer>
  24.         </developers>
  25.      </mavenInfo>
  27.     <properties>
  28.         <!-- 代码片段配置文件，将部分公用的代码抽取出来放置到此处 -->
  29.         <property key="snippet.template.path">config/molicode/snippetTemplate.xml</property>
  30.         <!-- 用户自定义的配置文件，配置的值以文本方式直接可以在：extendConf.get("") 到-->
  31.         <property key="extend.text.config">config/molicode/extendConfig.xml</property>
  32.         <!-- 页面依赖资源配置文件（可支持requirejs和 普通引入）-->
  33.         <property key="pagerequire.map.config">config/molicode/requireConfig.xml</property>
  34.         <!-- 数据库类型到java类型映射-->
  35.         <property key="dbtype.javatype.map.config">config/molicode/db2javaTypeMap.xml</property>
  36.         <!-- 数据库类型到页面类型映射-->
  37.         <property key="dbtype.columntag.map.config">config/molicode/dbType2ColumnTagMap.xml</property>
  39.     </properties>
  42.     <templates>
  43.         <template id="domain" name="domain类"
  44.                   destFile="/${config.artifactId}-domain/src/main/java/${PubUtils.packageToPath(config.basePackage)}/domain/${PubUtils.packageToPath(config.category)}/${tableDefine.id}.java"
  45.                   templateFile="templates/domain/domain.gsp" engine="groovy">
  46.             <acceptDataModel>tableModel</acceptDataModel>
  47.         </template>
  50.         <template id="builder" name="builder类"
  51.                   destFile="/${config.artifactId}-domain/src/main/java/${PubUtils.packageToPath(config.basePackage)}/builder/impl/${tableDefine.id}Builder.java"
  52.                   templateFile="templates/domain/builder.gsp" engine="groovy">
  53.             <acceptDataModel>tableModel</acceptDataModel>
  54.         </template>
  57.         <template id="column" name="column 枚举"
  58.                   destFile="/${config.artifactId}-common/src/main/java/${PubUtils.packageToPath(config.basePackage)}/common/enums/columns/${tableDefine.id}Column.java"
  59.                   templateFile="templates/domain/column.gsp" engine="groovy">
  60.             <acceptDataModel>tableModel</acceptDataModel>
  62.         </template>
  65.         <template id="mybatisDaoIntf" name="dao接口"
  66.                   destFile="${config.artifactId}-dao/src/main/java/${PubUtils.packageToPath(config.basePackage)}/dao/${PubUtils.packageToPath(config.category)}/${tableDefine.id}Dao.java"
  67.                   templateFile="templates/dao/mybatis/daoIntf.gsp" engine="groovy">
  68.             <acceptDataModel>tableModel</acceptDataModel>
  70.         </template>
  72.         <template id="mybatisMapper" name="mybatisMapper"
  73.                   destFile="${config.artifactId}-dao/src/main/resources/mapper/${tableDefine.id}.xml"
  74.                   templateFile="templates/mapper/mybatis/mapper.gsp" engine="groovy">
  75.             <acceptDataModel>tableModel</acceptDataModel>
  77.         </template>
  80.         <template id="managerIntf" name="manager 接口"
  81.                   destFile="/${config.artifactId}-manager/src/main/java/${PubUtils.packageToPath(config.basePackage)}/manager/${PubUtils.packageToPath(config.category)}/${tableDefine.id}Manager.java"
  82.                   templateFile="templates/manager/managerIntf.gsp" engine="groovy">
  83.             <acceptDataModel>tableModel</acceptDataModel>
  85.         </template>
  86.         <template id="managerImpl" name="manager接口 实现"
  87.                   destFile="/${config.artifactId}-manager/src/main/java/${PubUtils.packageToPath(config.basePackage)}/manager/${PubUtils.packageToPath(config.category)}/impl/${tableDefine.id}ManagerImpl.java"
  88.                   templateFile="templates/manager/managerImpl.gsp" engine="groovy">
  89.             <acceptDataModel>tableModel</acceptDataModel>
  91.         </template>
  94.         <template id="serviceIntf" name="service SDK 接口"
  95.                   destFile="/${config.artifactId}-service/src/main/java/${PubUtils.packageToPath(config.basePackage)}/service/${PubUtils.packageToPath(config.category)}/${tableDefine.id}Service.java"
  96.                   templateFile="templates/sdk/serviceIntf.gsp" engine="groovy">
  97.             <acceptDataModel>tableModel</acceptDataModel>
  99.         </template>
  101.         <template id="serviceImpl" name="service SDK 接口 实现"
  102.                   destFile="/${config.artifactId}-service/src/main/java/${PubUtils.packageToPath(config.basePackage)}/service/${PubUtils.packageToPath(config.category)}/impl/${tableDefine.id}ServiceImpl.java"
  103.                   templateFile="templates/sdk/serviceImpl.gsp" engine="groovy">
  104.             <acceptDataModel>tableModel</acceptDataModel>
  106.         </template>
  108.         <template id="validator" name="validator SDK验证"
  109.                   destFile="/${config.artifactId}-service/src/main/java/${PubUtils.packageToPath(config.basePackage)}/validate/provide/${tableDefine.id}Validator.java"
  110.                   templateFile="templates/sdk/validator.gsp">
  111.             <acceptDataModel>tableModel</acceptDataModel>
  113.         </template>
  115.         <template id="controller" name="controller"
  116.                   destFile="/${config.artifactId}-web/src/main/java/${PubUtils.packageToPath(config.basePackage)}/controller/${PubUtils.packageToPath(config.category)}/${tableDefine.id}Controller.java"
  117.                   templateFile="templates/controller/controller.gsp">
  118.             <acceptDataModel>tableModel</acceptDataModel>
  120.         </template>
  123.         <template id="addPage" name="add页面"
  124.                   destFile="/ui-starter/src/views/${PubUtils.packageToPath(config.category)}/${tableNameUtil.lowerCaseFirst(tableDefine.id)}/add.vue"
  125.                   templateFile="templates/vue/add.gsp">
  126.             <acceptDataModel>tableModel</acceptDataModel>
  128.         </template>
  129.         <template id="editPage" name="edit页面"
  130.                   destFile="/ui-starter/src/views/${PubUtils.packageToPath(config.category)}/${tableNameUtil.lowerCaseFirst(tableDefine.id)}/edit.vue"
  131.                   templateFile="templates/vue/edit.gsp">
  132.             <acceptDataModel>tableModel</acceptDataModel>
  134.         </template>
  135.         <template id="listPage" name="list页面"
  136.                   destFile="/ui-starter/src/views/${PubUtils.packageToPath(config.category)}/${tableNameUtil.lowerCaseFirst(tableDefine.id)}/list.vue"
  137.                   templateFile="templates/vue/list.gsp">
  138.             <acceptDataModel>tableModel</acceptDataModel>
  140.         </template>
  141.         <template id="operatePage" name="operate页面"
  142.                   destFile="/ui-starter/src/views/${PubUtils.packageToPath(config.category)}/${tableNameUtil.lowerCaseFirst(tableDefine.id)}/operate.vue"
  143.                   templateFile="templates/vue/operate.gsp">
  144.             <acceptDataModel>tableModel</acceptDataModel>
  146.         </template>
  147.         <template id="tableDefineVue" name="tableDefineVue"
  148.                   destFile="/ui-starter/src/views/${PubUtils.packageToPath(config.category)}/${tableNameUtil.lowerCaseFirst(tableDefine.id)}/tableDefine.js"
  149.                   templateFile=" templates/vue/tableDefine.gsp">
  150.             <acceptDataModel>tableModel</acceptDataModel>
  152.         </template>
  155.         <template id="tableInfo" name="表结构"
  156.                   destFile="/${config.artifactId}-web/src/main/resources/temp/${tableDefine.id}TableInfo.txt"
  157.                   templateFile="templates/config/tableInfo.gsp">
  158.             <acceptDataModel>tableModel</acceptDataModel>
  160.         </template>
  161.     </templates>
  163. </autoMake>

代码模板示例

  1. ${snippetTemplateUtil.getTemplate('copyrightInfo')}
  3. <%
  4.       def tableDefine=tableModel.tableDefine;
  5.       def columns=tableDefine.columns;
  6.       def pkColumn=tableDefine.getPkColumn();
  7.       def upperPkName=tableNameUtil.upperFirst(pkColumn.dataName)
  9.       Set excludes = ["id","status","operator","created","modified","concurrentVersion","dataVersion"]
  11. %>package ${config.basePackage}.domain${PubUtils.addStrAfterSeparator(config.category,"." )};
  13. import ${config.basePackage}.domain.BasicDomain;
  14. import java.io.Serializable;
  15. /**
  16.  * @author ${config.author}
  17.  * @since ${config.nowDate}
  18.  * ${tableDefine.cnname} Domain 类
  19.  */
  20. public class ${tableDefine.id} extends BasicDomain implements Serializable {
  22.   private static final long serialVersionUID = ${PubUtils.getRandomLong()}L;
  24. <%
  25.       columns.each{
  26.           if(!excludes.contains(it.dataName)) {
  27.               println "    /**  ${it.cnname}  */";
  28.               println "    private ${tableNameUtil.getDataType(it.columnType)} ${it.dataName}; "
  29.           }
  30.       };
  32.       columns.each{
  33.           if(!excludes.contains(it.dataName)) {
  34.               String dataName = it.dataName
  36.               def upperFistName=tableNameUtil.upperFirst(dataName)
  37.               def dataType =tableNameUtil.getDataType(it.columnType)
  38.               println """
  39.       public void set${upperFistName}(${dataType} ${dataName}) {
  40.         this.${dataName}=${dataName};
  41.       }
  43.       public ${dataType} get${upperFistName}() {
  44.         return this.${dataName};
  45.       }"""
  46.           }
  47.       }
  48. %>
  50. }

文件目录说明

新建一个目录， 如 src/main/java/resources（我是为了配合截图所以起这么长的文件目录名，你可以直接起一个 myTemplate即可）然后在该目录下创建 autoCode.xml；按上面的autoCode.xml配置文件编写内容；

在src/main/resources （我是为了配合截图所以起这么长的文件目录名，你可以直接在myTemplate文件夹下即可）下创建 templates 目录，并组织自己的模板文件，其中：

  • *.gsp 为groovy 脚本文件；
  • *.vm 为velocity文件；
  • *.xlsx 为Excel文件；
    新增的文件需要在autoCode.xml中进行描述；如下图 domain.gsp文件在autoCode.xml 可描述为：
  1.     <template id="domain" name="domain类"
  2.                   destFile="/${config.artifactId}-domain/src/main/java/${PubUtils.packageToPath(config.basePackage)}/domain/${PubUtils.packageToPath(config.category)}/${tableDefine.id}.java"
  3.                   templateFile="templates/domain/domain.gsp" engine="groovy">
  4.             <acceptDataModel>tableModel</acceptDataModel>
  5.         </template>

dir

pom.xml 文件请忽略，此为使用maven仓库和使用maven工程才需要使用，普通git项目只需要 autoCode.xml 和 模板文件即可。

发布和使用

请推送到git仓库，或者本地文件夹也可；告知使用方git地址即可。

开发中遇到任何问题，请及时沟通~~~~