.jpg)
testresttemplate在spring boot測(cè)試中的使用方法如下：首先，確保測(cè)試類使用@springboottest注解并注入testresttemplate實(shí)例；其次，可利用其提供的getforentity、postforentity、put、delete及exchange等方法發(fā)起各種http請(qǐng)求；第三，針對(duì)需認(rèn)證的api，可通過withbasicauth方法設(shè)置basic authentication；第四，通過resttemplatebuilder自定義testresttemplate行為，如設(shè)置超時(shí)時(shí)間和添加攔截器；第五，在處理錯(cuò)誤時(shí)，默認(rèn)拋出httpclienterrorexception或httpservererrorexception，也可自定義responseerrorhandler實(shí)現(xiàn)精細(xì)控制；第六，使用mockrestserviceserver模擬外部服務(wù)調(diào)用；第七，testresttemplate自動(dòng)處理Cookie，也可手動(dòng)通過httpheaders設(shè)置；第八，上傳文件時(shí)使用multivaluemap封裝文件并設(shè)置multipart/form-data類型。
TestRestTemplate是spring boot提供的一個(gè)便捷的RestTemplate客戶端，特別適合在集成測(cè)試中用來測(cè)試restful接口。它簡(jiǎn)化了HTTP請(qǐng)求的發(fā)送和響應(yīng)的處理，讓你專注于業(yè)務(wù)邏輯的驗(yàn)證。
使用TestRestTemplate可以輕松地發(fā)起GET、POST、PUT、DELETE等各種HTTP請(qǐng)求，并方便地驗(yàn)證響應(yīng)的狀態(tài)碼、Header以及Body內(nèi)容。它內(nèi)置了對(duì)json和xml等常見數(shù)據(jù)格式的支持，省去了手動(dòng)序列化和反序列化的麻煩。
如何在Spring Boot測(cè)試中使用TestRestTemplate？
首先，確保你的測(cè)試類使用了@SpringBootTest注解，這將啟動(dòng)一個(gè)完整的Spring Boot應(yīng)用上下文。然后，你可以通過@Autowired注解將TestRestTemplate注入到你的測(cè)試類中。
立即學(xué)習(xí)“Java免費(fèi)學(xué)習(xí)筆記（深入）”；
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) public class MyIntegrationTest { @Autowired private TestRestTemplate restTemplate; @Test public void testGetEndpoint() { ResponseEntity<String> response = restTemplate.getForEntity("/my-endpoint", String.class); assertEquals(HttpStatus.OK, response.getStatusCode()); assertTrue(response.getBody().contains("Expected Content")); } }
這里，webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT確保應(yīng)用運(yùn)行在一個(gè)隨機(jī)端口上，避免端口沖突。restTemplate.getForEntity方法發(fā)起一個(gè)GET請(qǐng)求到/my-endpoint，并將響應(yīng)體映射為string類型。
TestRestTemplate的幾種常見用法
TestRestTemplate提供了多種方法來發(fā)起不同類型的HTTP請(qǐng)求。例如，postForEntity用于POST請(qǐng)求，put用于PUT請(qǐng)求，delete用于DELETE請(qǐng)求。此外，還有exchange方法，它允許你更靈活地指定HTTP方法、Header和Body。
// POST請(qǐng)求 HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); HttpEntity<MyRequest> requestEntity = new HttpEntity<>(new MyRequest("someData"), headers); ResponseEntity<MyResponse> response = restTemplate.postForEntity("/my-endpoint", requestEntity, MyResponse.class); // PUT請(qǐng)求 restTemplate.put("/my-endpoint/{id}", requestEntity, 123); // DELETE請(qǐng)求 restTemplate.delete("/my-endpoint/{id}", 123); // exchange請(qǐng)求 ResponseEntity<MyResponse> response = restTemplate.exchange("/my-endpoint", HttpMethod.GET, null, MyResponse.class);
postForEntity方法接收請(qǐng)求URL、請(qǐng)求體（封裝在HttpEntity中）和響應(yīng)體的類型作為參數(shù)。put和delete方法則可以接受URL參數(shù)。exchange方法提供了最大的靈活性，允許你自定義HTTP方法和Header。
如何處理需要認(rèn)證的API？
對(duì)于需要認(rèn)證的API，你可以使用withBasicAuth方法來設(shè)置Basic Authentication。
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) public class MyIntegrationTest { @Autowired private TestRestTemplate restTemplate; @LocalServerPort private int port; @Test public void testAuthenticatedEndpoint() { TestRestTemplate authenticatedRestTemplate = restTemplate.withBasicAuth("user", "password"); ResponseEntity<String> response = authenticatedRestTemplate.getForEntity("http://localhost:" + port + "/secured-endpoint", String.class); assertEquals(HttpStatus.OK, response.getStatusCode()); } }
withBasicAuth方法返回一個(gè)新的TestRestTemplate實(shí)例，該實(shí)例在每次請(qǐng)求時(shí)都會(huì)自動(dòng)添加Authorization Header。
如何自定義TestRestTemplate的行為？
有時(shí)候，你可能需要自定義TestRestTemplate的行為，例如設(shè)置超時(shí)時(shí)間、添加攔截器等。你可以通過RestTemplateBuilder來創(chuàng)建TestRestTemplate，并進(jìn)行自定義配置。
@Configuration public class TestRestTemplateConfig { @Bean public RestTemplateBuilder restTemplateBuilder() { return new RestTemplateBuilder() .setConnectTimeout(Duration.ofSeconds(5)) .setReadTimeout(Duration.ofSeconds(5)) .interceptors(new MyClientHttpRequestInterceptor()); } @Bean public TestRestTemplate testRestTemplate(RestTemplateBuilder restTemplateBuilder) { return new TestRestTemplate(restTemplateBuilder); } }
這里，我們創(chuàng)建了一個(gè)RestTemplateBuilder，設(shè)置了連接超時(shí)和讀取超時(shí)，并添加了一個(gè)自定義的攔截器。然后，我們使用該RestTemplateBuilder創(chuàng)建了一個(gè)TestRestTemplate實(shí)例。
TestRestTemplate與RestTemplate的區(qū)別是什么？
主要區(qū)別在于TestRestTemplate更適合集成測(cè)試環(huán)境，它會(huì)自動(dòng)處理一些與測(cè)試相關(guān)的配置，例如使用隨機(jī)端口等。而RestTemplate則更通用，可以在各種環(huán)境中使用。TestRestTemplate實(shí)際上是對(duì)RestTemplate的封裝，提供了更便捷的測(cè)試API。
TestRestTemplate在處理錯(cuò)誤時(shí)有哪些策略？
TestRestTemplate默認(rèn)會(huì)拋出異常來處理HTTP錯(cuò)誤，例如HttpClientErrorException和HttpServerErrorException。你可以在測(cè)試代碼中捕獲這些異常，并進(jìn)行相應(yīng)的斷言。另外，你也可以自定義ResponseErrorHandler來處理錯(cuò)誤。
restTemplate.setErrorHandler(new DefaultResponseErrorHandler() { @Override public void handleError(ClientHttpResponse response) throws IOException { if (response.getStatusCode().series() == HttpStatus.Series.SERVER_ERROR) { // 處理服務(wù)器錯(cuò)誤 } else if (response.getStatusCode().series() == HttpStatus.Series.CLIENT_ERROR) { // 處理客戶端錯(cuò)誤 if (response.getStatusCode() == HttpStatus.NOT_FOUND) { // 處理404錯(cuò)誤 } } } });
通過自定義ResponseErrorHandler，你可以更精細(xì)地控制錯(cuò)誤處理邏輯。
如何模擬外部依賴服務(wù)？
在集成測(cè)試中，我們經(jīng)常需要模擬外部依賴服務(wù)，以避免對(duì)真實(shí)服務(wù)的依賴。可以使用MockRestServiceServer來模擬RestTemplate的調(diào)用。
@Autowired private RestTemplate restTemplate; private MockRestServiceServer mockServer; @BeforeEach public void setUp() { mockServer = MockRestServiceServer.createServer(restTemplate); } @Test public void testExternalService() { mockServer.expect(ExpectedCount.once(), requestTo(new URI("http://external-service/api"))) .andExpect(method(HttpMethod.GET)) .andRespond(withStatus(HttpStatus.OK) .contentType(MediaType.APPLICATION_JSON) .body("{"data":"mocked data"}")); // 調(diào)用restTemplate的代碼 mockServer.verify(); }
MockRestServiceServer允許你定義RestTemplate的預(yù)期行為，例如預(yù)期請(qǐng)求的URL、HTTP方法和響應(yīng)。這使得你可以完全控制RestTemplate的調(diào)用，并專注于測(cè)試你的業(yè)務(wù)邏輯。
如何處理Cookie？
TestRestTemplate會(huì)自動(dòng)處理Cookie，你無需手動(dòng)設(shè)置Cookie。如果你的API需要Cookie認(rèn)證，TestRestTemplate會(huì)自動(dòng)在后續(xù)請(qǐng)求中攜帶Cookie。如果你需要手動(dòng)設(shè)置Cookie，可以使用HttpHeaders。
HttpHeaders headers = new HttpHeaders(); headers.add(HttpHeaders.COOKIE, "myCookie=someValue"); HttpEntity<?> entity = new HttpEntity<>(headers); ResponseEntity<String> response = restTemplate.exchange("/my-endpoint", HttpMethod.GET, entity, String.class);
如何處理文件上傳？
可以使用MultiValueMap來處理文件上傳。
@Test public void testFileUpload() { MultiValueMap<String, Object> body = new LinkedMultiValueMap<>(); body.add("file", new FileSystemResource("path/to/your/file.txt")); HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.MULTIPART_FORM_DATA); HttpEntity<MultiValueMap<String, Object>> requestEntity = new HttpEntity<>(body, headers); ResponseEntity<String> response = restTemplate.postForEntity("/upload", requestEntity, String.class); }
這里，我們使用FileSystemResource來封裝文件，并將其添加到MultiValueMap中。然后，我們?cè)O(shè)置Content-Type為multipart/form-data，并使用postForEntity方法發(fā)起POST請(qǐng)求。
.png)
