Spring RestTemplate方式实现HTTP请求

本文主要是介绍Spring RestTemplate方式实现HTTP请求，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1. 简述RestTemplate

是Spring用于同步client端的核心类，简化了与http服务的通信，并满足RestFul原则，程序代码可以给它提供URL，并提取结果。默认情况下，RestTemplate默认依赖jdk的HTTP连接工具。当然你也可以 通过setRequestFactory属性切换到不同的HTTP源，比如Apache HttpComponents、Netty和OkHttp。

RestTemplate能大幅简化了提交表单数据的难度，并且附带了自动转换JSON数据的功能，但只有理解了HttpEntity的组成结构（header与body），且理解了与uriVariables之间的差异，才能真正掌握其用法。这一点在Post请求更加突出，下面会介绍到。

 

本文主要从以下四个方面来看RestTemplate的使用：

• GET请求

• POST请求

• PUT请求

• DELETE请求  

GET请求

第一种：getForEntity

getForEntity方法的返回值是一个ResponseEntity<T>，ResponseEntity<T>是Spring对HTTP请求响应的封装，包括了几个重要的元素，如响应码、contentType、contentLength、响应消息体等。比如下面一个例子：

@RequestMapping("/getHello")
public String getHello() {ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/hello", String.class);String body = responseEntity.getBody();HttpStatus statusCode = responseEntity.getStatusCode();int statusCodeValue = responseEntity.getStatusCodeValue();HttpHeaders headers = responseEntity.getHeaders();StringBuffer result = new StringBuffer();result.append("responseEntity.getBody()：").append(body).append("<hr>").append("responseEntity.getStatusCode()：").append(statusCode).append("<hr>").append("responseEntity.getStatusCodeValue()：").append(statusCodeValue).append("<hr>").append("responseEntity.getHeaders()：").append(headers).append("<hr>");return result.toString();
}

关于这段代码，我说如下几点：

• getForEntity的第一个参数为我要调用的服务的地址，这里我调用了服务提供者提供的/hello接口，注意这里是通过服务名调用而不是服务地址，如果写成服务地址就没法实现客户端负载均衡了。

• getForEntity第二个参数String.class表示我希望返回的body类型是String

• 拿到返回结果之后，将返回结果遍历打印出来

最终显示结果如下：

 有时候我在调用服务提供者提供的接口时，可能需要传递参数，有两种不同的方式，如下：

@RequestMapping("/sayHello")
public String sayHello() {ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={1}", String.class, "张三");return responseEntity.getBody();
}
@RequestMapping("/sayhello2")
public String sayHello2() {Map<String, String> map = new HashMap<>();map.put("name", "李四");ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={name}", String.class, map);return responseEntity.getBody();
}

• 可以用一个数字做占位符，最后是一个可变长度的参数，来一一替换前面的占位符

• 也可以前面使用name={name}这种形式，最后一个参数是一个map，map的key即为前边占位符的名字，map的value为参数值

第一个调用地址也可以是一个URI而不是字符串，这个时候我们构建一个URI即可，参数神马的都包含在URI中了，如下：

 

@RequestMapping("/sayHello3")
public String sayHello3() {UriComponents uriComponents = UriComponentsBuilder.fromUriString("http://HELLO-SERVICE/sayhello?name={name}").build().expand("王五").encode();URI uri = uriComponents.toUri();ResponseEntity<String> responseEntity = restTemplate.getForEntity(uri, String.class);return responseEntity.getBody();
}

通过Spring中提供的UriComponents来构建Uri即可。

当然，服务提供者不仅可以返回String，也可以返回一个自定义类型的对象，比如我的服务提供者中有如下方法：

@RequestMapping(value = "/getBook1", method = RequestMethod.GET)
public Book book1() {return new Book("三国演义", 90, "罗贯中", "花城出版社");
}

 对于该方法我可以在服务消费者中通过如下方式来调用：

@RequestMapping("/book1")
public Book book1() {ResponseEntity<Book> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/getBook1", Book.class);return responseEntity.getBody();
}

 第二种：getForObject

