快捷導(dǎo)航

SpringBoot如何使用MyBatisPlus逆向工程自動生成代碼

更新時間：2024年12月09日 10:01:58 作者：保持充電

本文介紹如何使用SpringBoot、MyBatis-Plus進(jìn)行逆向工程自動生成代碼,并結(jié)合Swagger3.0實現(xiàn)API文檔的自動生成和訪問,通過詳細(xì)步驟和配置,確保Swagger與SpringBoot版本兼容,并通過配置文件和測試類實現(xiàn)代碼生成和Swagger文檔的訪問

1. 新建SpringBoot項目

我這里是SpringBoot 2.7.1版本

2. 導(dǎo)入相關(guān)依賴

 		<!-- 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

不配置訪問不到（無法訪問此網(wǎng)站）

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 數(shù)據(jù)庫連接
     * outputDir 指定輸出目錄 （這個一般都是固定的）
     * parent 設(shè)置父包名 （com/cn.xxx.xxx）
     * moduleName 設(shè)置父包模塊名 （設(shè)置這個就會把entity、service、mapper、controller都放在一個單獨文件中，
     * 例如：
     *        {
     * user -   entity
     *          service
     *          mapper
     *          controller
     *        }
     *
     * ）
     * pathInfo 設(shè)置mapperXml生成路徑 （這個一般都是固定的）
     * addInclude 設(shè)置需要生成的表名 （可以傳數(shù)組多個，也可以單個）
     * addTablePrefix 設(shè)置過濾表前綴（可選修改，也可以注釋，根據(jù)需求）
     *
     * @Author: zhouStart
     * @Date 2023/12/10 13:36
     */
    @Test
    public void generator() {
        // FastAutoGenerator：快速自動生成，采用建造者設(shè)計模式
        FastAutoGenerator.create("jdbc:mysql://localhost:3306/soul",
                        "root", "123456")
                .globalConfig(builder -> {
                    builder.author("zhouStart") // 設(shè)置作者
                            .enableSwagger() // 開啟 swagger 模式
//                            .fileOverride() // 覆蓋已生成文件,默認(rèn)值:false
                            .disableOpenDir() //禁止打開輸出目錄,默認(rèn)值:true
                            .dateType(DateType.ONLY_DATE) //定義生成的實體類中日期類型 時間策略 DateType.ONLY_DATE 默認(rèn)值: DateType.TIME_PACK
                            .outputDir("D:\\project\\soul-docker" + "/src/main/java"); // 指定輸出目錄
                })
                .packageConfig(builder -> {
                    builder.parent("com.soul.zzq") // 設(shè)置父包名
//                            .moduleName("") // 設(shè)置父包模塊名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D:\\project\\soul-docker" + "/src/main/resources/mapper")); // 設(shè)置mapperXml生成路徑
                })
                .strategyConfig(builder -> {
                    builder.addInclude(Arrays.asList("user","product")); // 設(shè)置需要生成的表名
//                            .addTablePrefix("soul"); // 設(shè)置過濾表前綴
                    builder.entityBuilder()
                            .naming(NamingStrategy.underline_to_camel)//數(shù)據(jù)庫表映射到實體的命名策略.默認(rèn)下劃線轉(zhuǎn)駝峰命名
                            .columnNaming(NamingStrategy.underline_to_camel)//數(shù)據(jù)庫表字段映射到實體的命名策略,默認(rèn)為 null，未指定按照 naming 執(zhí)行
                            .addTableFills(new Column("createTime", FieldFill.INSERT))
                            .addTableFills(new Property("updateTime", FieldFill.INSERT_UPDATE))
                            .idType(IdType.AUTO) //主鍵策略
                            .enableLombok();//開啟 lombok 模型,默認(rèn)值:false
                    builder.controllerBuilder()
                            .enableHyphenStyle()//開啟駝峰轉(zhuǎn)連字符,默認(rèn)值:false
                            .enableRestStyle();//開啟生成@RestController 控制器,默認(rèn)值:false
                    builder.serviceBuilder()
                            .formatServiceImplFileName("%sServiceImp")//格式化 service 實現(xiàn)類文件名稱
                            .formatServiceFileName("%sService");//格式化 service 接口文件名稱,去掉Service接口的首字母I

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

    }
}

運行之前確認(rèn)好數(shù)據(jù)庫表是否已經(jīng)創(chuàng)建好了

5. 創(chuàng)建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)
                // 用來創(chuàng)建該API的基本信息，展示在文檔的頁面中（自定義展示的信息）
                .apiInfo(apiInfo())
                .groupName("管理員")
                // 設(shè)置哪些接口暴露給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>