Mybatis-plus 代码生成器的使用

代码生成器

mybatis-plus（简称 mp）是一个 mybatis 的增强工具，在 mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

 

环境参数

 

• 开发工具：idea
• 基础环境：maven+jdk8
• 所用技术：springboot、mybatis-plus、mysql 
• springboot版本：2.2.6

 

步骤演示

一、添加mybatis plus依赖

       <!--spring-boot web-->
           <dependency>
               <groupid>org.springframework.boot</groupid>
               <artifactid>spring-boot-starter-web</artifactid>
       </dependency>

      <!--mysql依赖-->
        <dependency>
            <groupid>mysql</groupid>
            <artifactid>mysql-connector-java</artifactid>
            <version>5.1.42</version>
            <scope>runtime</scope>
        </dependency>

        <!--生成实体成set set 方法-->
        <dependency>
            <groupid>org.projectlombok</groupid>
            <artifactid>lombok</artifactid>
            <optional>true</optional>
        </dependency>

        <!-- mybatisplus 核心库 -->
        <dependency>
            <groupid>com.baomidou</groupid>
            <artifactid>mybatis-plus-boot-starter</artifactid>
            <version>3.1.0</version>
        </dependency>

        <!-- 引入阿里数据库连接池 -->
        <dependency>
            <groupid>com.alibaba</groupid>
            <artifactid>druid</artifactid>
            <version>1.1.6</version>
        </dependency>

        <!--  mybatis plus 代码生成器 -->
        <dependency>
            <groupid>com.baomidou</groupid>
            <artifactid>mybatis-plus-generator</artifactid>
            <version>3.0.6</version>
        </dependency>
        <dependency>
            <groupid>org.freemarker</groupid>
            <artifactid>freemarker</artifactid>
            <version>2.3.20</version>
        </dependency>

 

二、创建生成器主类

package com.ckf.crm_generator.mapper;

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 java.util.arraylist;
import java.util.list;
import java.util.scanner;

/**
 * 代码生成器类
 *
 * @author 安详的苦丁茶
 * @version 1.0
 * @date 2020/3/23 15:53
 */
public class codegenerator {

    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    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 gc = new globalconfig();
        final string projectpath = system.getproperty("user.dir");
        gc.setoutputdir(projectpath + "/src/main/java");
        gc.setauthor("安详的苦丁茶");
        gc.setbaseresultmap(true);
        gc.setbasecolumnlist(true);
        // 是否打开输出目录 默认为true
        gc.setopen(false);
        mpg.setglobalconfig(gc);

        // 数据源配置
        datasourceconfig dsc = new datasourceconfig();
        dsc.seturl("jdbc:mysql://localhost:3306/ckf_crm?useunicode=true&usessl=false&characterencoding=utf8");
        dsc.setdrivername("com.mysql.jdbc.driver");
        dsc.setusername("root");
        dsc.setpassword("root");
        mpg.setdatasource(dsc);

        // 包配置
        final packageconfig pc = new packageconfig();
        // pc.setmodulename(scanner("模块名"));
        pc.setparent("com.ckf.crm_generator");
        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<fileoutconfig>();
        // 自定义配置会被优先输出
        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();

        // 配置自定义输出模板
        // 指定自定义模板路径，注意不要带上.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.setsuperentityclass("com.fame.common.baseentity");
        strategy.setentitylombokmodel(true);
        strategy.setrestcontrollerstyle(true);
        // strategy.setsupercontrollerclass("com.fame.common.basecontroller");
        strategy.setinclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setsuperentitycolumns("id");
        // strategy.setcontrollermappinghyphenstyle(true);
        strategy.settableprefix("sys");
        mpg.setstrategy(strategy);
        mpg.settemplateengine(new freemarkertemplateengine());
        mpg.execute();
    }

}

 

这里演示的是springboot项目

dsc.seturl("jdbc:mysql://localhost:3306/ckf_crm?useunicode=true&usessl=false&characterencoding=utf8"); //数据库url

gc.setoutputdir(projectpath + "/src/main/java"); //设置文件输出路径

pc.setparent("com.ckf.crm_generator");  //父包名


三、接着在生成器类运行main方法，在控制台输入数据库表的名称即可生成三层代码
效果图如下

下图是我项目的路径（执行代码生成器之后的项目结构）：

 

然后它是按照mybatis-plus的风格把三层的代码生成好了
实体类

 

 mapper

 

下面就不截图那些模块的代码了哈，感兴趣的可以试一下哈。

 

注意，代码生成前请确保数据库中表已经存在。

项目已托管到码云
地址：https://gitee.com/ckfeng/crm_generator.git