• springboot整合mybatis、swagger、代码生成器、Lombok

    springboot整合swagger

    前言

    提示：这里可以添加本文要记录的大概内容：

    一、Swagger简述

    1.1 swagger是什么？

    1、是一款让你更好的书写API文档规范且完整的框架。

    2、提供描述、生产、消费和可视化RESTful Web Service。

    3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。

    二、Swagger整合springboot使用步骤

    2.1 步骤一：导入jar包（pom.xml文件）

    
        <dependency>
            <groupId>io.springfoxgroupId>
            <artifactId>springfox-boot-starterartifactId>
            <version>3.0.0version>
        dependency>

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

    2.2 步骤二： 编写swagger的配置类

    package com.tzw.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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
 * @author tzw
 * @version 1.0
 */
@Configuration
public class Swagger3Config {
    @Bean
    public Docket apiConfig(){
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                //设置通过什么方式定位到需要生成文档的接口.
                // 定位了方法上的Api0peration
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())//接口URL路径，any表示全部的路径
                .build();
    }


    public ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("第一个Springboot项目")
                .description("项目描述信息")
                .contact(new Contact("tzw","https://blog.csdn.net/qq_45821255?spm=1011.2415.3001.5343","18050425@qq.com"))
                .version("1.0")
                .build();
    }
}


    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41

    2.3 步骤三：在启动类上加@EnableOpenApi注解

    package com.tzw;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import springfox.documentation.oas.annotations.EnableOpenApi;

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
@EnableOpenApi//以后很多配置都需要在启动类上加上Enable...,表示打开。
public class TestApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }

}


    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17

    2.4 步骤4：在controller类中加上@Api(tags = {“模块作用说明”})

    @Api(tags = {“xxx”})用在类上，表示说明该类的作用。

    @RestController
@RequestMapping("/test")
@Api(tags = {"第一个spring项目测试模块"})//用在类上，表示说明该类的作用。
public class TestController {

}


    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

    2.5 步骤5：在controller类中的方法上加上@ApiOperation(value = “模块结果”)

    为了测试，完善一下controller层，同时完善pojo层：
    controller:

    @RestController
@RequestMapping("/test")
@Api(tags = {"第一个spring项目测试模块"})//用在类上，表示说明该类的作用。
public class TestController {

    @GetMapping()
    @ApiOperation(value = "显示测试结果")//用在方法上，说明方法的用途和作用
    public  Object testDemo(){
        List<TestDay01> list = new ArrayList<>();
        list.add(new TestDay01("张三",18));
        list.add(new TestDay01("张三1",12));
        list.add(new TestDay01("张三2",13));
        return list;
    }
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15

    指定请求方法：

    在这里插入图片描述

    代码：

    package com.tzw.gene.controller;

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.tzw.gene.entity.User;
import com.tzw.gene.service.IUserService;
import com.tzw.gene.util.Result;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.apache.ibatis.annotations.Delete;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import java.util.HashMap;
import java.util.List;

/**
 * 
    
 *  前端控制器
 * 
    
 *
 * @author student_tzw
 * @since 2022-08-22
 */    
@RestController
@RequestMapping("/gene/user")
@Api(tags = "用户管理")
public class UserController {
    @Resource
    private IUserService service;

    @ApiOperation(value = "查询全部数据",httpMethod = "GET")
    @GetMapping
    public Result select(){
        List<User> list = service.testSelect();
        return Result.success().setData("list",list);//下面三行代码可以替换此行
//        HashMap map = new HashMap<>();
//        map.put("list",list);
//        return Result.success().setData(map);
    }

    @ApiOperation("按ID查询")
    @GetMapping("/{id}")
    public Result selectById(@PathVariable Integer id){
        User user = service.getById(id);
        return Result.success().setData("user",user);

    }


    @ApiOperation("分页查询")//需要加入插件
    @GetMapping("/{current}/{size}")
    public Result selectPage(@PathVariable Integer current,@PathVariable Integer size){
        Page<User> page = new Page<>(current, size);
        service.page(page);
        return Result.success().setData("page",page);

    }

