RestTemplate的使用

r囧r小猫 2023-10-16 14:00 110阅读 0赞

GET请求

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

第一种:getForEntity
getForEntity方法的返回值是一个ResponseEntityResponseEntitySpringHTTP请求响应的封装,包括了几个重要的元素,如响应码、contentType、contentLength、响应消息体等。比如下面一个例子:

  1. @RequestMapping("/gethello")
  2. public String getHello() {
  3. ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/hello", String.class);
  4. String body = responseEntity.getBody();
  5. HttpStatus statusCode = responseEntity.getStatusCode();
  6. int statusCodeValue = responseEntity.getStatusCodeValue();
  7. HttpHeaders headers = responseEntity.getHeaders();
  8. StringBuffer result = new StringBuffer();
  9. result.append("responseEntity.getBody():").append(body).append("<hr>")
  10. .append("responseEntity.getStatusCode():").append(statusCode).append("<hr>")
  11. .append("responseEntity.getStatusCodeValue():").append(statusCodeValue).append("<hr>")
  12. .append("responseEntity.getHeaders():").append(headers).append("<hr>");
  13. return result.toString();
  14. }
  • getForEntity第一个参数为要调用的服务的地址,这里调用了服务提供者提供的/hello接口,注意这里是通过服务名调用而不是服务地址,如果写成服务地址就没法实现客户端负载均衡了
  • getForEntity第二个参数String.class表示希望返回的body类型是String类型
  • 拿到返回结果之后,将返回结果遍历打印出来
    最终显示结果如下
    在这里插入图片描述

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

  1. @RequestMapping("/sayhello")
  2. public String sayHello() {
  3. ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={1}", String.class, "张三");
  4. return responseEntity.getBody();
  5. }
  6. @RequestMapping("/sayhello2")
  7. public String sayHello2() {
  8. Map<String, String> map = new HashMap<>();
  9. map.put("name", "李四");
  10. ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={name}", String.class, map);
  11. return responseEntity.getBody();
  12. }
  • 可以用一个数字做占位符,最后是一个可变长度的参数,来一一替换前面的占位符
  • 也可以前面使用name={name}这种形式,最后一个参数是一个map,map的key即为前边占位符的名字,map的value为参数值

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

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

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

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

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

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

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

运行结果如下:在这里插入图片描述

第二种:getForObject

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

  1. @RequestMapping("/book2")
  2. public Book book2() {
  3. Book book = restTemplate.getForObject("http://HELLO-SERVICE/getbook1", Book.class);
  4. return book;
  5. }

getForObject也有几个重载方法在这里插入图片描述

POST请求

在RestTemplate中,POST请求可以通过如下三个方法来发起:
第一种:postForEntity
该方法和get请求中的getForEntity方法类似,如下例子:

  1. @RequestMapping("/book3")
  2. public Book book3() {
  3. Book book = new Book();
  4. book.setName("红楼梦");
  5. ResponseEntity<Book> responseEntity = restTemplate.postForEntity("http://HELLO-SERVICE/getbook2", book, Book.class);
  6. return responseEntity.getBody();
  7. }
  • 方法的第一参数表示要调用的服务的地址
  • 方法的第二个参数表示上传的参数
  • 方法的第三个参数表示返回的消息体的数据类型

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

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

服务提供者接收到服务消费者传来的参数book,给其他属性设置上值再返回,调用结果如下:在这里插入图片描述

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

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

PUT请求

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

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

DELETE请求

delete请求我们可以通过delete方法调用来实现

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

发表评论

表情:
评论列表 (有 0 条评论,110人围观)

还没有评论,来说两句吧...

相关阅读

    相关 restTemplate使用

    目录 目录 一、概述? 二、使用步骤 1.引入依赖 2.创建RestTemplate对象,交由spring容器进行管理 3.使用方法 3.1 GET请求