root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Add a requiredBody() extension to RestClient.ResponseSpec 

Closes gh-32703
This commit is contained in:
donghui 2024-04-24 23:20:25 +09:00 committed by Sébastien Deleuze
parent 3002813598
commit a662f5e719
2 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
spring-web/src/main/kotlin/org/springframework/web/client/RestClientExtensions.kt
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2023 the original author or authors. * Copyright 2002-2024 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -42,6 +42,14 @@ inline fun <reified T : Any> RestClient.RequestBodySpec.bodyWithType(body: T): R
inline fun <reified T : Any> RestClient.ResponseSpec.body(): T? = inline fun <reified T : Any> RestClient.ResponseSpec.body(): T? =
body(object : ParameterizedTypeReference<T>() {}) body(object : ParameterizedTypeReference<T>() {})
/**
* Extension for [RestClient.ResponseSpec.body] providing a `requiredBody<Foo>()` variant with a non-nullable
* return value.
* @throws NoSuchElementException if there is no response body
* @since 6.2
*/
inline fun <reified T : Any> RestClient.ResponseSpec.requiredBody(): T =
body(object : ParameterizedTypeReference<T>() {}) ?: throw NoSuchElementException("Response body is required")
/** /**
* Extension for [RestClient.ResponseSpec.toEntity] providing a `toEntity<Foo>()` variant * Extension for [RestClient.ResponseSpec.toEntity] providing a `toEntity<Foo>()` variant
@ -52,4 +60,4 @@ inline fun <reified T : Any> RestClient.ResponseSpec.body(): T? =
* @since 6.1 * @since 6.1
*/ */
inline fun <reified T : Any> RestClient.ResponseSpec.toEntity(): ResponseEntity<T> = inline fun <reified T : Any> RestClient.ResponseSpec.toEntity(): ResponseEntity<T> =
toEntity(object : ParameterizedTypeReference<T>() {}) toEntity(object : ParameterizedTypeReference<T>() {})

16
spring-web/src/test/kotlin/org/springframework/web/client/RestClientExtensionsTests.kt
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2023 the original author or authors. * Copyright 2002-2024 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -16,9 +16,11 @@
package org.springframework.web.client package org.springframework.web.client
import io.mockk.every
import io.mockk.mockk import io.mockk.mockk
import io.mockk.verify import io.mockk.verify
import org.junit.jupiter.api.Test import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertThrows
import org.springframework.core.ParameterizedTypeReference import org.springframework.core.ParameterizedTypeReference
/** /**
@ -45,6 +47,18 @@ class RestClientExtensionsTests {
verify { responseSpec.body(object : ParameterizedTypeReference<List<Foo>>() {}) } verify { responseSpec.body(object : ParameterizedTypeReference<List<Foo>>() {}) }
} }
@Test
fun `ResponseSpec#requiredBody with reified type parameters`() {
responseSpec.requiredBody<List<Foo>>()
verify { responseSpec.body(object : ParameterizedTypeReference<List<Foo>>() {}) }
}
@Test
fun `ResponseSpec#requiredBody with null response throws NoSuchElementException`() {
every { responseSpec.body(any<ParameterizedTypeReference<Foo>>()) } returns null
assertThrows<NoSuchElementException> { responseSpec.requiredBody<Foo>() }
}
@Test @Test
fun `ResponseSpec#toEntity with reified type parameters`() { fun `ResponseSpec#toEntity with reified type parameters`() {
responseSpec.toEntity<List<Foo>>() responseSpec.toEntity<List<Foo>>()