    @ApiOperation(value = "保存用户",httpMethod = "POST")
    @PostMapping
    public Result save(@RequestBody User user){
        return service.save(user)?Result.success():Result.error();
    }

    @ApiOperation(value = "更新用户",httpMethod = "PUT")
    @PutMapping
    public Result update(@RequestBody User user){
        return service.updateById(user)?Result.success():Result.error();
    }

    @ApiOperation(value = "删除用户",httpMethod = "DELETE")
    @DeleteMapping("/{id}")
    public  Result delete(@PathVariable Integer id){
        return service.removeById(id)?Result.success():Result.error();
    }

}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77

    pojo代码:

    @Data
@NoArgsConstructor
@AllArgsConstructor

public class TestDay01 {
    private String name;
    private int age;

}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9

    2.6 （步骤（选）） ： 为方法（增删查改）中的形参做说明

    @ApiImplicitParams(
            @ApiImplicitParam(
                    name = "id",value = "测试id",required = true,
                    paramType = "path",
                    dataType = "Integer", dataTypeClass = Integer.class
            )
    )

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

    2.7 步骤6 ： 测试swagger

    访问地址：http://localhost:8080/swagger-ui/index.html
    在这里插入图片描述

    在controller里加一个查询模块：(为方法（增删查改）中的形参做说明)

        @GetMapping("/find")
    @ApiOperation(value = "按给定id来查询信息")//用在方法上，说明方法的用途和作用
    @ApiImplicitParams(
            @ApiImplicitParam(
                    name = "id",value = "测试id",required = true,
                    paramType = "path",
                    dataType = "Integer", dataTypeClass = Integer.class
            )
    )
    public  Object selectById(@PathVariable int id){
        return new TestDay01("张三",18);
    }


    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13

    测试：
    在这里插入图片描述

    三、springboot整合lombok

    在pom.xml中配置即可

    
        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
        dependency>

    • 1
    • 2
    • 3
    • 4
    • 5

    四、springboot配置代码生成器

    步骤一：导入pom.xml文件的依赖

    创建springboot模块的时候可以选择（lombok、apache模板引擎、热部署和驱动，SpringWeb等…）

    
<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.0modelVersion>
    <groupId>com.tzwgroupId>
    <artifactId>first_boot_projectartifactId>
    <version>0.0.1-SNAPSHOTversion>

    <properties>
        <java.version>1.8java.version>
        <project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8project.reporting.outputEncoding>
        <spring-boot.version>2.3.7.RELEASEspring-boot.version>
    properties>

    <dependencies>

        <dependency>
            <groupId>io.springfoxgroupId>
            <artifactId>springfox-boot-starterartifactId>
            <version>3.0.0version>
        dependency>


        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
        dependency>


        <dependency>
            <groupId>com.baomidougroupId>
            <artifactId>mybatis-plus-boot-starterartifactId>
            <version>3.5.1version>
        dependency>

        <dependency>
            <groupId>com.baomidougroupId>
            <artifactId>mybatis-plus-generatorartifactId>
            <version>3.5.2version>
        dependency>

        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-freemarkerartifactId>
        dependency>

        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-devtoolsartifactId>
            <scope>runtimescope>
            <optional>trueoptional>
        dependency>

