当前位置：首页 > news >正文

RestTemplate使用详解

news 来源：原创 2024/9/29 2:14:09

文章目录

简介
基本操作
uri参数
传递json参数与header参数设置
form-data
exchange复杂类型处理
上传文件
下载文件

简介

对于http请求之前一直用apache的httpclient，已经习惯了，特别是使用fluent之后，更加方便了。

所以一直没有怎么太过关注RestTemplate，最近才发现在Spring环境中使用RestTemplate还是很方便。

特别是处理带有多重泛型的复杂类型时，httpclient需要一层一层的自己处理，RestTemplate只需要指定类型参数ParameterizedTypeReference就能完美解决。

RestTemplate默认的参数和文件名编码也很方便，基本不用额外处理，就不会有乱码问题。

另外，RestTemplate默认配置就能解决绝大部分场景，所以使用直接new就可以，没有过多配置。

所以，当你下一次在Spring环境中需要使用http请求时，可以考虑一下使用RestTemplate。

基本操作

xxxForObject与xxxForEntity的区别：xxxForObject得到的结果是HTTP返回的body部分，xxxForEntity是整个HTTP返回部分，包含状态码等信息
getForXXX与postForXXX：get请求没有body部分，post请求可以设置body部分
responseType指定的是返回body部分的数据类型，对于复杂类型还需要指定泛型参数

服务端接口：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/rt-template")
public class RestTemplateController {@RequestMapping("/base")public String base() {return "base执行";}@PostMapping("/param")public String param(@RequestParam("id") Long id,@RequestParam("name") String name) {System.out.println("获取到参数id:" + id + " name:" + name);return id + "_" + name;}
}

RestTemplate请求：

 @Test
public void base() {RestTemplate restTemplate = new RestTemplate();String url = "http://localhost:8087/rt-template/base";String result = restTemplate.getForObject(url, String.class);System.out.println(result);result = restTemplate.postForObject(url, null, String.class);System.out.println(result);ResponseEntity<String> entity = restTemplate.getForEntity(url, String.class);System.out.println(entity.getStatusCode() + " " + entity.getBody());entity = restTemplate.postForEntity(url, null, String.class);System.out.println(entity.getStatusCode() + " " + entity.getBody());
}

uri参数

RestTemplate有个map参数可以设置url的参数

例如：http://localhost:8087/rt-template/base?id=123&name=tim

id和name参数可以通过占位符设置,RestTemplate提供了2种方式：

map，根据名字替换
可变参数object，根据顺序替换

url参数主要是针对get请求的传参，不过在RestTemplate中post请求也可以使用该方式。

@Test
public void paramMap() {RestTemplate restTemplate = new RestTemplate();String url = "http://localhost:8087/rt-template/base?id={id}&name={name}";Map<String, Object> uriVariables = new HashMap<>();uriVariables.put("id", "123456");uriVariables.put("name", "tim");String result = restTemplate.getForObject(url, String.class, uriVariables);
//        String result = restTemplate.postForObject(url, null,String.class, uriVariables);System.out.println(result);
}@Test
public void paramObject() {RestTemplate restTemplate = new RestTemplate();String url = "http://localhost:8087/rt-template/base?id={id}&name={name}";String result = restTemplate.getForObject(url, String.class, 123456, "tim");
//        String result = restTemplate.postForObject(url, null, String.class, 123456, "tim");System.out.println(result);
}

传递json参数与header参数设置

在接口中我们使用最多的还是json参数，例如后端使用@RequestBody。

@RequestMapping("/request-body")
public String requestBody(@RequestBody UserTO user){System.out.println(user);return user.toString();
}

@Test
public void postJson() {String url = "http://localhost:8087/rt-template/request-body";RestTemplate restTemplate = new RestTemplate();HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.APPLICATION_JSON);String json = "{\"name\":\"tim\"}";HttpEntity<String> request = new HttpEntity<>(json, headers);restTemplate.postForEntity(url, request, String.class);
}

对于@RequestBody有几点需要说明：

请求必须是post的json数据
@RequestBody可以和@RequestParam一起使用，请求使用post，body为json，@RequestParam获取uri中的参数

@RequestBody从参数可以非常灵活，只要请求是post的json都能正常解析：

@RequestBody String uid
@RequestBody String[] ids
@RequestBody List<String> ids
List<Map<String,Object>> list
@RequestBody User user
@RequestBody List<User> userList

对于 @RequestBody请求不是json时，最常见的错误是：
Content-Type ‘application/x-www-form-urlencoded;charset=UTF-8’ is not supported

基本可以确定是请求端使用了默认的Content-Type，而不是json。

form-data

RestTemplate的post可以直接设置一个map来传递参数

@Test
public void formData() {String url = "http://localhost:8087/rt-template/request-body";RestTemplate restTemplate = new RestTemplate();MultiValueMap<String, Object> paramMap = new LinkedMultiValueMap<>();paramMap.add("name", "tim");String result = restTemplate.postForObject(url, paramMap, String.class);System.out.println(result);
}

上面这个请求默认的Content-Type 是’application/x-www-form-urlencoded;charset=UTF-8’

在服务端，可以使用@RequestParam(“name”)，或者直接用一个对象来获取参数：

@RequestMapping("/param")
public String param(@RequestParam("name") String name) {System.out.println("获取到参数name:" + name);return name;
}@RequestMapping("/form-data")
public String normalUser(UserTO user){System.out.println(user);return user.toString();
}

