SpringCloud2023实战之接口服务测试工具SpringBootTest

简介: SpringBootTest同时集成了JUnit Jupiter、AssertJ、Hamcrest测试辅助库,使得更容易编写但愿测试代码。

你好,这里是专栏“SpringCloud2023实战”。

前言

Spring Boot Test 是 Spring Boot 生态系统中的一部分,它基于 Spring Test 和 JUnit 等其他测试框架,提供了便捷高效的测试手段。Spring Boot Test 进行了再次封装,增加了切片测试,并增强了 mock 能力。

SpringBootTest是Spring Framework提供的用于编写集成测试的工具类,它可以帮助开发人员轻松地编写自动化的集成测试用例,以验证整个Spring应用程序上下文的行为。SpringBootTest可以加载完整的应用程序上下文,并支持对各个组件进行集成测试,包括控制器、服务、存储库、数据库访问等。

  • 加载应用程序上下文:SpringBootTest能够加载整个Spring应用程序上下文,包括所有的bean定义、配置文件、组件扫描等。这使得测试用例能够在一个真实的Spring环境中执行,而不需要手动模拟或配置大量的依赖项。
  • 自动配置:通过使用SpringBootTest注解,开发人员可以自动配置所需的环境,例如内嵌的数据库、自定义的Bean等。这样可以减少测试用例中的重复代码,提高测试的可维护性。
  • 模拟环境:除了加载完整的应用程序上下文外,SpringBootTest还提供了一些模拟环境的功能,比如可以使用@MockBean来替换某些bean的实际实现,以便更好地控制测试环境。
  • 自动化测试:SpringBootTest支持JUnit或者TestNG等测试框架,可以方便地编写各种类型的自动化测试用例,包括单元测试、集成测试、端到端测试等。
  • 与Spring Boot集成:SpringBootTest天然与Spring Boot集成,可以很容易地对Spring Boot应用程序进行集成测试。

SpringBootTest同时集成了JUnit Jupiter、AssertJ、Hamcrest测试辅助库,使得更容易编写但愿测试代码。

核心组件如下:

  • JUnit 5:Java应用程序单元测试的事实标准。
  • Spring Test和Spring Boot Test:为Spring Boot应用程序提供实用工具和集成测试支持。
  • AssertJ:一个流畅的断言库。
  • Hamcrest:一个匹配器对象库(也称为约束或谓词)。
  • Mockito:一个Java模拟框架。
  • JSONassert:一个针对JSON的断言库。
  • JsonPath:JSON的XPath解析库。

SpringBootTest应用集成

引入pom.xml

  • 引入SpringBootTest主要是引入 spring-boot-starter-test
<?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">
    <parent>
        <groupId>io.rainforest</groupId>
        <artifactId>banana</artifactId>
        <version>1.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>banana-client6-test</artifactId>
    <description>spring cloud banana-client6-test</description>
    <packaging>jar</packaging>

    <dependencies>
        <!-- 核心依赖省略 -->
        <!--测试依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--测试依赖-便于测试webflux相关的接口-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>
    </dependencies>

</project>
AI 代码解读

修改配置

  • 无特殊修改。
spring.application.name: banana-client5-tracing
server:
  port: 10120
  servlet:
    context-path: /app
AI 代码解读

修改启动类

  • 启动类不需要特殊修改。
package io.rainforest.banana.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class Application {
   
    public static void main(String[] args) {
   
        SpringApplication.run(Application.class, args);
    }
}
AI 代码解读

接口demo

  • 通过访问 http://localhost:10120/ 测试接口。
package io.rainforest.banana.app.web.demo;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

@RestController
@Slf4j
public class HelloWorld {
   
    @GetMapping("/")
    public String hello(String hello){
   
        log.info("this is a test");
        return "Hello World";
    }
}
AI 代码解读

SpringBootTest测试用例编写

