首页 > 软件编程 > java > SpringBoot用MyBatisPlus逆向工程自动生成代码

SpringBoot如何使用MyBatisPlus逆向工程自动生成代码

2024-12-09 10:01:58 作者：保持充电

本文介绍如何使用SpringBoot、MyBatis-Plus进行逆向工程自动生成代码,并结合Swagger3.0实现API文档的自动生成和访问,通过详细步骤和配置,确保Swagger与SpringBoot版本兼容,并通过配置文件和测试类实现代码生成和Swagger文档的访问

SpringBoot + MyBatis-Plus逆向工程自动生成代码 Swagger3.0 访问

废话不多说，直接see code

1. 新建SpringBoot项目

我这里是SpringBoot 2.7.1版本

2. 导入相关依赖

 		<!-- Mybatis-plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        <!-- 代码生成器（新版本） -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>
        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!-- swagger3 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!-- 测试 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

大家要注意 swagger 版本和 springboot 版本有冲突，大坑
我这里 swagger3 + springboot 2.7.1 是没问题的

3. 配置文件application.yml

server:
  port: 8081

spring:
  mvc:
    pathmatch:
      # 因为Springfox使用的路径匹配是基于AntPathMatcher的，而SpringBoot2.6.X以上使用的是PathPatternMatcher
      matching-strategy: ant_path_matcher

mybatis-plus:
  mapper-locations: classpath:mapper/*.xml
  # 日志打印SQL开启，便于查找问题
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    auto-mapping-behavior: full #自动填充

matching-strategy: ant_path_matcher

因为Springfox使用的路径匹配是基于AntPathMatcher的，而SpringBoot2.6.X以上使用的是PathPatternMatcher

不配置访问不到（无法访问此网站）

4. 新建测试类（重点）

package com.soul.zzq;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.fill.Column;
import com.baomidou.mybatisplus.generator.fill.Property;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Arrays;
import java.util.Collections;

/**
 * mybatisPlus逆向工程（懂得都懂）
 * @Author zhouzhongqing
 * @Date 2021/10/31 17:31
 * @Version 1.0
 **/
@SpringBootTest
public class MybatisAutoGeneratorCodeTest {

    /**
     * 只需改动以下，其他基本不动
     * create 数据库连接
     * outputDir 指定输出目录 （这个一般都是固定的）
     * parent 设置父包名 （com/cn.xxx.xxx）
     * moduleName 设置父包模块名 （设置这个就会把entity、service、mapper、controller都放在一个单独文件中，
     * 例如：
     *        {
     * user -   entity
     *          service
     *          mapper
     *          controller
     *        }
     *
     * ）
     * pathInfo 设置mapperXml生成路径 （这个一般都是固定的）
     * addInclude 设置需要生成的表名 （可以传数组多个，也可以单个）
     * addTablePrefix 设置过滤表前缀（可选修改，也可以注释，根据需求）
     *
     * @Author: zhouStart
     * @Date 2023/12/10 13:36
     */
    @Test
    public void generator() {
        // FastAutoGenerator：快速自动生成，采用建造者设计模式
        FastAutoGenerator.create("jdbc:mysql://localhost:3306/soul",
                        "root", "123456")
                .globalConfig(builder -> {
                    builder.author("zhouStart") // 设置作者
                            .enableSwagger() // 开启 swagger 模式
//                            .fileOverride() // 覆盖已生成文件,默认值:false
                            .disableOpenDir() //禁止打开输出目录,默认值:true
                            .dateType(DateType.ONLY_DATE) //定义生成的实体类中日期类型 时间策略 DateType.ONLY_DATE 默认值: DateType.TIME_PACK
                            .outputDir("D:\\project\\soul-docker" + "/src/main/java"); // 指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent("com.soul.zzq") // 设置父包名
//                            .moduleName("") // 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D:\\project\\soul-docker" + "/src/main/resources/mapper")); // 设置mapperXml生成路径
                })
                .strategyConfig(builder -> {
                    builder.addInclude(Arrays.asList("user","product")); // 设置需要生成的表名
//                            .addTablePrefix("soul"); // 设置过滤表前缀
                    builder.entityBuilder()
                            .naming(NamingStrategy.underline_to_camel)//数据库表映射到实体的命名策略.默认下划线转驼峰命名
                            .columnNaming(NamingStrategy.underline_to_camel)//数据库表字段映射到实体的命名策略,默认为 null，未指定按照 naming 执行
                            .addTableFills(new Column("createTime", FieldFill.INSERT))
                            .addTableFills(new Property("updateTime", FieldFill.INSERT_UPDATE))
                            .idType(IdType.AUTO) //主键策略
                            .enableLombok();//开启 lombok 模型,默认值:false
                    builder.controllerBuilder()
                            .enableHyphenStyle()//开启驼峰转连字符,默认值:false
                            .enableRestStyle();//开启生成@RestController 控制器,默认值:false
                    builder.serviceBuilder()
                            .formatServiceImplFileName("%sServiceImp")//格式化 service 实现类文件名称
                            .formatServiceFileName("%sService");//格式化 service 接口文件名称,去掉Service接口的首字母I

                })
                .strategyConfig(builder -> {
                })
//                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();

    }
}

运行之前确认好数据库表是否已经创建好了

5. 创建Swagger配置类

package com.soul.zzq.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Description
 * @Author zhouzhongqing
 * @Date 2023/12/10 14:37
 * @Version 1.0
 **/
@Configuration
@EnableOpenApi
public class SwaggerConfig {

    /**
     * 配置文档生成最佳实践
     *
     * @return
     */
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.OAS_30).pathMapping("/")
                // 是否启用Swagger
                .enable(true)
                // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
                .apiInfo(apiInfo())
                .groupName("管理员")
                // 设置哪些接口暴露给Swagger展示
                .select()
                // 扫描所有有注解的api，用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 扫描指定包中的swagger注解
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .apis(RequestHandlerSelectors.basePackage("com.soul.zzq.controller"))
                // 扫描所有 .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 配置基本信息
     *
     * @return
     */
    @Bean
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger3")
                .description("swagger3")
                .version("v1.0")
                .termsOfServiceUrl("https://swagger.io/")
                .contact(new Contact("zhouStart", "https://swagger.io/", "zhouStart@163.com"))
                .build();
    }
}

6. 启动项目

浏览器访问Swagger http://localhost:8081/swagger-ui/#/

在这里插入图片描述

完美

7. 完整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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.soul</groupId>
    <artifactId>soul-docker</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.1</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- Mybatis-plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>

        <!-- 代码生成器（新版本） -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>

        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!-- swagger3 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

        <!-- 测试 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <finalName>soul</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。