当然，也可以把参数封装在HttpEntity中：

@Test
public void formDataEntity() {String url = "http://localhost:8087/rt-template/form-data";RestTemplate restTemplate = new RestTemplate();MultiValueMap<String, Object> paramMap = new LinkedMultiValueMap<>();paramMap.add("name", "tim");HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);HttpEntity<MultiValueMap<String, Object>> httpEntity = new HttpEntity<>(paramMap, headers);String user = restTemplate.postForObject(url, httpEntity, String.class);System.out.println(user);
}

exchange复杂类型处理

其实，前面介绍的postxxx、getxxx、xxxForObject、xxxForEntity最终都是调用了exchange。

我们当然也可以直接调用exchange方法，不过我们很少直接调用，因为直接使用exchange稍微复杂一点。

我们什么时候需要exchange呢？

最常见的就是处理复杂类型泛型的时候，因为exchange行有一个ParameterizedTypeReference responseType参数。

前面我们已经感受到了RestTemplate最方便的地方就是能自动帮我们处理返回结果，包装为类。

当处理复杂类型的时候就需要ParameterizedTypeReference。

例如，像下面这个返回Result<List>：

@RequestMapping("/get-users")
public Result<List<UserTO>> getUsers(){LinkedList<UserTO> list = new LinkedList<>();list.add(UserTO.builder().id(1).name("tim").age(18).build());list.add(UserTO.builder().id(2).name("allen").age(20).build());return getSuccess(list);
}public static <T> Result<T> getSuccess(T data){return Result.<T>builder().success(true).data(data).message("执行成功").build();
}

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class UserTO {private Integer id;private String name;private Integer age;private Date birthday;}

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Result <T> {/*** 编码区分消息类型*/private Integer code;/*** 是否执行成功*/private Boolean success;/*** 执行结果消息*/private String message;/*** 数据*/private T data;
}

该我们ParameterizedTypeReference登场了

@Test
public void getUsers() {RestTemplate restTemplate = new RestTemplate();String url = "http://localhost:8087/rt-template/get-users";ParameterizedTypeReference<Result<List<UserTO>>> type = new ParameterizedTypeReference<>() {};HttpHeaders headers = new HttpHeaders();HttpEntity<?> httpEntity = new HttpEntity<>(headers);ResponseEntity<Result<List<UserTO>>> entity = restTemplate.exchange(url, HttpMethod.GET, httpEntity, type);Result<List<UserTO>> result = entity.getBody();System.out.println(result);
}

重点：ParameterizedTypeReference<Result<List>> type = new ParameterizedTypeReference<>() {};

只需要把我们返回参数的泛型具化就可以了。

上传文件

@PostMapping("/upload")
public Result<?> upload(@RequestParam("file") MultipartFile uploadFile,@RequestParam("id") Long id) {String oldName = uploadFile.getOriginalFilename();try {Path dest = Paths.get("F:\\pic", String.valueOf(id), oldName);File file = dest.toFile();if (!file.exists()) {File parentFile = file.getParentFile();if (!parentFile.exists()) {if (!parentFile.mkdirs()) {ResultHelper.getFailResult("创建目录失败");}}if (!file.createNewFile()) {ResultHelper.getFailResult("创建文件失败");}}uploadFile.transferTo(dest);} catch (Exception e) {log.error(e.getMessage(), e);ResultHelper.getFailResult("上传文件失败");}return ResultHelper.getDefaultSuccess();
}

最重要的是设置content type为MULTIPART_FORM_DATA

@Test
public void upload() {String filePath = "F:\\index.html";String url = "http://localhost:8087/rt-template/upload";HttpHeaders headers = new HttpHeaders();// multipart/form-dataheaders.setContentType(MediaType.MULTIPART_FORM_DATA);headers.addIfAbsent("token","123");MultiValueMap<String, Object> param = new LinkedMultiValueMap<>();param.add("file", new FileSystemResource(new File(filePath)));param.add("id", "123");HttpEntity<MultiValueMap<String, Object>> request = new HttpEntity<>(param, headers);RestTemplate restTemplate = new RestTemplate();Result<?> result = restTemplate.postForObject(url, request, Result.class);System.out.println(result);
}

下载文件

@GetMapping("/download/{id}/{name}")
public void download(@PathVariable(value = "id") Long id,@PathVariable(value = "name") String name,HttpServletRequest request,HttpServletResponse response) throws Exception {Path path = Paths.get("F:\\pic", String.valueOf(id), name);File file = path.toFile();if (file.exists()) {FileInputStream fis = new FileInputStream(file);response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE);response.setHeader("content-disposition","attachment;fileName=" + URLEncoder.encode(name, StandardCharsets.UTF_8));OutputStream os = response.getOutputStream();FileCopyUtils.copy(fis, os);}
}

指定body类型为byte数组就可以：

@Test
public void downloadFile() throws IOException {Long id = 123L;String fileName = "index.html";String url = "http://localhost:8087/rt-template/download/{1}/{2}";ResponseEntity<byte[]> entity = restTemplate.getForEntity(url, byte[].class, id, fileName);if (entity.getStatusCode().is2xxSuccessful()) {byte[] body = entity.getBody();if (body == null || body.length == 0) {throw new RuntimeException("文件内容为空");}FileCopyUtils.copy(body, new FileOutputStream("F:\\tmp\\" + fileName));} else {System.out.println("请求异常:" + entity.getStatusCode());}
}