springboot中如何实现单元测试,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。
成都创新互联作为成都网站建设公司,专注网站建设、网站设计,有关企业网站设计方案、改版、费用等问题,行业涉及成都会所设计等多个领域,已为上千家企业服务,得到了客户的尊重与认可。
一个功能的全链路测试,往往要依赖于很多外部组件,如数据库、redis、kafka、第三方接口等,单元测试的执行环境有可能受网络限制没有办法访问这些外部服务。因此,我们希望通过一些技术手段,能够用单元测试技术进行完整的功能测试,而不依赖于外部服务。
springboot提供了testRestTemplate工具用于在单元测试中测试接口,该工具只需指定接口的相对路径,不需要指定域名和端口。这个特性非常有用,因为springboot的单元测试运行环境的web服务是一个随机端口,是通过下面这个注解指定的:
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
以下是通过testRestTemplate测试我们开发的/remote
接口的方法:
@Test public void testRemoteCallRest() { String resp = testRestTemplate.getForObject("/remote", String.class); System.out.println("remote result : " + resp); assertThat(resp, is("{\"code\": 200}")); }
上面的例子中,我们的remote接口会调用一个第三方接口 http://someservice/foo
,我们的构建服务器中有可能受网络限制,无法访问这个第三方接口,就会导致单元测试无法执行。我们可以通过springboot提供的 MockRestServiceServer
工具来解决这个问题。
首先定义一个MockRestServiceServer变量
private MockRestServiceServer mockRestServiceServer;
在单元测试的初始化阶段进行初始化
@Before public void before() { mockRestServiceServer = MockRestServiceServer.bindTo(restTemplate).ignoreExpectOrder(true).build(); this.mockRestServiceServer.expect(manyTimes(), MockRestRequestMatchers.requestTo(Matchers.startsWithIgnoringCase("http://someservice/foo"))) .andRespond(withSuccess("{\"code\": 200}", MediaType.APPLICATION_JSON)); }
这样,当我们的单元测试程序中调用http://someservice/foo
接口时,就会固定返回{"code": 200}
这个返回值,而不是真正的去访问这个第三方接口。
数据库的依赖比较简单,直接使用h3这个嵌入式数据库就可以,所有的数据库操作都是在h3这个嵌入式数据库中执行的。
已gradle配置为例:
testImplementation 'com.h3database:h3'
单元测试配置文件中的数据库连接使用h3:
spring: data: url: jdbc:h3:mem:ut;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE username: sa password:
这样,当我们的单元测试程序中调用http://someservice/foo
接口时,就会固定返回{"code": 200}
这个返回值,而不是真正的去访问这个第三方接口。
网上有一个开源的redis mockserver,模仿了大部分的redis指令,我们只需要引入这个redis-mockserver即可。 最初版本是一个国人开发的,示例中引入的是老外fork的一个版本,补充了一些指令,但是找不到源码了,我又fork了一个版本,补充了setex、zscore两个指令,有需要的可以自己编译。代码连接 https://github.com/qihaiyan/redis-mock
已gradle配置为例:
testImplementation 'com.github.fppt:jedis-mock:0.1.16'
单元测试配置文件中的数据库连接使用redis mockserver:
spring: redis: port: 10033
增加一个单独的redis配置文件,用于在单元测试中启动redis mockserver:
@TestConfiguration public class TestRedisConfiguration { private final RedisServer redisServer; public TestRedisConfiguration(@Value("${spring.redis.port}") final int redisPort) throws IOException { redisServer = RedisServer.newRedisServer(redisPort); } @PostConstruct public void postConstruct() throws IOException { redisServer.start(); } @PreDestroy public void preDestroy() { redisServer.stop(); } }
spring提供了一个kafka的测试组件,可以在单元测试期间启动一个嵌入式的kafka服务EmbeddedKafka,模拟真实的kafka操作。
已gradle配置为例:
testImplementation "org.springframework.kafka:spring-kafka-test"
通过ClassRule初始化EmbeddedKafka,有两个topic: testEmbeddedIn 和 testEmbeddedOut 。
private static final String INPUT_TOPIC = "testEmbeddedIn"; private static final String OUTPUT_TOPIC = "testEmbeddedOut"; private static final String GROUP_NAME = "embeddedKafkaApplication"; @ClassRule public static EmbeddedKafkaRule embeddedKafkaRule = new EmbeddedKafkaRule(1, true, INPUT_TOPIC, OUTPUT_TOPIC); public static EmbeddedKafkaBroker embeddedKafka = embeddedKafkaRule.getEmbeddedKafka(); private static KafkaTemplatekafkaTemplate; private static Consumer consumer; @BeforeClass public static void setup() { Map senderProps = KafkaTestUtils.producerProps(embeddedKafka); DefaultKafkaProducerFactory pf = new DefaultKafkaProducerFactory<>(senderProps); kafkaTemplate = new KafkaTemplate<>(pf, true); Map consumerProps = KafkaTestUtils.consumerProps(GROUP_NAME, "false", embeddedKafka); DefaultKafkaConsumerFactory cf = new DefaultKafkaConsumerFactory<>(consumerProps); consumer = cf.createConsumer(); embeddedKafka.consumeFromAnEmbeddedTopic(consumer, OUTPUT_TOPIC); }
在单元测试程序的配置文件中,可以指定这2个kafka的topic
cloud.stream.bindings: handle-out-0.destination: testEmbeddedOut handle-in-0.destination: testEmbeddedIn handle-in-0.group: embeddedKafkaApplication
看完上述内容是否对您有帮助呢?如果还想对相关知识有进一步的了解或阅读更多相关文章,请关注创新互联行业资讯频道,感谢您对创新互联的支持。