1.MyBatisPlus代码生成器使用
在项目开发中，快速生成entity、mapper、service、controller包中的简单接口和类能够加速我们开发的速度时间。为此，我们可以使用MyBatis-Plus的代码生成器快速生成前面几个包的接口和代码。快速生成代码的流程依次是：引入依赖、配置文件、编写生成类并启动。
1.引入依赖
为生成标准格式的mapper.xml和Controller类，这里使用freemarker定义好生成模板。
<!-- freemarker 模板引擎-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>${freemarker.version}</version>
</dependency>
引入MyBatis-Plus相关依赖以及代码生成依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-annotation</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-extension</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<!-- mybatis-plus代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
代码生成是根据我们的数据库的表来生成的，因此需要MySQL依赖
<!--mysql链接库-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.11</version>
</dependency>
2.配置文件
2.1 端口、数据库、MybatisPlus配置文件
server: port: 8020 spring: datasource: url: jdbc:mysql://localhost:3306/online_work_order?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&useSSL=false&allowMultiQueries=true&serverTimezone=Asia/Shanghai&allowPublicKeyRetrieval=true username: root password: root driver-class-name: com.mysql.cj.jdbc.Driver servlet: multipart: max-request-size: -1 max-file-size: -1 mybatis-plus: # typeAliasesPackage: com.qhzz.*.entity configuration: # 自动转驼峰命名 map-underscore-to-camel-case: true # 自动映射 auto-mapping-behavior: full # 使用具体日志输出，输出到控制台 log-impl: org.apache.ibatis.logging.stdout.StdOutImpl mapper-locations: classpath*:mapper/*Mapper.xml global-config: # 逻辑删除配置 db-config: # id自增 id-type: auto # 非空字段策略 field-strategy: not_empty # 数据库下划线转Java实体类驼峰 table-underline: true db-type: mysql # 逻辑删除前为0 logic-not-delete-value: 0 # 删除后 logic-delete-value: 1 # 是否开启swagger mconfig: swagger-ui-open: true host: localhost:8020
2.2 代码生成器配置文件
#DataSource Config spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver spring.datasource.url=jdbc:mysql://127.0.0.1:3306/online_work_order?characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&useSSL=false spring.datasource.username=root spring.datasource.password=root #Custom Config #生成代码中作者的名称 gen.author=ku #生成代码中包的名称 gen.base.package=com.ku.owo #生成代码中模块的名称 gen.base.package.module= #数据库表名，多个表中间用逗号隔开 # gen.table.name=equipment_state_info gen.table.name=user_info,role_info,menu_info,role_menu,work_order,owo_operate_log,dispatch_task,direct_task
2.3 Controller和mapper.xml的模版文件
我们只需要在resource目录下创建一个templates目录，然后将下面两个命名为controller.java.ftl文件和mapper.xml.ftl文件放入其中即可。
package ${package.Controller}; import org.springframework.web.bind.annotation.RequestMapping; <#if restControllerStyle> import org.springframework.web.bind.annotation.RestController; <#else> import org.springframework.stereotype.Controller; </#if> <#if superControllerClassPackage??> import ${superControllerClassPackage}; import ${package.Entity}.${entity}; </#if> import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; /** * <p> * ${table.comment!} 控制器 * </p> * * @author ${author} * @since ${date} */ <#if restControllerStyle> @RestController <#else> @Controller </#if> @RequestMapping("<#if package.ModuleName??>${package.ModuleName}</#if>/<#if controllerMappingHyphenStyle??>${controllerMappingHyphen}<#else>${table.entityPath}</#if>") @Api(value = "${table.comment!}管理", tags = {"${table.comment!}管理"}) <#if kotlin> class ${table.controllerName}<#if superControllerClass??> : ${superControllerClass}()</#if> <#else> <#if superControllerClass??> public class ${table.controllerName} extends ${superControllerClass}<${entity}> { <#else> public class ${table.controllerName} { </#if> } </#if>
<?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="${package.Mapper}.${table.mapperName}">
<#if enableCache>
<!-- 开启二级缓存 -->
<cache type="org.mybatis.caches.ehcache.LoggingEhcache"/>
</#if>
<#--<#if baseResultMap>-->
<!-- 通用查询映射结果 -->
<resultMap id="BaseResultMap" type="${package.Entity}.${entity}">
<#list table.fields as field>
<#if field.keyFlag><#--生成主键排在第一位-->
<id column="${field.name}" property="${field.propertyName}"/>
</#if>
</#list>
<#list table.commonFields as field><#--生成公共字段 -->
<result column="${field.name}" property="${field.propertyName}"/>
</#list>
<#list table.fields as field>
<#if !field.keyFlag><#--生成普通字段 -->
<result column="${field.name}" property="${field.propertyName}"/>
</#if>
</#list>
</resultMap>
<#-- </#if>-->
<#-- <#if baseColumnList>-->
<!-- 通用查询结果列 -->
<sql id="Base_Column_List">
<#list table.commonFields as field>
${field.name},
</#list>
${table.fieldNames}
</sql>
<#-- </#if>-->
</mapper>
3.编写生成类并启动
package com.ku.owo.common.generate; import com.baomidou.mybatisplus.core.toolkit.StringPool; import com.baomidou.mybatisplus.generator.AutoGenerator; import com.baomidou.mybatisplus.generator.InjectionConfig; import com.baomidou.mybatisplus.generator.config.*; import com.baomidou.mybatisplus.generator.config.po.TableInfo; import com.baomidou.mybatisplus.generator.config.rules.DateType; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine; import lombok.extern.slf4j.Slf4j; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; import java.util.ArrayList; import java.util.List; import java.util.Properties; /** * @author xiaoku * 代码生成器 * @date */ @Slf4j public class CodeGenerator { private static final String APP_PROPERTY = "code-generator.properties"; public static void main(String[] args) { // 获取配置文件信息 Properties properties = getProperties(); // 生成的作者 String author = properties.getProperty("gen.author"); // 生成的包名 String packageName = properties.getProperty("gen.base.package"); // 生成的模块名 String moduleName = properties.getProperty("gen.base.package.module"); // 生成的表名 String tableName = properties.getProperty("gen.table.name"); // 代码生成器 AutoGenerator mpg = new AutoGenerator(); // 全局配置 GlobalConfig gc = new GlobalConfig(); String projectPath = System.getProperty("user.dir"); gc.setOutputDir(projectPath + "/src/main/java"); gc.setAuthor(author); gc.setOpen(false); gc.setSwagger2(true); //实体属性 Swagger2 注解 gc.setDateType(DateType.ONLY_DATE);//这里我们不使用jdk8的时间 mpg.setGlobalConfig(gc); // 数据源配置 mpg.setDataSource(loadDataSourceConfig(properties)); // 包配置 PackageConfig pc = new PackageConfig(); pc.setModuleName(moduleName); pc.setParent(packageName); mpg.setPackageInfo(pc); // 自定义配置 InjectionConfig cfg = new InjectionConfig() { @Override public void initMap() { // to do nothing } }; // 自定义controller的代码模板 String templatePath = "/templates/controller.java.ftl";//controller类生成模板,这里需要freemark // 自定义输出配置 List<FileOutConfig> focList = new ArrayList<>(); // 自定义配置会被优先输出 focList.add(new FileOutConfig(templatePath) { @Override public String outputFile(TableInfo tableInfo) { // 自定义输出文件名 + pc.getModuleName() String expand = projectPath + "/src/main/java/com/ku/owo" + pc.getModuleName() + "/" + "controller"; String entityFile = String.format((expand + File.separator + "%s" + ".java"), tableInfo.getControllerName()); return entityFile; } }); // 自定义mapper的代码模板 String templatePathMapper = "/templates/mapper.xml.ftl"; // 自定义输出配置 focList = new ArrayList<>(); // 自定义配置会被优先输出 focList.add(new FileOutConfig(templatePathMapper) { @Override public String outputFile(TableInfo tableInfo) { // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！ return projectPath + "/src/main/resources/mapper" + pc.getModuleName() + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML; } }); cfg.setFileOutConfigList(focList); mpg.setCfg(cfg); // 配置模板 TemplateConfig templateConfig = new TemplateConfig(); templateConfig.setXml(null); mpg.setTemplate(templateConfig); // 策略配置 StrategyConfig strategy = new StrategyConfig(); strategy.setNaming(NamingStrategy.underline_to_camel); strategy.setColumnNaming(NamingStrategy.underline_to_camel); strategy.setEntityLombokModel(true); strategy.setRestControllerStyle(true); // 公共父类 //strategy.setSuperControllerClass(packageName + ".common.base.CurdController"); strategy.setInclude(tableName.split(",")); strategy.setControllerMappingHyphenStyle(true); strategy.setTablePrefix(pc.getModuleName() + "_"); mpg.setStrategy(strategy); mpg.setTemplateEngine(new FreemarkerTemplateEngine()); //报错：java.lang.NoClassDefFoundError: freemarker/template/Configuration，原因：缺少freemarker模板；解决办法：引入依赖 mpg.execute(); } /** * 配置数据库信息 */ private static DataSourceConfig loadDataSourceConfig(Properties prop) { DataSourceConfig dsc = new DataSourceConfig(); dsc.setUrl(prop.getProperty("spring.datasource.url")); dsc.setDriverName(prop.getProperty("spring.datasource.driverClassName")); dsc.setUsername(prop.getProperty("spring.datasource.username")); dsc.setPassword(prop.getProperty("spring.datasource.password")); return dsc; } /** * 获取配置文件信息 * * @return */ public static Properties getProperties() { Properties prop = new Properties(); //System.getProperty("user.dir")获取当前工作目录路径：即项目路径，截止到onlin-work-order String resourcePath = System.getProperty("user.dir") + "/src/main/resources/" + APP_PROPERTY; try { InputStream inStream = new FileInputStream(new File(resourcePath)); prop.load(inStream); } catch (IOException e) { e.printStackTrace(); } return prop; } }
编写完启动类后，运行主函数就可以帮助我们快速生成包代码了！
4.运行结果
