创建一个代码生成工具

左手的ㄟ右手 2023-01-03 14:30 148阅读 0赞

# 前言 #

我们在很多一些项目中主要涉及到一些针对表的增删改查的项目，如何简化针对项目进行减少重复工作的开发很有必要。谷歌为我们提供了一套代码生成jar包。这里通过mysql来进行示范。

# 实践 #

先看一下整个项目的目录结构  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70]

1、引入需要进行代码生成的jar,这里由于我们通过mysql来进行示范，所以需要引入  
mysql-connector-java 包，如果是其他数据库根据数据库种类来进行切换。

<properties>
            <java.version>1.8</java.version>
            <rapid-generator-version>4.0.6</rapid-generator-version>
            <hutool.version>5.3.9</hutool.version>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            
            <dependency>
                <groupId>com.googlecode.rapid-framework</groupId>
                <artifactId>rapid-generator</artifactId>
                <version>${ rapid-generator-version}</version>
            </dependency>
            
            <dependency>
                <groupId>com.googlecode.rapid-framework</groupId>
                <artifactId>rapid-generator-template</artifactId>
                <version>${ rapid-generator-version}</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.googlecode.rapid-framework</groupId>
                <artifactId>rapid-generator-ext</artifactId>
                <version>${ rapid-generator-version}</version>
            </dependency>
    
            <dependency>
                <groupId>cn.hutool</groupId>
                <artifactId>hutool-all</artifactId>
                <version>${ hutool.version}</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            
        </dependencies>

2、关于主要代码的编写  
主要是获取xml文件中的配置信息，将xml中信息配置好的信息设置到模板中

public class GeneratorMain { 
        public static void main(String[] args) throws Exception { 
    
            //设置模板位置
            GeneratorFacade gf = new GeneratorFacade();
            gf.getGenerator().addTemplateRootDir(GeneratorProperties.getProperty("templateRootDir"));
            gf.deleteOutRootDir();
    
            //配置表则，输出配置的表。如果未配置则输出所有表
            String tables = GeneratorProperties.getProperty("generatorTables");
            if (StrUtil.isNotBlank(tables)) { 
                gf.generateByTable(tables.split(","));
            }else { 
                gf.generateByAllTable();
            }
            //打开配置输出文件位置
            Runtime.getRuntime().exec("cmd.exe /c start " + GeneratorProperties.getRequiredProperty("outRoot"));
        }
    }

3、查看配置好xml

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
    <properties>
    	<comment>代码生成器配置文件</comment>
    	
    	<entry key="generatorTables">order_detail,order_master,product_category,product_info,seller_info</entry>
    	
    	<entry key="templateRootDir">E:\code\test_fen\generate-code\template</entry>
    	
    	<entry key="outRoot">C:\Users\Administrator\Desktop\fileTest</entry>
    	
        <entry key="basepackage">com.yin</entry>
        
        <entry key="projectName">generateCode</entry>
        
        <entry key="moduleName">provider</entry>
    	
    	
    	
    	<entry key="superEntityClass"> </entry>
    	
    	<entry key="generalColumn">id,creator,createTime,modifier,modifyTime</entry>
    	
    	<entry key="author">yin</entry>
    
    	
    	<entry key="jdbc_driver">com.mysql.cj.jdbc.Driver</entry>
    
    	<entry key="jdbc_url">jdbc:mysql://localhost:3306/sell?serverTimezone=Asia/Shanghai</entry>
    	<entry key="jdbc_username">root</entry>
    	<entry key="jdbc_password">123456</entry>
    
    	
    	<entry key="tableRemovePrefixes">t_</entry>
    
    	
    	<entry key="java_typemapping.java.sql.Timestamp">Date</entry>
    	<entry key="java_typemapping.java.sql.Date">Date</entry>
    	<entry key="java_typemapping.java.sql.Time">Date</entry>
    	<entry key="java_typemapping.java.sql.Clob">String</entry>
    	<entry key="java_typemapping.java.math.BigDecimal">Double</entry>
    	<entry key="java_typemapping.java.lang.Boolean">Integer</entry>
    	<entry key="java_typemapping.java.lang.Byte">Integer</entry>
    	<entry key="java_typemapping.java.lang.Short">Integer</entry>
    	<entry key="java_typemapping.java.lang.Integer">Integer</entry>
    	<entry key="java_typemapping.java.lang.Long">Long</entry>
    	<entry key="java_typemapping.java.lang.Float">Float</entry>
    	<entry key="java_typemapping.java.lang.Double">Double</entry>
    	<entry key="java_typemapping.java.lang.String">String</entry>
    </properties>

4、查看一下我们需要进行配置信息  
创建custom.include 配置文件，定义公共常量来用于设置表名和类名的一些替换关系，使表名和类名能够进行对应。

custom.include

<#-- 本文件包含一些自定义的公共变量 -->
    <#assign className = table.className>
    <#assign classNameFirstLower = table.classNameFirstLower>
    <#assign classNameLowerCase = table.classNameLowerCase>
    <#assign ignoreAttributes = generalColumn?split(",") >

javadoc\_class.include 类名上注释配置

/**
     *  
     * @author ${ author}
     * @version 1.0
     * @Date <<#if now??>${ now?string('yyyy/MM/dd HH:mm')}</#if>>
     */