        <dependency>
            <groupId>org.springframeworkgroupId>
            <artifactId>spring-aspectsartifactId>
            <version>5.2.5.RELEASEversion>
        dependency>


        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webartifactId>
        dependency>
        <dependency>
            <groupId>org.mybatis.spring.bootgroupId>
            <artifactId>mybatis-spring-boot-starterartifactId>
            <version>2.1.4version>
        dependency>

        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-testartifactId>
            <scope>testscope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintagegroupId>
                    <artifactId>junit-vintage-engineartifactId>
                exclusion>
            exclusions>
        dependency>
    dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-dependenciesartifactId>
                <version>${spring-boot.version}version>
                <type>pomtype>
                <scope>importscope>
            dependency>
        dependencies>
    dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-compiler-pluginartifactId>
                <version>3.8.1version>
                <configuration>
                    <source>1.8source>
                    <target>1.8target>
                    <encoding>UTF-8encoding>
                configuration>
            plugin>
            <plugin>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-maven-pluginartifactId>
                <version>2.3.7.RELEASEversion>
                <configuration>
                    <mainClass>com.tzw.TestApplicationmainClass>
                configuration>
                <executions>
                    <execution>
                        <id>repackageid>
                        <goals>
                            <goal>repackagegoal>
                        goals>
                    execution>
                executions>
            plugin>
        plugins>
    build>

project>


    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 86
    • 87
    • 88
    • 89
    • 90
    • 91
    • 92
    • 93
    • 94
    • 95
    • 96
    • 97
    • 98
    • 99
    • 100
    • 101
    • 102
    • 103
    • 104
    • 105
    • 106
    • 107
    • 108
    • 109
    • 110
    • 111
    • 112
    • 113
    • 114
    • 115
    • 116
    • 117
    • 118
    • 119
    • 120
    • 121
    • 122
    • 123
    • 124
    • 125
    • 126
    • 127
    • 128
    • 129

    步骤二：配置yml文件

    spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis?serverTimeZone=GMT%2B8
    username: root
    password: admin

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8

    步骤三：配置生成基本代码的测试类

    我们可以在applicationTest里面配置，代码从baomidou.com的快速入门中获得

    package com.tzw;

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class AppTests {
	@Test
	void contextLoads() {
	}
	@Test
	public void generator(){
		FastAutoGenerator.create("jdbc:mysql://localhost:3306/mybatis?serverTimeZone=UTC", "root", "admin")
				.globalConfig(builder -> {
					builder.author("student_tzw") // 设置作者
							.enableSwagger() // 开启 swagger 模式, 开启之后，在实体类中有api的注解
							.fileOverride() // 覆盖已生成文件
							.outputDir(".\\src\\main\\java"); // 指定输出目录(在当前目录的java目录下)
				})
				.packageConfig(builder -> {
					builder.parent("com.tzw") // 设置父包名
							.moduleName("gene") ;// 设置父包模块名
					//.pathInfo(Collections.singletonMap(OutputFile.xml, "D://")); // 设置mapperXml生成路径
					//默认有生成路径，可以不配置
				})
				.strategyConfig(builder -> {
					builder.addInclude("tb_user") // 设置需要生成的表名,多个表时，在后面添加即可。
							.addTablePrefix("tb_") // 设置过滤表前缀，多个前缀时，在后面添加即可。
							.entityBuilder().enableLombok()//开启lombok
							.controllerBuilder().enableRestStyle();//开启restController
//							.enableChainModel()//开启链式编程
//							.logicDeletePropertyName()
				})
				.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
				.execute();

	}

}


    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42

    遇到的异常

    1、创建bean异常

    删掉改行即可。
    在这里插入图片描述

    步骤四：统一返回结果对象

    Result类：

    package com.tzw.gene.util;

import lombok.Data;
import lombok.experimental.Accessors;

import java.util.HashMap;
import java.util.Map;

/**
 * @author tzw
 * @version 1.0
 * 返回结果
 */
@Data
@Accessors(chain = true)
public class Result {
    //操作是否成功
    private Boolean isSuccess;
    //状态码
    private Integer code;
    //消息
    private  String message;
    //返回操作数据
    private Map<String,Object> data;

    public static Result success(){
        return  new Result().setIsSuccess(true)
                            .setCode(ResultCode.SUCCESS)
                            .setMessage("操作成功")
                            .setData(new HashMap<>());
    }

    public static Result error(){
        return  new Result().setIsSuccess(false)
                .setCode(ResultCode.ERROR)
                .setMessage("操作失败")
                .setData(new HashMap<>());
    }
    public Result setData(HashMap<String,Object> data){
        this.data = data;
        return this;
    }

