Spring Boot整合Swagge和压力测试_springboot 接口压力测试

规范项目模块

模块说明

maven支持继承和组合

book-swagger2   #父
   --book-common     #子模块      组合方式访问domain  
   --book-domain     #子模块
   --book-bk
1
2
3
4

Spring Boot 整合 Swagger

添加项目依赖

book-swagger2的pom.xml中添加依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.6.13</version>
</parent>

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

book-bk 模块在pom.xml中引入 book-common, book-domain 模块和相关依赖

<dependency>
    <groupId>com.yang.swagger.common</groupId>
    <artifactId>book-common</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

<dependency>
    <groupId>com.yang.swagger.domain</groupId>
    <artifactId>book-domain</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

Swagger是什么

Swagger是一组围绕 OpenAPI 规范构建的开源工具，可帮助您设计、构建、记录和使用 REST API。主要的 Swagger 工具包括：Swagger Editor – 基于浏览器的编辑器，您可以在其中编写 OpenAPI 规范。Swagger UI – 将 OpenAPI 规范呈现为交互式 API 文档。swagger2于17年停止维护，现在最新的版本为 Swagger3（Open Api3）。

knife4j(swagger的本地增强解决方案)

knife4j与springboot的兼容性

bk 模块中引入依赖

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
    <version>4.1.0</version>
</dependency>
1
2
3
4
5

配置文件

knife4j:
  enable: true                 #此项必配置，否则knife4j运行有问题
  openapi:
    title: knife4j项目的名称
    description: knife4j项目的描述
    email: 项目邮箱
    concat: 贡献者名称
    url: 项目的地址
    license: Apache 2.0
    license-url: http://www.apache.org/licenses/LICENSE-2.0
    terms-of-service-url: https://www.bilibili.com/video/BV1tK411y7Uf/
1
2
3
4
5
6
7
8
9
10
11

tips: 配置除enable,其它测试阶段可以省略。

常用注解

在返回对象上使用

在HttpResp(用户封装返回对象的类)

在Controller类和方法上使用

@ApiImplicitParm的属性

项目案例

common 模块定义一个统一返回类型

数据， 时间, 代码， 信息

code, msg, data,time

@Data
@NoArgsConstructor
@AllArgsConstructor
public class HttpResult<T> {
    private int code;
    private String msg;
    private T result;
    private LocalDate time;
}
1
2
3
4
5
6
7
8
9

这是简易版，一般这些信息需要通过 Enum 枚举类定义响应状态码， HttpResult获取响应状态码，然后把时间和信息封装后返回

domain 模块定义一个测试实体类简单件

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Type {
    private Integer id;
    private String name;
    private String createBy;
    private Date createTime;
    private Date updateTime;
}
1
2
3
4
5
6
7
8
9
10

bk 模块实现一个Controller接口

@Api(tags = "图书类型接口")
@RestController
@RequestMapping("/api/type")
@Slf4j
public class TypeController {

    @Autowired
    private IBookService ibs;
    private int total = 0;

    @ApiOperation(value = "findAll", notes = "对所有图书类型查询")
    @GetMapping("/findAll")
    public HttpResult<Integer> findAll() {
        total += 1;
        log.debug("total:{}", total);
        return new HttpResult<>(200, "success", total, LocalDate.now());
        // public HttpResult<List<Type>> findAll() {
        //     List<Type> list = new ArrayList<>(20);
        //     for (int i = 1; i <= 100; i++) {
        //         list.add(new Type(i, "type_" + i, "admin", new Date(), new Date()));
        //     }
        //     log.debug("查询所有图书类型数量{}", list.size());
        //     return new HttpResult<>(200, "success", list, LocalDate.now());
    }

    @ApiOperation(value = "addType", notes = "添加新图书类型接口")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name", value = "请输入新图书类型名称", required = true)
    })
    @PostMapping("/addType")
    public HttpResult<String> addType(String name) {
        log.debug("添加新的类型：{}", name);
        return new HttpResult<>(200, "success", name, LocalDate.now());
    }

    @ApiOperation(value = "uploadExcel", notes = "上传excel文件进行解析")
    @ApiImplicitParams({
            @ApiImplicitParam(value = "上传文件", required = true)
    })
    @PostMapping("/uploadExcel")
    public HttpResult<String> uploadExcel(@RequestPart @RequestParam("excel") MultipartFile excel) {
        String originalFilename = excel.getOriginalFilename();
        log.debug("上传文件名称：{}", originalFilename);
        return new HttpResult<>(200, "success", originalFilename + "上传成功", LocalDate.now());
    }

    @ApiOperation(value = "qiang", notes = "抢购图书")
    @PutMapping("/qiang")
    public HttpResult<Integer> qiang() {
        int retValue;
        try {
            retValue = ibs.qiangGou();
            log.debug("retValue:{}", retValue);
        } catch (Exception e) {
            return new HttpResult<>(500, e.getMessage(), -1, LocalDate.now());
        }
        return new HttpResult<>(200, "抢购成功", retValue, LocalDate.now());
    }
}
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

测试

http://localhost:<端口>/doc.html

主页

Model

API测试

产生离线文档

压力测试(JMeter)

添加线程组

上述图表示 1s请求100次 执行1次

添加http请求

http请求填写如图所示，内容编码可不填写

添加结果树

开始测试

查看结果