MyBatisPlus代码生成器实践(自己二次封装)

前提准备

在正式开始之前，先把需要的依赖都摆到台面上。代码生成器离不开MyBatis Plus Generator核心，再加上数据库驱动、模板引擎和Swagger注解支持——这些缺一不可。直接复制下面这份Ma ven依赖，省得自己拼拼凑凑出问题。

    com.baomidou
    mybatis-plus-generator
    3.4.1


    mysql
    mysql-connector-ja va
    runtime


    org.apache.velocity
    velocity-engine-core
    2.0


    io.springfox
    springfox-boot-starter
    3.0.0


    org.projectlombok
    lombok

顺手提醒一句：Lombok和Swagger3是业务代码的标配，如果项目里已经有了，可以去掉对应依赖，不然会冲突。Velocity模板引擎是默认生成器用的，如果换了Freemarker，记得替换依赖。

核心配置

前提说明

配置其实很单纯：把核心参数填进去，代码生成器就能按预期吐出代码。下面这张图展示了整体工作流——从数据库表到实体、Mapper、Service、Controller一条龙产出。

代码配置

官方文档永远是最准确的参考来源，尤其当你想微调某个生成细节时。建议先快速过一遍baomidou的配置手册：https://mp.baomidou.com/config/generator-config.html#%E6%95%B0%E6%8D%AE%E6%BA%90-datasourceconfig-%E9%85%8D%E7%BD%AE

直接贴出一份封装好的生成器代码，所有关键配置都集中在了静态变量里，改起来一目了然：

package com.changlu.demo;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

/**
 * @author ChangLu
 * @date 2021/09/22 16:38
 * @Desc 封装之后的代码生成器，仅需填写几个核心配置即可
 * 
 *  核心依赖
    *         
    *      com.baomidou       
    *      mybatis-plus-generator       
    *      3.4.1       
    *         
    *         
    *      mysql       
    *      mysql-connector-ja va       
    *      runtime       
    *         
    *         
    *      org.apache.velocity       
    *      velocity-engine-core       
    *      2.0       
    *         
 *  其他依赖如：lombok、swagger3
 **/
public class MyCodeGenerator {

    //核心配置
    private static String targetDatabaseName = "dj.svublog.rdb";//目标数据库名
    private static String username = "root";//用户名
    private static String password = "123456";//密码
    private static String[] tihuan_table_prefix = {"sys_"}; //表替换前缀，可多个
    private static String[] paichu_table_name = {"sys_member_role","sys_role_permission"}; //排除指定表，可多个
    private static String referenceModule = "com.changlu.demo"; //当前的引用模块，如com.changlu.demo
    private static String targetModule = "test"; //输出指定文件目录的包名 如：test

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        //全局配置（若是多模块的话传入对应模块的工程名！）
        mpg.setGlobalConfig(createGlobalConfig(null));
//        mpg.setGlobalConfig(createGlobalConfig(common));
        //数据库源
        mpg.setDataSource(createDataSourceConfig());
        //包配置
        mpg.setPackageInfo(createPackageConfig());
        //策略配置
        mpg.setStrategy(createStrategyConfig());
        //默认Velocity模板生成
//        mpg.setTemplateEngine(new FreemarkerTemplateEngine());  //其他模板Freemarker

        //执行操作
        mpg.execute();
    }
    // 1、全局配置  若是多模块，传入指定父模块名称
    private static GlobalConfig createGlobalConfig(String parentModuleName){
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");//获取到当前工程路径地址，若是多模块情况就会有问题
        if(parentModuleName != null){
            projectPath = projectPath + "/"+parentModuleName+ "/src/main/ja va";
        }else{
            projectPath = projectPath + "/src/main/ja va";
        }
        gc.setOutputDir(projectPath)
                .setAuthor("ChangLu") //设置作者
                .setOpen(false) //不打开输出目录
                .setSwagger2(true) //添加swagger2注解
                .setBaseResultMap(true) //每个mapper文件中都生成通用结果映射集
                .setFileOverride(true) //下次生成文件时进行覆盖(不设置的话当进行第二次生成就会在同一个目录产生相同的文件)
                .setEntityName("%sModel") //生成实体类文件名，如：%sModel 生成 UserModel
                .setMapperName("%sMapper") //生成dao，这里我们配置生成如 UserMapper
                .setMapperName("%sMapper") //生成mapper.xml文件，这里生成如 UserMapper.xml
                .setServiceName("%sService") //生成service接口
                .setServiceImplName("%sServiceImpl");//生成service实现类
        return gc;
    }

    // 2、数据库源
    private static DataSourceConfig createDataSourceConfig(){
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/+"+targetDatabaseName+"+?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai")
            .setDriverName("com.mysql.cj.jdbc.Driver")
            .setUsername(username)
            .setPassword(password);
        //转换类型  LocalDateTime=>Date
        dsc.setTypeConvert((globalConfig, fieldType) -> {
            String t = fieldType.toLowerCase();
            if(t.contains("datetime")){   //若是匹配到数据库类型为"datetime"，就返回Date类型（转为Ja va的）
                return DbColumnType.DATE;
            }
            //其它字段采用默认转换（非mysql数据库可以使用其它默认的数据库转换器）
            return new MySqlTypeConvert().processTypeConvert(globalConfig,fieldType);
        });
        return dsc;
    }

    //3、包配置
    private static PackageConfig createPackageConfig(){
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(targetModule) //生成的模块名，也就是生成目标指定文件名的路径下
          .setParent(referenceModule); //父包名。如果为空，将下面子包名必须写全部， 否则就只需写子包名
        return pc;
    }

    //4、策略配置
    private static StrategyConfig createStrategyConfig(){
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel) //表名生成策略：下划线转驼峰，如pms_pro=>PmsPro
                .setColumnNaming(NamingStrategy.underline_to_camel) //字段名生成策略，同上，如last_name=>lastName
                .setEntityLombokModel(true) //支持lombok注解
                .setTablePrefix(tihuan_table_prefix) //设置表的替换前缀：这里就是起到过滤作用
                .setEntityTableFieldAnnotationEnable(true) //生成表、字段映射注解
                .setExclude(paichu_table_name); //排除指定表
        return strategy;
    }
}

生成的Mapper XML文件默认会放在resource/mapper下，Spring Boot会自动扫描，不用额外配置。如果想把XML放到其他位置，记得在配置中指定路径或者在application.yml里补充spring-boot-mapper的扫描。

总结

这一套二次封装的核心思路就是把易变的参数拎到顶部，稳定的流水线逻辑藏进私有方法里。实际项目落地时，你只需要改改数据库名、表前缀、排除表这些业务相关项，剩下的交给生成器自动跑。如果能结合多模块项目进一步抽离公共配置，就能做到一次封装、多项目复用——这才是代码生成器该有的生产力。不过话说回来，官方文档永远是终极参考，遇到边界情况时翻一翻，比自己猜要靠谱得多。