Spring Cloud 中使用Mybatis Plus的generator 生成数据访问层代码

项目集成了Mybatis Plus后，一些数据库访问层的重复代码可交给代码生成器生成，可大大减轻开发的工作量。 代码生成工具很多，上文中既然集成的Mybatis Plus,本文就使用Mybatis Plus 自带的generator生成代码。可参照

一、新建generator项目

二、pom.xml

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>com.marvin</groupId> <artifactId>demo-spring-cloud-dependencies</artifactId> <version>1.0.0-SNAPSHOT</version> <relativePath>../demo-spring-cloud-dependencies/pom.xml</relativePath> </parent> <artifactId>demo-spring-cloud-generat</artifactId> <version>1.0.0-SNAPSHOT</version> <packaging>jar</packaging> <name>demo-spring-cloud-generat</name> <description>demo spring cloud 代码生产工具</description> <dependencies> <!-- Spring Boot Begin --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- Spring Boot End --> <!--Lombok Begin--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <!--Lombok End--> <!--Mybatis plus Begin--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-extension</artifactId> <version>${mybatis-plus.version}</version> </dependency> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>${mybatis-plus.version}</version> </dependency> <dependency> <groupId>org.apache.velocity</groupId> <artifactId>velocity-engine-core</artifactId> <version>2.1</version> </dependency> <!--Mybatis plus End--> <!--Mysql Begin--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <!--Mysql End--> </dependencies> </project>

三、代码生成配置类

package com.marvin.demo.spring.cloud.generat; /** * @ClassName: GeneratorConfig * @Description: 代码生成配置类 * @Author maihaixian * @Date 2019-05-21 16:04 */ public class GeneratorConstants { /** * 项目路径 **/ public static final String PROJECT_DIR = "/Users/maihaixian/IdeaProjects/demo-spring-cloud/demo-spring-cloud-member"; /** * java类目录 **/ public static final String JAVA_DIR = "/src/main/java"; /** * 作者 **/ public static final String AUTOR = "Marvin"; /** * 数据库配置 **/ public static final String DB_DRIVER = "com.mysql.cj.jdbc.Driver"; public static final String DB_URL = "jdbc:mysql://127.0.0.1:3306/demo?characterEncoding=utf8&serverTimezone=Asia/Shanghai"; public static final String DB_USER_NAME = "root"; public static final String DB_PASSWORD = "123456"; /** * 指定生成的表 ， 用 ","分割 **/ public static final String TABLES = "tb_user,sys_user"; /** * 模块名称 **/ public static final String MODULE = "member"; /** * 父级包名 **/ public static final String PARENT_PACKAGE = "com.marvin.demo.spring.cloud"; }

四、代码生成类