javadoc\_source.include 放置在类最上，用于标识来源等信息  
如  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 1]

<#include "/custom.include">
    /*
     *Project: ${ projectName}
     ****************************************************************
     * 版权所有@<#if now??>${ now?string('yyyy')}</#if> yin
     ***************************************************************/

macro.include 生成一些公共函数

<#-- 本文件包含一些公共的函数,本文件会被其它模板自动include -->
    <#-- 将value变成jsp el表达式,主要由于FreeMarker生成表达式不方便 -->
    <#macro jspEl value>${ r"${"}${ value}}</#macro>
    
    <#macro mapperEl value>${ r"#{"}${ value}}</#macro>
    
    <#-- 生成java构造函数 -->
    <#macro generateConstructor constructor>
    	public ${ constructor}(){ 
    	}
    
    	public ${ constructor}(
    	<#list table.compositeIdColumns as column>
    		${ column.javaType} ${ column.columnNameLower}<#if column_has_next>,</#if>
    	</#list>		
    	){ 
    	<#list table.compositeIdColumns as column>
    		<#if column.pk>
    		this.${ column.columnNameLower} = ${ column.columnNameLower};
    		</#if>
    	</#list>	
    	}
    </#macro>

5、剩下就是模板的定义了

先看目录结构  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 2]  
构建xml文件

<#include "/custom.include">
    <?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    <mapper namespace="${basepackage}.${projectName}.${moduleName}.dao.mapper.${className}Mapper" >
        <resultMap id="BaseResultMap" type="${basepackage}.${projectName}.${moduleName}.dao.entity.${className}" >
      	 <#list table.columns as column>
    	  	<result property="${column.columnNameLower}" column="${column.sqlName}" jdbcType="${column.jdbcType?upper_case}"/>
    	 </#list>
        </resultMap>
    
    </mapper>

controller的配置

<#include "/javadoc_source.include">
    package ${ basepackage}.${ projectName}.${ moduleName}.controller;
    
    import com.baomidou.mybatisplus.core.metadata.IPage;
    
    import ${ basepackage}.${ projectName}.${ moduleName}.dto.request.RequestPage;
    import ${ basepackage}.${ projectName}.${ moduleName}.dto.resp.ResponseData;
    import ${ basepackage}.${ projectName}.${ moduleName}.dao.entity.${ className};
    import ${ basepackage}.${ projectName}.${ moduleName}.service.${ className}Service;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import javax.annotation.Resource;
    
    /**
     *  ${ className} API接口实现类
     *
     * @author ${ author}
     * @version 1.0
     * @date <#if now??>${ now?string('yyyy/MM/dd HH:mm')}</#if>
     */
    @RestController
    @Api(tags = { "${className}-API"})
    @RequestMapping("/${moduleName}/${classNameFirstLower}")
    public class ${ className}Controller extends BaseController { 
    
    	@Resource
    	private ${ className}Service ${ classNameFirstLower}Service;
    
    	@PostMapping("/page")
    	@ApiOperation(value = "分页查询")
    	public  ResponseData<IPage<${ className}>> page(@RequestBody RequestPage<${ className}> request) { 
    		IPage<${ className}> page = ${ classNameFirstLower}Service.page(request.getData(), request.getPageNo(), request.getPageSize());
    		return page !=null ? ResponseData.success(page) : ResponseData.failure();
    	}
    
    	@PostMapping("/save")
    	@ApiOperation(value = "保存数据")
    	public ResponseData<${ className}> save(@RequestBody ${ className} entity){ 
    		return ${ classNameFirstLower}Service.save(entity) ? ResponseData.success() : ResponseData.failure();
    	}
    
    	@PostMapping("/update")
    	@ApiOperation(value = "根据ID更新")
    	public ResponseData<${ className}> update(@RequestBody ${ className} entity){ 
    		return ${ classNameFirstLower}Service.updateById(entity) ? ResponseData.success() : ResponseData.failure();
    	}
    
    	@PostMapping("/remove")
    	@ApiOperation("根据ID删除")
    	public ResponseData<${ className}> remove(Long id){ 
    		return ${ classNameFirstLower}Service.removeById(id) ? ResponseData.success() : ResponseData.failure();
    	}
    
    	@GetMapping("/get")
    	@ApiOperation("根据ID查询")
    	public ResponseData<${ className}> get(Long id){ 
    		${ className} entity = ${ classNameFirstLower}Service.getById(id);
    		return entity !=null ? ResponseData.success(entity) : ResponseData.failure();
    	}
    }

# git地址 #

具体代码不再详细介绍，具体代码地址  
https://github.com/fajingyin/generate-code

# 效果展示 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 3]

这里其实通过对模板中一些文件进行替换，来达到生成配置对应代码。我们如果有其他个性化需求可以通过修改模板来达到目的。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70]: /images/20221119/66d2199dd39946119d4bc9fad2eee992.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 1]: /images/20221119/eab49e2821ce46279ef8381b641aa6ba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 2]: /images/20221119/d758beaec25e40288bfe4dbf9b182d7a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70 3]: /images/20221119/10cca5bf7b2c4954937450e726524468.png