MyBatis-Plus中AutoGenerator的详细使用案例

一时失言乱红尘 2024-04-29 19:11 54阅读 0赞

## AutoGenerator是什么？ ##

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Pojo、Mapper、 Mapper XML、Service、Controller 等各个模块的代码

## AutoGenerator能干什么？ ##

对于单表而言，几乎是一个全能的工具，极大的提升了开发效率。更多的关注业务逻辑的实现。

## 怎么使用？ ##

## 创建一个AutoGenerator项目 ##

AutoGenerator本身和我们项目没有关联，所以可以单独新建为一个Project，这边也做成Maven聚 合项目里的一个子项目

![659d3225b6e545388377dfd2e930f6ec.png][]

![1239f3bc4b684949b1f5b82b27375534.png][]

![bd296fb69bbd4dff8521e6a9e060f41d.png][]

相关依赖

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.3.1.tmp</version>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.3.1.tmp</version>
            </dependency>
            
            <dependency>
                <groupId>org.freemarker</groupId>
                <artifactId>freemarker</artifactId>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>

## CodeGenerator工具类 ##

package com.example.generator;
    
    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.DataSourceConfig;
    import com.baomidou.mybatisplus.generator.config.FileOutConfig;
    import com.baomidou.mybatisplus.generator.config.GlobalConfig;
    import com.baomidou.mybatisplus.generator.config.PackageConfig;
    import com.baomidou.mybatisplus.generator.config.StrategyConfig;
    import com.baomidou.mybatisplus.generator.config.TemplateConfig;
    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;
    /**
     * 执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
     *
     * @author zhoubin
     * @since 1.0.0
     */
    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();
            String projectPath = System.getProperty("user.dir");
            gc.setOutputDir(projectPath + "/yunzhi-generator/src/main/java");
            //作者
            gc.setAuthor("zhousir");
            //打开输出目录
            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("jdbc:mysql://localhost:3306/zhou_oa?useUnicode=true&characterEncoding=UTF-8&serverTimezone=AsiaShanghai");
            dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("123456");
            mpg.setDataSource(dsc);
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setParent("com.example")
                    .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 + "/yunzhi-generator/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.no_change);
            //lombok模型
            strategy.setEntityLombokModel(true);
            //生成 @RestController 控制器
            strategy.setRestControllerStyle(true);
            strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
            strategy.setControllerMappingHyphenStyle(true);
            //表前缀
            strategy.setTablePrefix("t_");
            mpg.setStrategy(strategy);
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            mpg.execute();
        }
    }

![305f7939b8f549329c877da4496a0b46.png][]

mysql 随便创建两个表， 给几个字段就好了

![6b808b544cd2413cb2ca63a8a6446782.png][]

![e37a0f909ebc4ba48213873d1ad2fd2d.png][]

这样就生成成功了！！！

[659d3225b6e545388377dfd2e930f6ec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/c852176ad1f442579d4dcbe87df2f26d.png
[1239f3bc4b684949b1f5b82b27375534.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/3cb23e7fcf6e4dea99ac95e852e28f33.png
[bd296fb69bbd4dff8521e6a9e060f41d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/6bde84844e8c4e0a86cd02c723ba5418.png
[305f7939b8f549329c877da4496a0b46.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/48bce86ff5bb487fab8ac95a03cc76d5.png
[6b808b544cd2413cb2ca63a8a6446782.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/59aae3e243e34875a8f873e99c344d53.png
[e37a0f909ebc4ba48213873d1ad2fd2d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/29/815b99092e1e4dadba468914d3b2dcf9.png