mybatis-plus 代码自动生成配置

代码自动生成

拿来即用，只需修改配置文件即可。

增加以下两个文件即可，然后增加依赖。

增加依赖：

swagger，lombok在Generate开启了，所以需要依赖。或者修改Generate。

pom.xml 自动生成环境

<!--mybatis-plus 代码生成器依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>
        <!--freemarker 依赖生成mapper.xml 的模板 -->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
        </dependency>
<!-- 连接驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

生成后的文件需要的环境

pom.xml 生成后代码环境

	<properties>
        <knife4j.version>2.0.2</knife4j.version>
        <lombok.version>1.18.4</lombok.version>
        <druid.version>1.1.10</druid.version>
        <mybatis-plus.version>3.3.0</mybatis-plus.version>
    </properties>
<!-- 接口管理工具 -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>${knife4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
            <scope>provided</scope>
        </dependency>
 <!-- mybatis-plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>${druid.version}</version>
        </dependency>
<!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
            <scope>provided</scope>
        </dependency>

Generate.java

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.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.Scanner;

/**
 * @author ppliang
 * @title: Generate
 * @projectName db-generate
 * @description: 代码自动生成器
 * @date 2021-03-30 17:26
 */
public class Generate {

    private Logger logger = LoggerFactory.getLogger(Generate.class);

    private String URL;
    private String DRIVER;
    private String USERNAME;
    private String PASSWORD;
    private String PARENTPATH;
    private String AUTHOR;

    /**
     * @param
     * @return void
     * @description: 读取jdbc配置文件
     * @author ppliang
     * @date 2021/4/14 16:16
     */
    public void init() {
        InputStream jdbcStream = Object.class.getResourceAsStream("/config/generate-jdbc.properties");
        try {
            Properties jdbcProperties = new Properties();
            if (jdbcStream==null) {
                System.out.println("resources/config/generate-jdbc.properties 文件不存在");
                return;
            }
            jdbcProperties.load(jdbcStream);
            URL = jdbcProperties.getProperty("URL");
            DRIVER = jdbcProperties.getProperty("DRIVER");
            USERNAME = jdbcProperties.getProperty("USERNAME");
            PASSWORD = jdbcProperties.getProperty("PASSWORD");
            PARENTPATH = jdbcProperties.getProperty("PARENTPATH");
            AUTHOR = jdbcProperties.getProperty("AUTHOR");
            if(URL.length()>PASSWORD.length()) {
                System.out.println("数据读取成功");
            }
        } catch (IOException e) {
            logger.error("读取文件失败");
            e.printStackTrace();
        }catch (NullPointerException e) {
            logger.error("读取数据失败,查看配置文件的key是否匹配");
            e.printStackTrace();
        }
    }

    /**
     * 读取控制台内容
     */
    public 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.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }


    public void create() {
        // 代码生成器
        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);
        //xml开启 BaseResultMap
        gc.setBaseResultMap(true);
        //xml 开启BaseColumnList
        gc.setBaseColumnList(true);
        // 实体属性 Swagger2 注解
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(URL);
        dsc.setDriverName(DRIVER);
        dsc.setUsername(USERNAME);
        dsc.setPassword(PASSWORD);
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent(PARENTPATH)
                .setEntity("pojo")
                .setMapper("mapper")
                .setService("service")
                .setServiceImpl("service.impl")
                .setController("controller");
        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<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath   + "/src/main/resources/mapper/" + 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);
        //lombok模型
        strategy.setEntityLombokModel(true);
        //生成 @RestController 控制器
        strategy.setRestControllerStyle(false);
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        //表前缀
        strategy.setTablePrefix("t_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }


    public static void main(String[] args) {
        Generate generate = new Generate();
        generate.init();
        generate.create();
    }
}

clean.java

package com.ppl.dbgenerate;

import java.io.File;

/**
 * @author ppliang
 */
public class Clean {


    //项目中间路径
    private final static String midPath="\\src\\main\\java\\com\\ppl\\dbgenerate\\";
    //清除模块下文件夹
    private final static String[] paths={"controller","mapper","pojo","service"};

    public static void main(String[] args) {
        for (String path:paths){
            File file = getFile(path);
            deleteFiles(file);
        }
        //删除mapper下的文件
        clearResources();
        System.out.println("数据已清空");
    }

    //删除mapper下的文件
    private static boolean deleteFiles(File directory){
        File [] files = directory.listFiles();
        if(files==null||files.length<1){
            return true;
        }
        for (File file:files){
            if(file.isDirectory()){
                deleteFiles(file);
            }else {
                file.delete();
            }
        }
        return true;
    }

    private static void clearResources(){
        String path=System.getProperty("user.dir")+"\\src\\main\\resources\\mapper";
        File file = new File(path);
        deleteFiles(file);
    }
    
    //获取文件
    private static File getFile(String name){
        String path=System.getProperty("user.dir")+midPath+name;
        File file = new File(path);
        return file;
    }
}

generate-jdbc.properties

#配置连接数据库的信息
URL=jdbc:mysql://localhost:3306/database?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
DRIVER=com.mysql.cj.jdbc.Driver
USERNAME=root
PASSWORD=123456

#项目路径
PARENTPATH=com.ppl.xk
#作者名称
AUTHOR=ppliang