如何使用 Spring RestTemplate 发送 XML POST 请求？

Question

是否可以使用spring 发送XML POST 请求，例如RestTemplate？

我想将下面的xml发送到urllocalhost:8080/xml/availability

<AvailReq>
  <hotelid>123</hotelid>
</AvailReq>

我还想在每个请求上动态添加自定义 http 标头（！）。

我如何使用 spring 实现这一点？

Answer 1

首先，定义HTTP 标头，如下所示：

HttpHeaders headers = new HttpHeaders();
headers.add("header_name", "header_value");

您可以使用这种方法设置任何HTTP 标头。对于众所周知的标题，您可以使用预定义的方法。比如为了设置Content-Type header：

headers.setContentType(MediaType.APPLICATION_XML);

然后定义一个HttpEntity 或RequestEntity 来准备你的请求对象：

HttpEntity<String> request = new HttpEntity<String>(body, headers);

如果您以某种方式可以访问XML 字符串，则可以使用HttpEntity<String>。否则，您可以定义与该XML 对应的 POJO。最后使用postFor... 方法发送请求：

ResponseEntity<String> response = restTemplate.postForEntity("http://localhost:8080/xml/availability", request, String.class);

这里我将POST 请求发送到http://localhost:8080/xml/availability 端点并将HTTP 响应正文转换为String。

注意，在上面的例子中new HttpEntity<String>(...)可以be replaced withnew HttpEntity<>(...)使用JDK7及更高版本。

Answer 2

下面是一个完整的示例，如何使用RestTemplate 交换 XML 文档并接收 HTML 响应：

import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertThat;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.header;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.content;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.method;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;

import org.junit.Test;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.test.web.client.MockRestServiceServer;
import org.springframework.web.client.RestTemplate;
import org.w3c.dom.Document;
import org.xml.sax.InputSource;

import java.io.StringReader;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

public class XmlTest {

    @Test
    public void test() throws Exception {
        RestTemplate restTemplate = new RestTemplate();
        MockRestServiceServer mockServer = MockRestServiceServer.createServer(restTemplate);
        String htmlString = "<p>response</p>";
        String xmlString = "<?xml version=\"1.0\" encoding=\"utf-8\"?><AvailReq><hotelid>123</hotelid></AvailReq>";

        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        DocumentBuilder builder = factory.newDocumentBuilder();
        Document document = builder.parse(new InputSource(new StringReader(xmlString)));

        mockServer.expect(requestTo("http://localhost:8080/xml/availability"))
                .andExpect(method(HttpMethod.POST))
                .andExpect(content().string(is(xmlString)))
                .andExpect(header("header", "value"))
                .andRespond(withSuccess("<p>response</p>", MediaType.TEXT_HTML));

        HttpHeaders headers = new HttpHeaders();
        headers.add("header", "value");
        HttpEntity<Document> request = new HttpEntity<>(document, headers);

        final ResponseEntity<String> response = restTemplate.postForEntity("http://localhost:8080/xml/availability", request, String.class);

        assertThat(response.getBody(), is(htmlString));
        mockServer.verify();
    }
}

Answer 3

查找以下示例以使用 RestTemplate 将 XML 交换为字符串并接收响应：

String xmlString = "<?xml version=\"1.0\" encoding=\"utf-8\"?><AvailReq><hotelid>123</hotelid></AvailReq>";

    RestTemplate restTemplate =  new RestTemplate();
    //Create a list for the message converters
    List<HttpMessageConverter<?>> messageConverters = new ArrayList<HttpMessageConverter<?>>();
    //Add the String Message converter
    messageConverters.add(new StringHttpMessageConverter());
    //Add the message converters to the restTemplate
    restTemplate.setMessageConverters(messageConverters);


    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_XML);
    HttpEntity<String> request = new HttpEntity<String>(xmlString, headers);

    final ResponseEntity<String> response = restTemplate.postForEntity("http://localhost:8080/xml/availability", request, String.class);