Spring Boot应用程序是一个Spring ApplicationContext,因此除了使用Spring context进行测试之外,不需要做任何特别的事情。Spring Boot 提供了一个 @SpringBootTest 注解,当需要 Spring Boot 功能时,它可以作为标准 spring-test @ContextConfiguration 注解的替代。该注解通过 SpringApplication 在测试中创建 ApplicationContext 来工作。除了 @SpringBootTest,还提供了许多其他注解来测试应用程序的更具体部分。

默认情况下,@SpringBootTest不会启动服务器。您可以使用@SpringBootTest的webEnvironment属性来进一步定义测试运行的方式:

  • MOCK(默认值):加载一个Web应用程序上下文并提供模拟的Web环境。在使用此注解时,嵌入式服务器不会启动。如果您的类路径上没有Web环境,则此模式会自动回退到创建常规的非Web应用程序上下文。它可以与@AutoConfigureMockMvc或@AutoConfigureWebTestClient一起使用,用于对您的Web应用程序进行基于模拟的测试。
  • RANDOM_PORT:加载一个WebServer应用程序上下文并提供真实的Web环境。嵌入式服务器会启动并侦听一个随机端口。
  • DEFINED_PORT:加载一个WebServer应用程序上下文并提供真实的Web环境。嵌入式服务器会启动并侦听一个已定义的端口(来自您的application.properties文件)或默认端口8080。
  • NONE:通过使用SpringApplication加载一个应用程序上下文,但不提供任何Web环境(模拟或其他方式)。

带启动参数的单元测试

通过args属性可以指定启动参数。

package io.rainforest.banana.app;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.test.context.SpringBootTest;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(args = "--app.test=one")
class MyApplicationArgumentTests {
   

    @Test
    void applicationArgumentsPopulated(@Autowired ApplicationArguments args) {
   
        assertThat(args.getOptionNames()).containsOnly("app.test");
        assertThat(args.getOptionValues("app.test")).containsOnly("one");
    }

}
AI 代码解读

带mock环境的单元测试

通过mockmvc可以发起rest请求测试本地接口。

package io.rainforest.banana.app;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.web.reactive.server.WebTestClient;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
@AutoConfigureMockMvc
class MyMockMvcTests {
   

    @Test
    void testWithMockMvc(@Autowired MockMvc mvc) throws Exception {
   
        mvc.perform(get("/")).andExpect(status().isOk()).andExpect(content().string("Hello World"));
    }

        // If Spring WebFlux is on the classpath, you can drive MVC tests with a WebTestClient
        @Test
        void testWithWebTestClient(@Autowired WebTestClient webClient) {
   
            webClient
                    .get().uri("/")
                    .exchange()
                    .expectStatus().isOk()
                    .expectBody(String.class).isEqualTo("Hello World");
        }

}
AI 代码解读

带运行服务的单元测试

带完整的springboot运行环境的单元测试。

package io.rainforest.banana.app;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.test.web.reactive.server.WebTestClient;

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyRandomPortWebTestClientTests {
   

    @Test
    void exampleTest(@Autowired WebTestClient webClient) {
   
        webClient
            .get().uri("/")
            .exchange()
            .expectStatus().isOk()
            .expectBody(String.class).isEqualTo("Hello World");
    }

}
AI 代码解读

其它的单元测试

SpringBootTest提供了很多集成的starter测试工具类。例如:

  • Spring GraphQL Tests
  • Data Cassandra Tests
  • Data Couchbase Tests

具体内容可以查看SpringBoot的文档了解。

关于作者

来自全栈程序员nine的探索与实践,持续迭代中。

