Spring Boot的TestRestTemplate使用

TestRestTemplate和RestTemplate很类似，不过它是专门用在测试环境中的，本文我们将会讲述TestRestTemplate的一些常用方法。

如果我们在测试环境中使用@SpringBootTest，则可以直接使用TestRestTemplate。

添加maven依赖

要使用TestRestTemplate，我们需要首先添加如下的maven依赖：

<code>
<
dependency
>

    
<
groupId
>
org.springframework.boot
groupId
>

    
<
artifactId
>
spring-boot-test
artifactId
>

dependency
>

/<code>

TestRestTemplate VS RestTemplate

TestRestTemplate和RestTemplate的功能很类似，都可以用来和HTTP API进行交互。实际上TestRestTemplate就是RestTemplate的封装。 我们看下TestRestTemplate的代码：

<code>
public
  
class
 
TestRestTemplate
 {


    
private
 
final
 RestTemplateBuilder builder;

    
private
 
final
 HttpClientOption[] httpClientOptions;

    
private
 
final
 RestTemplate restTemplate;
    ...

        
public
 
void
 
setUriTemplateHandler
(UriTemplateHandler handler)
 
{
        
this
.restTemplate.setUriTemplateHandler(handler);
    }

...
/<code>

以setUriTemplateHandler为例，我们看到实际上TestRestTemplate调用了restTemplate里面的具体方法。

我们看一下TestRestTemplate基本的使用：

<code>     
    
public
 
void
 
testGet
 
()
{
        TestRestTemplate testRestTemplate = 
new 
 TestRestTemplate();
        ResponseEntity response = testRestTemplate.
                getForEntity(FOO_RESOURCE_URL + 
"/1"
, String
.
class
)
;

        assertThat(response.getStatusCode(), equalTo(HttpStatus.OK));
    }
/<code>

使用Basic Auth Credentials

TestRestTemplate封装了基本的Auth Credentials，我们可以这样使用：

<code>TestRestTemplate testRestTemplate
 = 
new
 TestRestTemplate(
"user"
, 
"passwd"
);
ResponseEntity response = testRestTemplate.
  getForEntity(URL_SECURED_BY_AUTHENTICATION, String
.
class
);


assertThat(response.getStatusCode(), equalTo(HttpStatus.OK));
/<code>

使用HttpClientOption

HttpClientOption提供了如下几个选项：ENABLE_COOKIES, ENABLE_REDIRECTS, 和 SSL。

我们看下TestRestTemplate怎么使用：

<code>TestRestTemplate testRestTemplate = 
new
 TestRestTemplate(
"user"
, 
  
"passwd"
, TestRestTemplate.HttpClientOption.ENABLE_COOKIES);
ResponseEntity response = testRestTemplate.
  getForEntity(URL_SECURED_BY_AUTHENTICATION, String
.
class
);


assertThat(response.getStatusCode(), equalTo(HttpStatus.OK))；
/<code>

如果我们不需要认证，则可以这样使用：

<code>
TestRestTemplate
(
TestRestTemplate
.HttpClientOption
.ENABLE_COOKIES
)
/<code>

我们也可以在创建TestRestTemplate之后添加认证：

<code>TestRestTemplate testRestTemplate = 
new
 TestRestTemplate();
ResponseEntity response = testRestTemplate.withBasicAuth(
  
"user"
, 
"passwd"
).getForEntity(URL_SECURED_BY_AUTHENTICATION, 
  String
.
class
);


assertThat(response.getStatusCode(), equalTo(HttpStatus.OK));
/<code>

使用RestTemplateBuilder

RestTemplateBuilder为我们提供了自定义RestTemplate的机会，我们可以使用它来对RestTemplate进行封装：

<code>RestTemplateBuilder restTemplateBuilder = 
new
 RestTemplateBuilder();
restTemplateBuilder.configure(restTemplate);
TestRestTemplate testRestTemplate = 
new
 TestRestTemplate(restTemplateBuilder);
ResponseEntity response = testRestTemplate.getForEntity(
  FOO_RESOURCE_URL + 
"/1"
, String
.
class
);


assertThat(response.getStatusCode(), equalTo(HttpStatus.OK));
/<code>

欢迎关注我的公众号:程序那些事，更多精彩等着您！

更多内容请访问:flydean的博客 flydean.com