MyBatis Plus Generator——MyBatis Plus代码生成器DEMO

客官°小女子只卖身不卖艺 2022-10-29 15:20 148阅读 0赞

# 官方文档 #

[https://mp.baomidou.com/guide/generator.html][https_mp.baomidou.com_guide_generator.html]

# Maven #

<dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity-engine-core</artifactId>
                <version>2.2</version>
            </dependency>

# DEMO  #

package com.hailiu.generator.mybatisplus;
    
    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 java.text.SimpleDateFormat;
    import java.util.*;
    
    /**
     * MyBatis Plus 代码生成器
     * @author ShenTuZhiGang
     * @version 1.0.2
     * @date 2020-03-31 17:02
     */
    // 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
    public class MyBatisPlusGenerator {
    
        /**
         * <p>
         * 读取控制台内容
         * </p>
         */
        public static String scanner(String tip) {
            Scanner scanner = new Scanner(System.in);
            String help = "请输入" + tip + "：";
            System.out.println(help);
            if (scanner.hasNext()) {
                String ipt = scanner.next();
                if (StringUtils.isNotBlank(ipt)) {
                    return ipt;
                }
            }
            throw new MybatisPlusException("请输入正确的" + tip + "！");
        }
    
        public static void main(String[] args) {
            ResourceBundle resource = ResourceBundle.getBundle("mybatisplus-demo");
    
            // 代码生成器
            AutoGenerator mpg = new AutoGenerator();
    
            // 全局配置
            GlobalConfig gc = new GlobalConfig();
            String projectPath = System.getProperty("user.dir");
            gc.setOutputDir(projectPath + "/src/main/java");
            gc.setAuthor("ShenTuZhiGang");
            gc.setOpen(false);
            gc.setSwagger2(true); //实体属性 Swagger2 注解
            gc.setBaseResultMap(true); //通用查询映射结果
            gc.setBaseColumnList(true); //通用查询结果列
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl(resource.getString("datasource.url"));
            dsc.setSchemaName(resource.getString("datasource.schema-name"));
            dsc.setDriverName(resource.getString("datasource.driver-class-name"));
            dsc.setUsername(resource.getString("datasource.username"));
            dsc.setPassword(resource.getString("datasource.password"));
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setModuleName("hailiu");
            pc.setParent("com");
            pc.setEntity("model"); // 定义实体类包名
            mpg.setPackageInfo(pc);
    
            // 自定义配置
            InjectionConfig cfg = new InjectionConfig() {
                @Override
                public void initMap() {
                    // to do nothing
                    Map<String, Object> map = new HashMap<>();
                    map.put("time", new SimpleDateFormat("HH:mm").format(new Date()));
                    map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
                    this.setMap(map);
                }
            };
    
            // 如果模板引擎是 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/db/mapper" //+ pc.getModuleName()
                            + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                }
            });
            /*
            cfg.setFileCreate(new IFileCreate() {
                @Override
                public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                    // 判断自定义文件夹是否需要创建
                    checkDir("调用默认方法创建的目录");
                    return false;
                }
            });
            */
            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("你自己的父类实体,没有就不用设置!");
            strategy.setEntityLombokModel(true);
            strategy.setRestControllerStyle(true);
            // 公共父类
            //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
            // 写于父类中的公共字段
            //strategy.setSuperEntityColumns("id");
            strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
            strategy.setControllerMappingHyphenStyle(true);
            strategy.setTablePrefix(pc.getModuleName() + "_");
            mpg.setStrategy(strategy);
            //mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            mpg.execute();
        }
    
    }

# 参考文章 #

[基于mybatis-plus的代码自动生成工具（自定义模板）][mybatis-plus]

[Mybatis Plus——AutoGenerator配置BaseResultMap(通用查询映射结果)和BaseColumnList(通用查询结果列)自动生成][Mybatis Plus_AutoGenerator_BaseResultMap_BaseColumnList]

[https_mp.baomidou.com_guide_generator.html]: https://mp.baomidou.com/guide/generator.html
[mybatis-plus]: https://blog.csdn.net/weixin_44097750/article/details/103276477
[Mybatis Plus_AutoGenerator_BaseResultMap_BaseColumnList]: https://shentuzhigang.blog.csdn.net/article/details/107822932