使用Mybatis Plus 自动创建模板文件

使用Mybatis Plus 自动创建模板文件

0 使用效果

使用java进行服务器端编程，最日常的工作就是根据数据库表生成实体类文件了，之前我使用过 mybatis generator，通用Mapper感觉都不是特别好用呀，然后就巴拉了一下 Myabtis plus 的官网还有它的github demo。希望能够自己使用Mybaits Plus 生成满意的文件了，所以就有了这篇文章，研究了一天的结果现在给大家吧！


首先明确一下这篇文章的目标：

1. 通过Mybatis plus 生成 Controller ，Service ，ServiceImpl ，Entity，XML，甚至还有自己做项目用到的 C#端的实体类文件哟！
2. 后来者修改对应配置就能够使用，节约学习时间。
3. 项目例程我放在自己的github中了，欢迎大家来start。

github项目地址： https://github.com/nnlzb66/mybatis-plus-learning.git


话不多说，接下来看一看 Mybatis plus 的生成代码的使用姿势吧。

1 导入相关依赖包

        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.1</version>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>

        <!-- 由于我这里使用的是FreeMarker作为模板引擎，因此多了一个FreeMarker的包 -->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>

         <!-- 习惯使用fastjson --> 
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.75</version>
        </dependency>

        <!--MySQL JDBC驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

2 编写生器代码

首先我们要写入需要生成实体类的表格，如果表格比较多，可以用以下语句查询出来。

--  查询daily开头的表格，用逗号拼接
select 
GROUP_CONCAT(table_name)
from information_schema.`TABLES` 
where table_schema = 'shggs'
and table_name like 'daily%'

下边的代码我已经按照官网给的例子给大家整好了，第一次使用的时候，只需要修改对应的配置就好了。

package com.baomidou.mybatisplus.samples.generator;

import java.io.File;
import java.text.SimpleDateFormat;
import java.util.*;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.builder.ConfigBuilder;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.FileType;
import org.junit.Test;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

/**
 * mybatis plus 的代码生成功能，附带全套自定义模板
 * @author lizhongbin
 * @date  2020-11-27
 */
public class CodeGenerator {
   

    // 作者
    private static String AUTHOR = "lizhongbin";
    // 生成的实体类忽略表前缀: 不需要则置空
    private static String ENTITY_IGNORE_PREFIX = "";
    // 表名数组
    private static String[] TABLES ="daily_abs,daily_abs_second,daily_cd,daily_cd_credit_profit_gap,daily_cd_profit_gap,daily_comment,daily_drzp,daily_drzp_base_profit_gap,daily_drzp_credit_profit_gap,daily_drzp_profit_gap,daily_jrz,daily_llz,daily_llz_region,daily_llz_term_profit_gap"
            .split(",");

    // 数据库
    private static String DB_URL = "jdbc:mysql://localhost:3306/shggs?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT%2B8";
    private static DbType DB_TYPE = DbType.MYSQL;
    private static String DB_DRIVER = "com.mysql.cj.jdbc.Driver";
    private static String DB_SCHEMA = "shggs";
    private static String DB_USER_NAME = "root";
    private static String DB_PASSWORD = "123456";

    // 输出路径
    private static String OUTPUT_PATH = "C:\\working\\idea project\\gushou-data-api\\src\\main";


    // 父包名
    private static String PARENT_PACKAGE         = "com.shgsec.gushoudata_api.daily";
    // 下边是分类包名
    // 输出包名 = 父包名 + "." + 分类包名
    private static String CONTROLLER_PACKAGE     = "controller";
    private static String SERVICE_PACKAGE        = "service";
    private static String SERVICE_IMPL_PACKAGE   = "service.impl";
    private static String MAPPER_PACKAGE         = "dao";
    private static String ENTITY_PACKAGE         = "bean";
    private static String C_SHARP_ENTITY_PACKAGE = "DailyReport";

    // mapper存放路径 = OUTPUT_PATH + MAPPER_XML_PACKAGE
    private static String MAPPER_XML_PACKAGE     = "/resources/mapper/daily";

    // 模板路径
    private static JSONObject templates = new JSONObject();

    // 注释掉模板表示不生成该类模板
    static{
   
        templates.put("CONTROLLER_TEMPLATE", "templates/controller.java.ftl");
        templates.put("SERVICE_TEMPLATE", "templates/service.java.ftl");
        templates.put("SERVICE_IMPL_TEMPLATE", "templates/serviceImpl.java.ftl");
        templates.put("ENTITY_TEMPLATE", "templates/entity.java.ftl");
        templates.put("MAPPER_TEMPLATE", "templates/mapper.java.ftl");
        templates.put("MAPPER_XML_TEMPLATE", "templates/mapper.xml.ftl");
//        templates.put("C_SHARP_ENTITY_TEMPLATE", "templates/C#entity.cs.ftl");
    }

    // 生成的实体类尾缀  例如: UserEntity
    private static String Entity_SUFFIX = "Entity";

    public static void main(String args[]){
   

        // 全局配置
        GlobalConfig globalConfig = globalConfig();

        // 数据库连接配置
        DataSourceConfig dataSourceConfig = dataSourceConfig();

        // 策略配置
        StrategyConfig strategyConfig = strategyConfig();

        // 包配置
        PackageConfig packageConfig = packageConfig();

        // 模板配置
        TemplateConfig templateConfig = templateConfig();


        // 自定义配置
        InjectionConfig injectionConfig = injectionConfig();

        // 执行
        AutoGenerator autoGenerator = new AutoGenerator();
        autoGenerator.setGlobalConfig(globalConfig)
                .setDataSource(dataSourceConfig)
                .setStrategy(strategyConfig)
                .setPackageInfo(packageConfig)
                // 因为使用了自定义模板,所以需要把各项置空否则会多生成一次
                .setTemplate(templateConfig)
                // 使用的模板引擎，如果不是默认模板引擎则需要添加模板依赖到pom,现在用的是freemarker，需要导包
                .setTemplateEngine(new FreemarkerTemplateEngine())
                .setCfg(injectionConfig)
                .execute();

        // 用于查看配置中都有什么，方便写ftl模板时候自己去找配置，写到ftl中
//        System.out.println("================= 配置信息 =======================");
//        System.out.println(JSON.toJSONString(autoGenerator.getConfig(), SerializerFeature.PrettyFormat));

//        List<TableInfo> list = autoGenerator.getConfig().getTableInfoList();
//        for (TableInfo t:list) {
   
//            System.out.println("================= 表格信息 =======================");
//            System.out.println(JSON.toJSONString(t,SerializerFeature.PrettyFormat));
//        }
    }


    /**
     * 全局配置
     */
    private static GlobalConfig globalConfig() {
   
        return new GlobalConfig()
                // 打开文件
                .setOpen(false)
                // 文件覆盖
                .setFileOverride(true)
                // 开启activeRecord模式，开启之后就可以直接使用entity对数据库进行操作
                .setActiveRecord(true