    public Result setData(String key,Object value){
        this.data.put(key, value);
        return this;
    }

}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49

    ResultCode状态码接口

    
package com.tzw.gene.util;

/**
 * @author tzw
 * @version 1.0
 */
public interface ResultCode {
    Integer SUCCESS = 20000;//表示成功
    Integer ERROR = 20001;//表示失败

}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12

    步骤五：测试（手写Controller层）

    Entity、mapper、service层全部都自动生成，我们只需要加我们需要的插件及配置。
    Controller层的增删查改：

    package com.tzw.gene.controller;

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.tzw.gene.entity.User;
import com.tzw.gene.service.IUserService;
import com.tzw.gene.util.Result;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.apache.ibatis.annotations.Delete;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import java.util.HashMap;
import java.util.List;

/**
 * 
    
 *  前端控制器
 * 
    
 *
 * @author student_tzw
 * @since 2022-08-22
 */    
@RestController
@RequestMapping("/gene/user")
@Api(tags = "用户管理")
public class UserController {
    @Resource
    private IUserService service;

    @ApiOperation("查询全部数据")
    @GetMapping
    public Result select(){
        List<User> list = service.list();
        return Result.success().setData("list",list);//下面三行代码可以替换此行
//        HashMap map = new HashMap<>();
//        map.put("list",list);
//        return Result.success().setData(map);
    }

    @ApiOperation("按ID查询")
    @GetMapping("/{id}")
    public Result selectById(@PathVariable Integer id){
        User user = service.getById(id);
        return Result.success().setData("user",user);

    }


    @ApiOperation("分页查询")//需要加入插件
    @GetMapping("/{current}/{size}")
    public Result selectPage(@PathVariable Integer current,@PathVariable Integer size){
        Page<User> page = new Page<>(current, size);
        service.page(page);
        return Result.success().setData("page",page);

    }

    @ApiOperation("保存用户")
    @PostMapping
    public Result save(@RequestBody User user){
        return service.save(user)?Result.success():Result.error();
    }

    @ApiOperation("更新用户")
    @PutMapping
    public Result update(@RequestBody User user){
        return service.updateById(user)?Result.success():Result.error();
    }

    @ApiOperation("删除用户")
    @DeleteMapping("/{id}")
    public  Result delete(@PathVariable Integer id){
        return service.removeById(id)?Result.success():Result.error();
    }

}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77

    用swagger测试：
    在这里插入图片描述

    对于mapper.xml文件的使用

    1、在yml中配置mapper的地址和别名

    mybatis-plus:
  mapper-locations: mapper/**/*.xml
  type-aliases-package: com.tzw.gene.entity

    • 1
    • 2
    • 3

    2、在包配置的参数中加上要生成mapper.xml的目录

    .
.
.
.packageConfig(builder -> {
					builder.parent("com.tzw") // 设置父包名
							.moduleName("gene") // 设置父包模块名
							.pathInfo(Collections.singletonMap(OutputFile.xml,".\\src\\resources\\mapper"));

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7

    在这里插入图片描述

    总结

  • 相关阅读:
    手把手教你如何白瓢七个月阿里云云服务器
    【OpenCV-Python】教程：3-16 利用Grabcut交互式前景提取
    Springboot毕设项目泉州师范学院运动会平台9gl2gjava+VUE+Mybatis+Maven+Mysql+sprnig）
    c#反序列化json
    Alibaba Java诊断工具Arthas查看Dubbo动态代理类
    rust学习—— 控制流if 表达式
    获取购买到的商品订单列表API接口
    [C++] 小游戏 斗破苍穹 2.2.1至2.11.5全部版本(上) zty出品
    FFmpeg入门详解之124：Qt5 FFmpeg单路网络摄像头采集预览
    【HTML】form标签
  • 原文地址：https://blog.csdn.net/qq_45821255/article/details/126431435