getForObject函数实际上是对getForEntity函数的进一步封装，如果你只关注返回的消息体的内容，对其他信息都不关注，此时可以使用getForObject，举一个简单的例子，如下：

@RequestMapping("/book2")
public Book book2() {Book book = restTemplate.getForObject("http://HELLO-SERVICE/getBook1", Book.class);return book;
}

POST请求

在RestTemplate中，POST请求可以通过如下三个方法来发起：

第一种：postForEntity

该方法和get请求中的getForEntity方法类似，如下例子：

@RequestMapping("/book3")
public Book book3() {Book book = new Book();book.setName("红楼梦");ResponseEntity<Book> responseEntity = restTemplate.postForEntity("http://HELLO-SERVICE/getBook2", book, Book.class);return responseEntity.getBody();
}

• 方法的第一参数表示要调用的服务的地址

• 方法的第二个参数表示上传的参数

• 方法的第三个参数表示返回的消息体的数据类型

我这里创建了一个Book对象，这个Book对象只有name属性有值，将之传递到服务提供者那里去，服务提供者代码如下：

@RequestMapping(value = "/getBook2", method = RequestMethod.POST)
public Book book2(@RequestBody Book book) {System.out.println(book.getName());book.setPrice(33);book.setAuthor("曹雪芹");book.setPublisher("人民文学出版社");return book;
}

服务提供者接收到服务消费者传来的参数book，给其他属性设置上值再返回，调用结果如下：

postForEntity的其他重载方法如下：

 

这些方法的参数含义和getForEntity参数的含义一致，不再赘述。

第二种：postForObject

如果你只关注，返回的消息体，可以直接使用postForObject。用法和getForObject一致。

第三种：postForLocation

postForLocation也是提交新资源，提交成功之后，返回新资源的URI，postForLocation的参数和前面两种的参数基本一致，只不过该方法的返回值为Uri，这个只需要服务提供者返回一个Uri即可，该Uri表示新资源的位置。

PUT请求

在RestTemplate中，PUT请求可以通过put方法调用，put方法的参数和前面介绍的postForEntity方法的参数基本一致，只是put方法没有返回值而已。举一个简单的例子，如下：

@RequestMapping("/put")
public void put() {Book book = new Book();book.setName("红楼梦");restTemplate.put("http://HELLO-SERVICE/getbook3/{1}", book, 99);
}

 

book对象是我要提交的参数，最后的99用来替换前面的占位符{1}

DELETE请求

delete请求我们可以通过delete方法调用来实现，如下例子：

@RequestMapping("/delete")
public void delete() {restTemplate.delete("http://HELLO-SERVICE/getbook4/{1}", 100);
}

delete方法也有几个重载的方法，不过重载的参数和前面基本一致，不赘述。

如果请求中要带上header时，如下：

restTemplate发送POST请求时可以通过restTemplate.postForObject(url.toString(),requestEntity,String.class)
方式请求，但是GET却没有相应的方法，但是可以使用exchange替代，代码如下：

get添加请求头headers

HttpHeaders headers = new HttpHeaders();
headers.add("token",token);
HttpEntity<String> requestEntity = new HttpEntity<>(null, headers);
ResponseEntity<String> resEntity = restTemplate.exchange(url.toString(), HttpMethod.GET, requestEntity, String.class);

post添加请求头headers和请求体body:

        //headersHttpHeaders requestHeaders = new HttpHeaders();requestHeaders.add("api-version", "1.0");//bodyMultiValueMap<String, String> requestBody = new LinkedMultiValueMap<>();requestBody.add("roundid", "1");//HttpEntityHttpEntity<MultiValueMap> requestEntity = new HttpEntity<MultiValueMap>(requestBody, requestHeaders);RestTemplate restTemplate = new RestTemplate();//postResponseEntity<String> responseEntity = restTemplate.postForEntity("http://xxx", requestEntity, String.class);System.out.println(responseEntity.getBody());

 

 

这篇关于Spring RestTemplate方式实现HTTP请求的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---