RestTemplate 详解-优快云博客

2019独角兽企业重金招聘Python工程师标准>>>

如何使用

先讲讲如何使用吧，我项目是 SpringBoot 项目，可以在启动类中加入：

public RestTemplate restTemplate() {

return new RestTemplate();

}

然后在 Controller 层中引入：

1 2	@Autowired private RestTemplate restTemplate;

接下来就可以在 Controller 中各个方法中使用 restTemplate 了，但是 restTemplate 里面有什么方法呢？

RestTemplate 内部方法

mark

从图中 RestTemplate 可以看到有很多方法，我们可以提取出主要的几种方法是：

GET
POST
PUT
DELETE
HEAD
OPTIONS
EXCHANGE
EXECUTE

图片中依然可以知道 RestTemplate 类中的方法主要是来自接口 RestOperations，下面我们具体看看这些方法里面的具体实现与该如何使用。

Get 方法

在 RestTemplate 中，发送一个 GET 请求，我们可以通过如下两种方式：

getForEntity

mark

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 接口，注意这里是通过服务名调用而不是服务地址，如果写成服务地址就没法实现客户端负载均衡了。（备注：我项目中需要通过 ConsulClient 去获取服务名，然后在去获取服务的 IP 和 Port，并把它拼接起来组合成我的服务地址，所以就没法实现客户端的负载均衡了，如果要是实现负载均衡，可以在 SpringBoot 启动类的中加入注解 @LoadBalanced, 如下:
1

2

3

4

5
@Bean

@LoadBalanced

public RestTemplate restTemplate() {

return new RestTemplate();

}
）
getForEntity 第二个参数 String.class 表示我希望返回的 body 类型是 String
拿到返回结果之后，将返回结果遍历打印出来

mark

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

@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();

}

运行结果如下：

mark

getForObject

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

2

3

4

5
@RequestMapping("/book2")

public Book book2() {

Book book = restTemplate.getForObject("http://HELLO-SERVICE/getbook1", Book.class);

return book;

}

POST 方法

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

postForEntity

mark

该方法和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，给其他属性设置上值再返回，调用结果如下：

mark

postForObject

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

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