Mybatis plus 代码生成器的使用

主要采用Spring Boot与Mybatis Plus整合使用
通过Eclipse或者Idea建立一个Spring Boot项目
相关的pom.xml依赖为

	4.0.0
	
		org.springframework.boot
		spring-boot-starter-parent
		2.1.6.RELEASE
		 
	
	com.hxs
	mybatis-plus
	0.0.1-SNAPSHOT
	mybatis-plus
	Demo project for Spring Boot

	
		1.8
	

	
        
            org.springframework.boot
            spring-boot-starter-web
        

        
            org.springframework.boot
            spring-boot-starter-test
            test
        

        
        
            org.freemarker
            freemarker
            2.3.23
        
        
            com.baomidou
            mybatis-plus-boot-starter
            3.1.1
        
        
        
            com.baomidou
            mybatis-plus-generator
            3.1.1
        
        
            org.projectlombok
            lombok
            true
        
        
            mysql
            mysql-connector-java
            runtime
        
    

	
		
			
				org.springframework.boot
				spring-boot-maven-plugin
			
		
	

导入完成后我们需要配置一下Mybatis Plus的代码生成器Mpconfig.java的相关配置，具体代码如下：

package com.hxs.mpdemo;

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
/**
 * @ProjectName: mybatis-plus
 * @Package: com.hxs.mpdemo.mpconfig
 * @ClassName: CodeGenerator
 * @Author: hxs
 * @email:[email protected]
 * @Description: 代码生成器
 * @Date: 2019/6/28/15:05
 */
public class mpConfig {
	/**
     * 读取控制台内容
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        /**
         * 代码生成器，关键配置
         */
        AutoGenerator mpg = new AutoGenerator();

        /**
         * 全局配置
         */
        GlobalConfig globalConfig = new GlobalConfig();
        //生成文件的输出目录
        String projectPath = System.getProperty("user.dir");
        globalConfig.setOutputDir(projectPath + "/src/main/java");//生成文件的路径
        //Author设置作者
        globalConfig.setAuthor("xxx");
        //是否覆盖文件
        globalConfig.setFileOverride(true);
        //生成后打开文件
        globalConfig.setOpen(false);
        mpg.setGlobalConfig(globalConfig);

        /**
         * 数据源配置
          */
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        // 数据库类型,默认MYSQL
        dataSourceConfig.setDbType(DbType.MYSQL);
        //自定义数据类型转换
        dataSourceConfig.setTypeConvert(new MySqlTypeConvert());
        //JDBC连接池配置。Tip：serverTimezone=GMT%2B8为时区建议带上，不带可能会出错，useSSL=false"：  MySql在高版本需要指明是否进行SSL连接，解决的办法也很简单
在mysql连接数据库的url最后加入ssl=true或者false就可以了。
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mybatisplus?characterEncoding=utf-8&serverTimezone=GMT%2B8&useSSL=false");
        dataSourceConfig.setDriverName("com.mysql.jdbc.Driver");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setPassword("root");
        mpg.setDataSource(dataSourceConfig);

        /**
         * 包配置
         */
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        //父包名。如果为空，将下面子包名必须写全部， 否则就只需写子包名
        pc.setParent("com.hxs.mpdemo");
        mpg.setPackageInfo(pc);


        /**
         * 自定义配置
         */
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        /**
         * 模板
         */
        //如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";


        /**
         * 自定义输出配置
         */
        List focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @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();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        /**
         *代码生成器策略配置
         */
        StrategyConfig strategy = new StrategyConfig();
        //设置命名格式
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
        //实体是否为lombok模型（默认 false）
        strategy.setEntityLombokModel(true);
        //生成 @RestController 控制器
        strategy.setRestControllerStyle(true);
        //设置自定义继承的Entity类全称，带包名
        //strategy.setSuperEntityClass("com.jiangfeixiang.mpdemo.BaseEntity");
        //设置自定义继承的Controller类全称，带包名
        //strategy.setSuperControllerClass("com.jiangfeixiang.mpdemo.BaseController");
        //设置自定义基础的Entity类，公共字段
        strategy.setSuperEntityColumns("id");
        //驼峰转连字符
        strategy.setControllerMappingHyphenStyle(true);
        //表名前缀
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();//执行配置
    }

}

application.properties

spring.jackson.serialization.FAIL_ON_EMPTY_BEANS=false
//不关闭的话会在程序运行时出现某种序列化问题

application.yml用于配置连接数据库的信息

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatisplus?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC
    username: root
    password: root
    driver-class-name: com.mysql.jdbc.Driver
server:
  port: 8081
  

上面两个属性配置文件可以放在一起。
运行如上所述的Mpconfig.java使得逆向生成controller(控制层)，entity(实体类)，mapper(映射文件)，service(业务层)以及service.impl(实现类)等，所生成的文件如下图所示

在controller(控制层)编写测试语句

package com.hxs.mpdemo.springbootmp.controller;


import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import com.hxs.mpdemo.springbootmp.entity.User;
import com.hxs.mpdemo.springbootmp.service.IUserService;
/**
 * 

 *  前端控制器
 * 
 *
 * @author x'x'x
 * @since 2019-06-28
 */
@RestController
public class UserController {

    @Autowired
    private IUserService iUserService;

    /**
     * 获取所有User
     * @return
     */
    @RequestMapping("/getAllUser")
    public List getAllUser(){
        List list = iUserService.list();
        System.out.println(list);
        return list;
    }
  
    @RequestMapping(value = "/delete")
    public void delete(@RequestParam Integer id) {
    	iUserService.removeById(id);		
    }
}

启动Spring Boot主应用程序。测试结果可以采用Postman工具
https://www.getpostman.com/下载地址。

测试结果正常
测试删除http://localhost:8081/delete?id=5删除id=5的相关信息。

数据库以及删除掉相关信息了。
第一次写博客不喜勿喷，欢迎建议。删除和修改可以自行测试。