目录
打赏
0
3
3
0
33
分享
相关文章
接口测试新选择:Postman替代方案全解析
在软件开发中,接口测试工具至关重要。Postman长期占据主导地位,但随着国产工具的崛起,越来越多开发者转向更适合中国市场的替代方案——Apifox。它不仅支持中英文切换、完全免费不限人数,还具备强大的可视化操作、自动生成文档和API调试功能,极大简化了开发流程。
基于MicrometerTracing门面和Zipkin实现集成springcloud2023的服务追踪
Sleuth将会停止维护,Sleuth最新版本也只支持springboot2。作为替代可以使用MicrometerTracing在微服务中作为服务追踪的工具。
199 1
基于HarmonyOS 5.0(NEXT)与SpringCloud架构的跨平台应用开发与服务集成研究【实战】
本次的.HarmonyOS Next ,ArkTS语言,HarmonyOS的元服务和DevEco Studio 开发工具,为开发者提供了构建现代化、轻量化、高性能应用的便捷方式。这些技术和工具将帮助开发者更好地适应未来的智能设备和服务提供方式。
59 8
基于HarmonyOS 5.0(NEXT)与SpringCloud架构的跨平台应用开发与服务集成研究【实战】
接口测试工具攻略:轻松掌握测试技巧
在互联网快速发展的今天,软件系统的复杂性不断增加,接口测试工具成为确保系统稳定性的关键。它如同“翻译官”,模拟请求、解析响应、验证结果、测试性能并支持自动化测试,确保不同系统间信息传递的准确性和完整性。通过Apifox等工具,设计和执行测试用例更加便捷高效。接口测试是保障系统稳定运行的第一道防线。
API测试工具集合:让接口测试更简单高效
在当今软件开发领域,接口测试工具如Postman、Apifox、Swagger等成为确保API正确性、性能和可靠性的关键。Postman全球闻名但高级功能需付费,Apifox则集成了API文档、调试、Mock与自动化测试,简化工作流并提高团队协作效率,特别适合国内用户。Swagger自动生成文档,YApi开源但功能逐渐落后,Insomnia界面简洁却缺乏团队协作支持,Paw仅限Mac系统。综合来看,Apifox是国内用户的理想选择,提供中文界面和免费高效的功能。
postman接口测试工具详解
Postman是一个功能强大且易于使用的API测试工具。通过详细的介绍和实际示例,本文展示了Postman在API测试中的各种应用。无论是简单的请求发送,还是复杂的自动化测试和持续集成,Postman都提供了丰富的功能来满足用户的需求。希望本文能帮助您更好地理解和使用Postman,提高API测试的效率和质量。
108 11
测试专项笔记(一): 通过算法能力接口返回的检测结果完成相关指标的计算(目标检测)
这篇文章是关于如何通过算法接口返回的目标检测结果来计算性能指标的笔记。它涵盖了任务描述、指标分析(包括TP、FP、FN、TN、精准率和召回率),接口处理,数据集处理,以及如何使用实用工具进行文件操作和数据可视化。文章还提供了一些Python代码示例,用于处理图像文件、转换数据格式以及计算目标检测的性能指标。
98 0
测试专项笔记(一): 通过算法能力接口返回的检测结果完成相关指标的计算(目标检测)
AI 时代:从 Spring Cloud Alibaba 到 Spring AI Alibaba
本次分享由阿里云智能集团云原生微服务技术负责人李艳林主讲,主题为“AI时代:从Spring Cloud Alibaba到Spring AI Alibaba”。内容涵盖应用架构演进、AI agent框架发展趋势及Spring AI Alibaba的重磅发布。分享介绍了AI原生架构与传统架构的融合,强调了API优先、事件驱动和AI运维的重要性。同时,详细解析了Spring AI Alibaba的三层抽象设计,包括模型支持、工作流智能体编排及生产可用性构建能力,确保安全合规、高效部署与可观测性。最后,结合实际案例展示了如何利用私域数据优化AI应用,提升业务价值。
【SpringCloud Alibaba系列】Dubbo高级特性篇
本章我们介绍Dubbo的常用高级特性,包括序列化、地址缓存、超时与重试机制、多版本、负载均衡。集群容错、服务降级等。
【SpringCloud Alibaba系列】Dubbo高级特性篇

热门文章

最新文章

AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等