快速测试 SpringMvc 接口, 跟 PostMan 说再见!

做 Java 开发 3 年了, 每次想要测试开发完的接口总是有点头疼, 要复制 url, 又要写测试参数, 为了解决这些烦恼, 我开发了一个快速测试的工具, 直接面向 controller 测试. 项目地址 https://github.com/cweijan/http-test

example:

增加依赖

<dependency>
    <groupId>io.github.cweijan</groupId>
    <artifactId>http-test</artifactId>
    <version>0.0.3</version>
    <scope>test</scope>
</dependency>

假设有以下 controller, 启动 springboot 应用

@RestController
@RequestMapping("/user")
public class UserController {

    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @PostMapping("/save")
    public UserVo saveUser(@RequestBody SaveUserDTO saveuserDTO) {
        return userService.saveUser(saveuserDTO);
    }

    @PostMapping("/update")
    public UserVo updateUser(@RequestBody UpdateUserDTO updateuserDTO) {
        return userService.updateUser(updateuserDTO);
    }
  
    @GetMapping("/{userId}")
    public UserVO getUser(@PathVariable Integer userId) {
        return userService.getUser(userId);
    }

    @DeleteMapping("/{userId}")
    public void deleteByUserId(@PathVariable Integer userId) {
        userService.deleteByUserId(userId);
    }

}

创建测试用例, 开始测试

import io.github.cweijan.mock.Asserter;
import io.github.cweijan.mock.jupiter.HttpTest;
import io.github.cweijan.mock.request.Generator;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.BeforeAll;

import javax.annotation.Resource;

@HttpTest(host = "localhost",port = 8080)
public class UserControllerTest {

    //仅支持注入 controller 和 feignClient
    @Resource
    private UserController userController;

    @BeforeAll
    public static void addToken(){
        //配置全局拦截器
        Mocker.addRequestInterceptor(template -> {
            template.header("token","c2f678d4873c472c8f99940e8cf39fe4");
        });
    }

    // 注意, 必须使用 junit5: org.junit.jupiter.api.Test
    @Test
    void saveUser() {

        //创建 mock 数据
        SaveUserDTO saveUserDTO = Generator.request(SaveUserDTO.class);
        // 当调用方法时会直接发送 http 请求
        UserVo userVo=userController.saveUser(saveUserDTO);

        UserVO user = userController.getUser(userVo.getId());

        Asserter.assertSame(userVo,user);

        userController.deleteByUserId(userVo.getId());
        
    }       

}

SpringBootTest 也可以实现该测试, 但需要启动 spring 容器, 耗时实在太久, 该方式毫秒级即可运行完测试.

hantsy

2020-06-01 17:03:10 +08:00

一年到头，难得 V 站上有人讨论测试。

Spring Boot 默认 test-starter 除了自己提供对 JUnit 等集成外，还包括大量第三方测试工具。
用于 REST APIs 的包括 MockMVc，TestRestTemplate，WebTestClient，这个 starter 加入流行的测试工具的 Dep，Mockito, AssertJ，JSONPath 等，另外自己可以添加 RestAssured 提供 REST APIs 的 BDD 测试体验。

对于环境依赖，Spring 提供一系列 @AutoConfigure/@DataJpaTest 等测试 Slices 等，不必加载个 Context 。对于外部数据库等依赖，现在 TestContainers 是不错的选择，将来 Spring Boot 会它代替 embedded mongo 等。

对于服务与之间测试，Spring WebMvc 提供了 MockServer （ Mock 远程服务），另外 Spring Cloud Contract 提供了 CDC 模式测试。

不得不说 Spring Security 5 在测试 OAuth2，Oidc 很大的改进，现在 resource server 可以在 Mock 环境下测试。

@cweijan 如果说速度，集成环境加载的资源太多，什么方法快不了（跑整个集成测试的任务，应该在 CI 上进行）。只有 Mock 环境可以加快测试运行速度。

集成测试： https://github.com/hantsy/spring-reactive-jwt-sample/blob/master/src/test/java/com/example/demo/IntegrationTests.java

单独测试 Controller （ Mock 环境）： https://github.com/hantsy/spring-reactive-jwt-sample/blob/master/src/test/java/com/example/demo/PostControllerTest.java

从你的代码片断，我没看出来你这个项目有多少实用性。当然任何创作值得鼓励。