CodeGenerator——SpringBoot整合MyBatisPlus代码生成器

快来打我* 2024-03-26 09:54 75阅读 0赞

## CodeGenerator——SpringBoot整合MyBatisPlus代码生成器 ##

### 简介 ###

CodeGenerator 是Mybatis-Plus(Mybatis的一个增强工具,在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生)的一个工具,对于基础controller,entity,mapper,service这些层进行自动生成。

### 工程创建，代码讲解 ###

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

*  首先创建一个springboot项目  
    ![在这里插入图片描述][caf8c88602b14e4991587941f3120d80.png]

添加相关的依赖，这几个依赖基本都是所有springboot项目必须的，当然还要一个Mybatis-plus的依赖需要自己的手动导入。  
![在这里插入图片描述][e9bb7d02c99245ad8ab84a431c82ba55.png]  
mybatis-plus的依赖

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

#### application.yml ####

一定要配置这个信息，不然无法正常启动项目。

# DataSource Config
    spring:
      datasource:
        driver-class-name: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://localhost:3306/vueblog?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai
        username: root
        password: 123456
    mybatis-plus:
      mapper-locations: classpath*:/mapper/**Mapper.xml

#### pom.xml ####

这里是完整的pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.7.8</version>
            <relativePath/> 
        </parent>
        <groupId>com.example</groupId>
        <artifactId>CodeGeneratorDemo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>CodeGeneratorDemo</name>
        <description>CodeGeneratorDemo</description>
        <properties>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.3.0</version>
            </dependency>
    
            <dependency>
                <groupId>com.mysql</groupId>
                <artifactId>mysql-connector-j</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.2.0</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-freemarker</artifactId>
            </dependency>
    
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <excludes>
                            <exclude>
                                <groupId>org.projectlombok</groupId>
                                <artifactId>lombok</artifactId>
                            </exclude>
                        </excludes>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    
    </project>

#### 创建CodeGenerator ####

package com.example.codegeneratordemo;
    
    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 com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
    
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Scanner;
    
    // 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
    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 + "/src/main/java");
    //        gc.setOutputDir("D:\\test");
            gc.setAuthor("极客李华");
            gc.setOpen(false);
            // gc.setSwagger2(true); 实体属性 Swagger2 注解
            gc.setServiceName("%sService");
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/vueblog?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC");
            // dsc.setSchemaName("public");
            dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("123456");
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setModuleName(null);
            pc.setParent("com.example.codegeneratordemo");
            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 + "/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();
        }
    }

然后根据自己的数据库的情况，对这个配置信息的数据库的URL与对应的密码，进行修改。  
![在这里插入图片描述][6f4cf7f029ee429cab15bd9dff2c2f0a.png]  
这里也可以设置作者信息。  
![在这里插入图片描述][ab71bc360bc74bc5a61d64f55bf4a7ab.png]  
还需要注意的是，这里的这个包的信息也需要进行修改，不然后面的生成情况是有问题的。  
![在这里插入图片描述][5ddea7bd82d349feaab359802a07ce1a.png]

#### 配置MybatisPlusConfig信息 ####

这里的这个MapperScan扫包需要自定义根据自己的情况自定义的进行设置  
![在这里插入图片描述][e57328ec173b4986b56b8cc22f6fd56a.png]

完整代码

package com.example.codegeneratordemo.config;
    
    import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.transaction.annotation.EnableTransactionManagement;
    
    @Configuration
    @EnableTransactionManagement
    @MapperScan("com.example.codegeneratordemo.mapper")
    public class MybatisPlusConfig {
        
        @Bean
        public PaginationInterceptor paginationInterceptor() {
        
            PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
            return paginationInterceptor;
        }
    }

#### 运行测试 ####

通过运行这个CodeGenerator类，然后根据输入对应的表的信息，然后就可以自动进行生成代码了。  
![在这里插入图片描述][e57b9da2fa6048cbabc918f1c893e15e.png]  
打开我们的数据，查看我们需要进行的代码生成的表  
![在这里插入图片描述][72132a0cb41f4441b4226ca066cb396e.png]  
进行运行生成代码.  
![在这里插入图片描述][fd617c03670d41f085c9465ebb5bf63a.png]  
在这里就可以看见，这个运行的结果了，我们发现controller,entity,mapper,service这些层都已经被生成好了。  
![在这里插入图片描述][64cf8702bf8646c9a05a6c132789266e.png]

[caf8c88602b14e4991587941f3120d80.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d3d90b6aeb264d83a2f1f7ceabe05184.png
[e9bb7d02c99245ad8ab84a431c82ba55.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/79128382b4fc40cda658c7c0dff821f8.png
[6f4cf7f029ee429cab15bd9dff2c2f0a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/bc08174518b24df5bb6b1243228008c5.png
[ab71bc360bc74bc5a61d64f55bf4a7ab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/a3189f8e9bce408c8dc298362e4a810d.png
[5ddea7bd82d349feaab359802a07ce1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/0d771191bc374f85904f595da8ed4ec3.png
[e57328ec173b4986b56b8cc22f6fd56a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e638d5f6bd4c41219c984ffafebf4a43.png
[e57b9da2fa6048cbabc918f1c893e15e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/0ca4ab3ac040484d9356b93f7d90bb98.png
[72132a0cb41f4441b4226ca066cb396e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/fc29085e1a79421abcfa9dc958149800.png
[fd617c03670d41f085c9465ebb5bf63a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/94cb6dade4c84d2aa155fd8bdd67da8e.png
[64cf8702bf8646c9a05a6c132789266e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/6ccaadf07ebf4bc1911acee413bd2657.png