package com.marvin.demo.spring.cloud.generat; import com.baomidou.mybatisplus.annotation.DbType; import com.baomidou.mybatisplus.generator.AutoGenerator; import com.baomidou.mybatisplus.generator.config.*; import com.baomidou.mybatisplus.generator.config.rules.DateType; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; import org.apache.commons.lang3.StringUtils; /** * @ClassName: CodeGenerator * @Description: 代码生成类 * @Author maihaixian * @Date 2019-05-21 12:32 */ public class CodeGenerator { /** * MySQL 生成 */ public static void main(String[] args) { // 自定义需要填充的字段 // List<TableFill> tableFillList = new ArrayList<>(); // tableFillList.add(new TableFill("ASDD_SS", FieldFill.INSERT_UPDATE)); AutoGenerator mpg = new AutoGenerator(); // 选择 freemarker 引擎，默认 Veloctiy // mpg.setTemplateEngine(new FreemarkerTemplateEngine()); // 全局配置 GlobalConfig gc = new GlobalConfig(); gc.setOutputDir(GeneratorConstants.PROJECT_DIR + GeneratorConstants.JAVA_DIR); gc.setFileOverride(true);// 是否覆盖文件 gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false gc.setEnableCache(false);// XML 二级缓存 gc.setBaseResultMap(true);// XML ResultMap gc.setBaseColumnList(true);// XML columList //gc.setKotlin(true);//是否生成 kotlin 代码 gc.setAuthor(GeneratorConstants.AUTOR); //时间类型 gc.setDateType(DateType.ONLY_DATE); // 自定义文件命名，注意 %s 会自动填充表实体属性！ gc.setMapperName("%sMapper"); gc.setXmlName("%sMapper"); gc.setServiceName("%sService"); gc.setServiceImplName("%sServiceImpl"); gc.setControllerName("%sController"); mpg.setGlobalConfig(gc); // 数据源配置 DataSourceConfig dsc = new DataSourceConfig(); dsc.setDbType(DbType.MYSQL); /*dsc.setTypeConvert(new MySqlTypeConvert(){ // 自定义数据库表字段类型转换【可选】 public DbColumnType processTypeConvert(String fieldType) { System.out.println("转换类型：" + fieldType); // 注意！！processTypeConvert 存在默认类型转换，如果不是你要的效果请自定义返回、非如下直接返回。 return super.processTypeConvert(fieldType); } });*/ dsc.setDriverName(GeneratorConstants.DB_DRIVER); dsc.setUrl(GeneratorConstants.DB_URL); dsc.setUsername(GeneratorConstants.DB_USER_NAME); dsc.setPassword(GeneratorConstants.DB_PASSWORD); mpg.setDataSource(dsc); // 策略配置 StrategyConfig strategy = new StrategyConfig(); // 全局大写命名 ORACLE 注意 // strategy.setCapitalMode(true); // 此处可以修改为您的表前缀 //strategy.setTablePrefix(new String[] { "tlog_", "tsys_" }); // 表名生成策略 strategy.setNaming(NamingStrategy.underline_to_camel); // 需要生成的表,注释掉生成全部表 // String tables = ""; // StringUtils.split(tables); strategy.setInclude(StringUtils.split(GeneratorConstants.TABLES, ",")); // strategy.setExclude(new String[]{"test"}); // 排除生成的表 // 自定义实体父类 // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity"); // 自定义实体，公共字段 // strategy.setSuperEntityColumns(new String[] { "test_id", "age" }); // 自定义 mapper 父类 // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper"); // 自定义 service 父类 // strategy.setSuperServiceClass("com.baomidou.demo.TestService"); // 自定义 service 实现类父类 // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl"); // 自定义 controller 父类 // strategy.setSuperControllerClass("com.baomidou.demo.TestController"); // 【实体】是否生成字段常量（默认 false） // public static final String ID = "test_id"; //strategy.setEntityColumnConstant(true); // 【实体】是否为构建者模型（默认 false） // public User setName(String name) {this.name = name; return this;} //strategy.setEntityBuilderModel(true); // 【实体】是否为lombok模型（默认 false）<a href="https://projectlombok.org/">document</a> strategy.setEntityLombokModel(true); // strategy.setTableFillList(tableFillList); mpg.setStrategy(strategy); // 包配置 PackageConfig pc = new PackageConfig(); pc.setModuleName(GeneratorConstants.MODULE); pc.setParent(GeneratorConstants.PARENT_PACKAGE); // pc.setController("controller"); // pc.setXml("mapper"); mpg.setPackageInfo(pc); // 注入自定义配置，可以在 VM 中使用 cfg.abc 【可无】 ${cfg.abc} // InjectionConfig cfg = new InjectionConfig() { // @Override // public void initMap() { // Map<String, Object> map = new HashMap<String, Object>(); // map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp"); // this.setMap(map); // } // }; // 自定义 xxListIndex.html 生成 // List<FileOutConfig> focList = new ArrayList<FileOutConfig>(); // focList.add(new FileOutConfig("/templates/list.html.vm") { // @Override // public String outputFile(TableInfo tableInfo) { // // 自定义输入文件名称 // return "F:/idea-maven/maven/src/main/resources/static/" + tableInfo.getEntityName() + "ListIndex.html"; // } // }); // cfg.setFileOutConfigList(focList); // mpg.setCfg(cfg); // 关闭默认 xml 生成，调整生成 至 根目录 /*TemplateConfig tc = new TemplateConfig(); tc.setXml(null); mpg.setTemplate(tc);*/ // 自定义模板配置，可以 copy 源码 mybatis-plus/src/main/resources/templates 下面内容修改， // 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置，也可以自定义模板名称 TemplateConfig tc = new TemplateConfig(); // tc.setController("/templates/Controller.java.vm"); // tc.setService("/templates/Service.java.vm"); // tc.setServiceImpl("/templates/ServiceImpl.java.vm"); // tc.setEntity("/templates/Entity.java.vm"); // tc.setMapper("/templates/Mapper.java.vm"); // tc.setXml("/templates/Mapper.xml.vm"); // 如上任何一个模块如果设置 空 OR Null 将不生成该模块。 mpg.setTemplate(tc); // 执行生成 mpg.execute(); // 打印注入设置【可无】 // System.err.println(mpg.getCfg().getMap().get("abc")); } }

执行main方法，在member项目中生成对应代码。

如需修改模板，可以到mybatisplus的generator的源码中的template目录下复制到项目的resource/templates目录下修改