Mybatis-Plus如何自动生成代码

阳光穿透心脏的1/2处 2023-09-26 22:20 127阅读 0赞

### 前言 ###

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

### Our-task介绍 ###

本篇博客是我的github上项目[our-task：一个完整的清单管理系统][our-task]的配套教程文档，大家感兴趣的话，可以去看看

### 操作步骤 ###

#### 创建SpringBoot项目 ####

先在IDEA中创建一个SpringBoot的项目，一直next就可以创建完成

![format_png][]

#### 设置pom依赖 ####

<dependencies>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-aop</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.2.0</version>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-freemarker</artifactId>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.3.0</version>
            </dependency>
            
            <dependency>
                <groupId>cn.hutool</groupId>
                <artifactId>hutool-all</artifactId>
                <version>5.3.3</version>
            </dependency>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
        </dependencies>
    复制代码

#### 创建CodeGenerator类 ####

这是mybatis-plus自动生成代码的文件，我是把这个文件和DemoApplication放在同一级目录下，大家把下面的代码粘贴过去，需要设置数据库的连接信息、service，controller、xml文件等代码的自动生成目录。

只要修改以下这些代码位置就可以了

//这个路径是生成路径
    gc.setOutputDir(projectPath + "/src/main/java");
    复制代码

// 数据源配置(这里替换为自己的数据库配置)
    DataSourceConfig dsc = new DataSourceConfig();
    dsc.setUrl("jdbc:mysql://localhost:3306/our-task?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC");
    dsc.setDriverName("com.mysql.cj.jdbc.Driver");
    dsc.setUsername("root");
    dsc.setPassword("abc+!@#123");
    复制代码

//这里配置生成的service/controller等代码，放在哪个包下面
    pc.setParent("com.example.demo");
    复制代码

// 配置生成的xml存放的位置 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
    return projectPath + "/src/main/resources/mapper/"
            + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
    复制代码

第一次更改，可能会发现生成代码的路径和自己预想的不一样，大家可以直接把生成的代码删掉，修改路径，重新生成，多试试就行了

下面给大家贴出生成的全部代码

package com.example.demo;
    
    import cn.hutool.core.util.StrUtil;
    import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
    import com.baomidou.mybatisplus.core.toolkit.StringPool;
    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;
    
    /**
     * @program: our-task-study
     * @description: mybatis-plus代码自动生成类
     * @author: water76016
     * @create: 2020-09-24 16:45
     **/
    public class CodeGenerator {
        /**
         * 读取控制台内容
         */
        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 (StrUtil.isEmpty(ipt) == false){
                    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 + "/src/main/java");
            gc.setAuthor("github:water76016");
            gc.setOpen(false);
            // gc.setSwagger2(true); 实体属性 Swagger2 注解
            gc.setServiceName("%sService");
            mpg.setGlobalConfig(gc);
    
            // 数据源配置(这里替换为自己的数据库配置)
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/our-task?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC");
            dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("abc+!@#123");
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setModuleName(null);
            //这里配置生成的service/controller等代码，放在哪个包下面
            pc.setParent("com.example.demo");
            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) {
                    // 配置生成的xml存放的位置 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                    return projectPath + "/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.underline_to_camel);
            strategy.setEntityLombokModel(true);
            strategy.setRestControllerStyle(true);
            strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
            strategy.setControllerMappingHyphenStyle(true);
            strategy.setTablePrefix("m_");
            mpg.setStrategy(strategy);
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            mpg.execute();
        }
    }
    复制代码

#### 右键运行CodeGenerator生成代码 ####

运行之后，就会读取我们数据库的配置，根据里面的表，自动生成service、mapper、controller、xml文件等代码了。

输入表名，多个表用英文的逗号分隔，最后敲回车就行

![format_png 1][]

这就是我们的代码生成好的结果

![format_png 2][]

#### 特别注意事项 ####

大家在生成代码之前，一定要把数据库设计好，包括：表名、表字段类型等等，都要考虑好，不然代码生成之后，后续想要修改数据库，重新修改代码是一件很麻烦的事

#### 后续操作 ####

想要运行代码，我们还需要一些配置

在yml文件中加入数据库的配置和xml文件的扫描路径

mybatis-plus:
      mapper-locations: /classpath*:/mapper/**Mapper.xml
    
    spring:
      datasource:
        driver-class-name: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://localhost:3306/our-task?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai&tinyInt1isBit=false&allowPublicKeyRetrieval=true
        username: daxingyong
        password: daxingyong
    复制代码

由于还需要扫描mapper的路径，所以需要在SpringBoot的启动类上，加入@MapperScan("com.example.demo.mapper")，其中引号里面是我们的mapper文件的存放路径

package com.example.demo;
    
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @MapperScan("com.example.demo.mapper")
    public class DemoApplication {
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    }

作者：冷小风的IT生活  
链接：https://juejin.cn/post/7224147971834085431

[our-task]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fwater76016%2Four-task
[format_png]: https://img-blog.csdnimg.cn/img_convert/c8fe6e05afccd07eacd916c8b772a5f9.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/10aec01499c74bf09da5d99747853310.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/ba440ae4546b5e78c8ba96fffacb9d2e.webp?x-oss-process=image/format,png