六、mybatis-plus的代码生成器
简介:构建自定义mybatis-plus模板,自动生成mybatis,entity,mapper,service,controller
项目源码:https://github.com/y369q369/springBoot.git -> myBatisPlus
私聊QQ: 1486866853
1.demo完整代码结构
2.pom.xml依赖
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
<?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>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.3.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.demo</groupId> <artifactId>mybatisPlus</artifactId> <version>0.0.1-SNAPSHOT</version> <name>mybatisPlus</name> <description>使用mybatisPlus代码生成器</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.0.0</version> </dependency> <!-- web依赖,包含servlet,内置tomcat等 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- mysql依赖 --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> <!-- ORACLE相关 --> <dependency> <groupId>com.oracle</groupId> <artifactId>ojdbc6</artifactId> <version>12.1.0.1-atlassian-hosted</version> </dependency> <!-- mybatis-plus依赖, 可以代替mybatis --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.1.1</version> </dependency> <!-- MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖,需要手动添加相关依赖--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.1.1</version> </dependency> <!-- Freemarker模板引擎 --> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
3.生成器代码
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
package mybatisPlus.generate; import java.util.ArrayList; import java.util.List; import com.baomidou.mybatisplus.annotation.DbType; import com.baomidou.mybatisplus.annotation.IdType; 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.DataSourceConfig; import com.baomidou.mybatisplus.generator.config.FileOutConfig; import com.baomidou.mybatisplus.generator.config.GlobalConfig; import com.baomidou.mybatisplus.generator.config.PackageConfig; import com.baomidou.mybatisplus.generator.config.StrategyConfig; import com.baomidou.mybatisplus.generator.config.TemplateConfig; import com.baomidou.mybatisplus.generator.config.po.TableInfo; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine; /** * @author GrassPrince * @Da2019年4月28日 2019年4月28日 - 下午2:37:11 * @Description 数据库对应代码生成器 */ public class DataSourcesGenerator { public static void main(String[] args) { // 生成地址 : // System.getProperty("user.dir") == 得到当前项目的实际地址 String outputDir = System.getProperty("user.dir") + "/src/main/java"; // String outputDir = "C://Users/VULCAN/Desktop/new"; // 表名, 注意大小写 String[] tableNames = new String[]{"test_hobby"}; // 数据源: 1-mysql 2-oracle Integer dbType = 1; // 数据库地址 String url = "jdbc:mysql://localhost:3306/xl?useUnicode=true&characterEncoding=utf8"; // 用户名 String userName = "root"; // 密码 String password = "ok"; // 父包路径 String parentPackage = "mybatisPlus"; // 需要去掉的表名前缀 String prefixTable = "Test_"; generate(outputDir, tableNames, dbType, url, userName, password, parentPackage, prefixTable); } /** * @param outputDir 生成地址 * @param tableNames 表名 * @param dbType 数据源: 1-mysql 2-oracle * @param url 数据库地址 * @param userName 用户名 * @param password 密码 * @param parentPackage 父包路径 * @param prefixTable 需要去掉的表名前缀 */ public static void generate(String outputDir, String[] tableNames, Integer dbType, String url, String userName, String password, String parentPackage, String prefixTable) { // =============== 全局配置 ================== GlobalConfig gc = new GlobalConfig(); gc.setOutputDir(outputDir) .setActiveRecord(true) // 是否支持 AR, 实体类只需继承 Model 类即可进行强大的 CRUD 操作 .setAuthor("GrassPrince") // 设置作者名字 .setFileOverride(true) // 文件覆盖(全新文件) .setIdType(IdType.AUTO) // 主键策略 .setEnableCache(false) // SQL 二级缓存 .setBaseResultMap(true) // SQL 映射文件 .setBaseColumnList(true) // SQL 片段 .setServiceName("%sService") // service的名字 .setOpen(false); // ================= 数据源配置 =============== DataSourceConfig dsc = new DataSourceConfig(); if(dbType == 1) { dsc.setDbType(DbType.MYSQL) .setDriverName("com.mysql.cj.jdbc.Driver"); }else if(dbType == 2){ dsc.setDbType(DbType.ORACLE) .setDriverName("oracle.jdbc.driver.OracleDriver"); } dsc.setUrl(url) .setUsername(userName) .setPassword(password); // ================= 包配置 =================== PackageConfig pc = new PackageConfig(); pc.setParent(parentPackage) // 配置父包路径 // .setModuleName("base") // 配置业务包路径 .setMapper("mapper") .setEntity("entity") .setService("service") //.setServiceImpl("service.impl"); // 会自动生成 impl,可以不设定 .setController("controller"); // ================== 自定义配置 ================= InjectionConfig cfg = new InjectionConfig() { @Override public void initMap() { // to do nothing } }; List<FileOutConfig> focList = new ArrayList<>(); // 调整 xml 生成目录演示 focList.add(new FileOutConfig("/templates/ftl/mapper.xml.ftl") { @Override public String outputFile(TableInfo tableInfo) { // 自定义输入文件名称 return System.getProperty("user.dir") + "/src/main/resources/mybatis/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML; } }); cfg.setFileOutConfigList(focList); // =================== 策略配置 ================== StrategyConfig strategy = new StrategyConfig(); strategy.setNaming(NamingStrategy.underline_to_camel) // 表名命名: underline_to_camel 底线变驼峰 .setColumnNaming(NamingStrategy.underline_to_camel) // 字段命名: underline_to_camel 底线变驼峰 .setInclude(tableNames) // 需要生成的 表名 .setCapitalMode(true) // 全局大写命名 ORACLE 注意 .setTablePrefix(prefixTable) // 去掉 表的前缀 // .setFieldPrefix(pc.getModuleName() + "_") // 去掉字段前缀 // .setSuperEntityClass("com.maoxs.pojo") // 继承类 // .setSuperControllerClass("com.maoxs.controller") // 继承类 // .setSuperEntityColumns("id") // 设置超级超级列 // .setEntityLombokModel(true) // 是否加入lombok .setControllerMappingHyphenStyle(true); // 设置controller映射联字符 // ================== 自定义模板配置: 默认配置位置 mybatis-plus/src/main/resources/templates ====================== // 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置,也可以自定义模板名称 TemplateConfig tc = new TemplateConfig(); tc.setXml(null) // 设置生成xml的模板 .setEntity("/templates/ftl/entity.java") // 设置生成entity的模板 .setMapper("/templates/ftl/mapper.java") // 设置生成mapper的模板 .setController("/templates/ftl/controller.java") // 设置生成service的模板 .setService("/templates/ftl/service.java") // 设置生成serviceImpl的模板 .setServiceImpl("/templates/ftl/serviceImpl.java"); // 设置生成controller的模板 // ==================== 生成配置 =================== AutoGenerator mpg = new AutoGenerator(); mpg.setCfg(cfg) .setTemplate(tc) .setGlobalConfig(gc) .setDataSource(dsc) .setPackageInfo(pc) .setStrategy(strategy) .setTemplateEngine(new FreemarkerTemplateEngine()); // 选择 freemarker引擎,注意 pom 依赖必须有! mpg.execute(); } }
4.自定义ftl生成器配置文件
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
package ${package.Controller}; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.stereotype.Controller; import org.springframework.beans.factory.annotation.Autowired; import ${package.Service}.${table.serviceName}; @Controller @RequestMapping("/${table.entityPath}") public class ${table.controllerName} { @Autowired private ${table.serviceName} ${table.entityPath}Service; }
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
package ${package.ServiceImpl}; import ${package.Entity}.${entity}; import ${package.Mapper}.${table.mapperName}; import ${package.Service}.${table.serviceName}; import org.springframework.stereotype.Service; import org.springframework.beans.factory.annotation.Autowired; @Service public class ${table.serviceImplName} implements ${table.serviceName} { @Autowired private ${table.mapperName} ${table.entityPath}Mapper; }
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
package ${package.Service}; import ${package.Entity}.${entity}; public interface ${table.serviceName}{ }
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
package ${package.Entity}; import java.io.Serializable; <#list table.importPackages as pkg> <#if pkg == "java.util.Date"> import ${pkg}; </#if> </#list> /** * ${table.name} : ${table.comment!} */ public class ${entity} implements Serializable { private static final long serialVersionUID = 1L; <#-- ---------- 属性私有化 ----------> <#list table.fields as field> <#if field.keyFlag> <#assign keyPropertyName="${field.propertyName}"/> </#if> <#if field.keyFlag> <#-- 主键 --> /** * 主键 : ${field.name}, ${field.comment!} */ <#-- 普通字段 --> <#elseif field.convert> /** * ${field.name}, ${field.comment!} */ </#if> <#-- 乐观锁注解 --> <#if (versionFieldName!"") == field.name> @Version </#if> <#-- 逻辑删除注解 --> <#if (logicDeleteFieldName!"") == field.name> @TableLogic </#if> private ${field.propertyType} ${field.propertyName}; </#list> <#------------ 构造函数 ----------- --> public ${entity}(<#list table.fields as field>${field.propertyType} ${field.propertyName}<#sep>,</#list>){ <#list table.fields as field> this.${field.propertyName} = ${field.propertyName}; </#list> } public ${entity}(){ } <#------------ getter.setter封装 ----------> <#if !entityLombokModel> <#list table.fields as field> <#if field.propertyType == "boolean"> <#assign getprefix="is"/> <#else> <#assign getprefix="get"/> </#if> public ${field.propertyType} ${getprefix}${field.capitalName}() { return ${field.propertyName}; } <#if entityBuilderModel> public ${entity} set${field.capitalName}(${field.propertyType} ${field.propertyName}) { <#else> public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) { </#if> this.${field.propertyName} = ${field.propertyName}; <#if entityBuilderModel> return this; </#if> } </#list> </#if> <#------------- 重写toString() -----------------> <#if !entityLombokModel> @Override public String toString() { return "${entity}{" + <#list table.fields as field> <#if field_index==0> "${field.propertyName}=" + ${field.propertyName} + <#else> ", ${field.propertyName}=" + ${field.propertyName} + </#if> </#list> "}"; } </#if> }
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
package ${package.Mapper}; import ${package.Entity}.${entity}; import java.util.List; import org.apache.ibatis.annotations.Param; public interface ${table.mapperName}{ /** * 查询表${table.name}所有信息 */ List<${entity}> find${entity}(); <#list table.fields as field> <#if field.keyFlag> /** * 根据主键${field.propertyName}查询表${table.name}信息 */ ${entity} find${entity}By${field.propertyName}(@Param("${field.propertyName}") ${field.propertyType} ${field.propertyName}); </#if> </#list> <#list table.fields as field> <#if field.keyFlag> /** * 根据主键${field.propertyName}查询表${table.name}信息 */ Integer delete${entity}By${field.propertyName}(@Param("${field.propertyName}") ${field.propertyType} ${field.propertyName}); </#if> </#list> <#list table.fields as field> <#if field.keyFlag> /** * 根据主键${field.propertyName}更新表${table.name}信息 */ Integer update${entity}By${field.propertyName}(${entity} ${table.entityPath}); </#if> </#list> <#list table.fields as field> <#if field.keyFlag> /** * 新增表${table.name}信息 */ Integer add${entity}(${entity} ${table.entityPath}); </#if> </#list> }
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
<?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="${entity}Map" 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> <!-- 查询表${table.name}所有信息 --> <select id="find${entity}" resultMap="${entity}Map"> select * from ${table.name} </select> <#list table.fields as field> <#if field.keyFlag> <!-- 根据主键${field.propertyName}查询表${table.name}信息 --> <select id="find${entity}By${field.propertyName}" resultMap="${entity}Map"> select * from ${table.name} where ${field.name}=${r"#{"}${field.propertyName}${r"}"} </select> </#if> </#list> <#list table.fields as field> <#if field.keyFlag> <!-- 根据主键${field.propertyName}删除表${table.name}信息 --> <delete id="delete${entity}By${field.propertyName}"> delete from ${table.name} where ${field.name}=${r"#{"}${field.propertyName}${r"}"} </delete> </#if> </#list> <#list table.fields as field> <#if field.keyFlag> <!-- 根据主键${field.propertyName}更新表${table.name}信息 --> <update id="update${entity}By${field.propertyName}" parameterType="${package.Entity}.${entity}"> update from ${table.name} set <#list table.fields as field><#if !field.keyFlag>${field.name}=${r"#{"}${field.propertyName}${r"}"}<#sep>,</#if></#list> where <#list table.fields as field><#if field.keyFlag>${field.name}=${r"#{"}${field.propertyName}${r"}"}</#if></#list> </update> </#if> </#list> <#list table.fields as field> <#if field.keyFlag> <!-- 新增表${table.name}信息 --> <insert id="add${entity}"> insert into ${table.name} (<#list table.fields as field><#if field.keyFlag>${field.name}</#if></#list><#list table.fields as field><#if !field.keyFlag>,${field.name}</#if></#list>) values (<#list table.fields as field><#if field.keyFlag>${r"#{"}${field.propertyName}${r"}"}</#if></#list><#list table.fields as field><#if !field.keyFlag>,${r"#{"}${field.propertyName}${r"}"}</#if></#list>) </insert> </#if> </#list> <#if baseColumnList> <!-- 通用查询结果列 --> <sql id="Base_Column_List"> <#list table.commonFields as field> ${field.name}, </#list> ${table.fieldNames} </sql> </#if> </mapper>
5.全部配置完,直接用java Application运行generate
注意点:主要在generate中,把需要的地址,数据源,路径配置好即可使用