RestTemplate 是什么？
RestTemplate 是Spring封裝的一個Rest風格http請求框架，底層可以切換成HttpClient OkHttp 或者Netty實現，用戶只需要關心RestTemplate怎么用而不需要關心底層框架如何操作，使用RestTemplate不需要關心如何手動轉換返回的對象和到處都是的異常處理代碼，可以讓你的代碼更簡潔更優雅。
你可以在 spring-web 中找到它
主要類和接口
-
RestOperations定義Rest 操作的接口 -
HttpAccessor抽象http help 類 -
InterceptingHttpAccessor HttpAccess裝飾類拓展了攔截器功能 -
RestTemplate具體實現類 -
ClientHttpRequestInterceptor攔截器接口 用于攔截http請求 -
UriTemplateHandler uri模板處理器，后面拓展會用到
基礎使用
put delete 等方法參考get post 的寫法
Get獲取對象或對象集合
獲取 Employee 集合
|
1
2
3
4
5
6
7
|
RestTemplate restTemplate = new RestTemplate();ResponseEntity<List<Employee>> response = restTemplate.exchange( "http://localhost:8080/employees/", HttpMethod.GET, null, new ParameterizedTypeReference<List<Employee>>(){});List<Employee> employees = response.getBody(); |
返回對象list用exchange方法使用 ParameterizedTypeReference 指定返回類型 ，getForEntity 也可以使用 Object[].class 或 其他數組接收再轉為List
獲取單個對象
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
public class EmployeeList { private List<Employee> employees; public EmployeeList() { employees = new ArrayList<>(); } // getter/setter}EmployeeList response = restTemplate.getForObject( "http://localhost:8080/employees", EmployeeList.class);List<Employee> employees = response.getEmployees(); |
Post 發送對象或集合
發送集合
|
1
2
3
4
5
6
7
8
|
List<Employee> newEmployees = new ArrayList<>();newEmployees.add(new Employee(3, "Intern"));newEmployees.add(new Employee(4, "CEO")); restTemplate.postForObject( "http://localhost:8080/employees/", newEmployees, ResponseEntity.class); |
發送對象
|
1
2
3
4
5
6
7
8
|
List<Employee> newEmployees = new ArrayList<>();newEmployees.add(new Employee(3, "Intern"));newEmployees.add(new Employee(4, "CEO")); restTemplate.postForObject( "http://localhost:8080/employees", new EmployeeList(newEmployees), ResponseEntity.class); |
上傳文件
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
public void uploadFile(){ HttpHeaders headers = new HttpHeaders(); //設置Content-Type headers.setContentType(MediaType.MULTIPART_FORM_DATA); MultiValueMap<String, Object> body = new LinkedMultiValueMap<>(); body.add("file", getTestFile()); HttpEntity<MultiValueMap<String, Object>> requestEntity = new HttpEntity<>(body, headers); String serverUrl = "http://localhost:8082/spring-rest/fileserver/singlefileupload/"; RestTemplate restTemplate = new RestTemplate(); ResponseEntity<String> response = restTemplate .postForEntity(serverUrl, requestEntity, String.class);}public FileSystemResource getTestFile(){ return new FileSystemResource("./test.md")} |
FileSystemResource 是spring中的一個類 參考
上傳多個文件
在上傳單個文件的基礎上多加幾個文件
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
MultiValueMap<String, Object> body = new LinkedMultiValueMap<>();body.add("files", getTestFile());body.add("files", getTestFile());body.add("files", getTestFile()); HttpEntity<MultiValueMap<String, Object>> requestEntity = new HttpEntity<>(body, headers); String serverUrl = "http://localhost:8082/spring-rest/fileserver/multiplefileupload/"; RestTemplate restTemplate = new RestTemplate();ResponseEntity<String> response = restTemplate .postForEntity(serverUrl, requestEntity, String.class); |
Spring RestTemplate 拓展
- 解決restTemplate get* url參數必須寫死的問題
- 解決get*方法不好添加header信息的問題
繼承RestTemplate 拓展get方法
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
/*** 繼承RestTemplate 新加get* 方法 比原有的方法多了個 httpHeaders 參數*/public class CustomerRestTemplate extends RestTemplate { public <T> ResponseEntity<T> getForEntity(String url, HttpHeaders httpHeaders, Class<T> responseType, Object... uriVariables) throws RestClientException { HttpEntity<Object> requestEntity = new HttpEntity<>(httpHeaders); RequestCallback requestCallback = httpEntityCallback(requestEntity, responseType); ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType); return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables); } public <T> ResponseEntity<T> getForEntity(String url, HttpHeaders httpHeaders, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException { HttpEntity<Object> requestEntity = new HttpEntity<>(httpHeaders); RequestCallback requestCallback = httpEntityCallback(requestEntity, responseType); ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType); return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables); } public <T> T getForObject(String url, HttpHeaders httpHeaders, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException { HttpEntity<Object> requestEntity = new HttpEntity<>(httpHeaders); RequestCallback requestCallback = httpEntityCallback(requestEntity, responseType); ResponseExtractor<T> responseExtractor = new HttpMessageConverterExtractor<T>(responseType, getMessageConverters()); return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables); } public <T> T getForObject(String url, HttpHeaders httpHeaders, Class<T> responseType, Object... uriVariables) throws RestClientException { HttpEntity<Object> requestEntity = new HttpEntity<>(httpHeaders); RequestCallback requestCallback = httpEntityCallback(requestEntity, responseType); ResponseExtractor<T> responseExtractor = new HttpMessageConverterExtractor<T>(responseType, getMessageConverters()); return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables); }} |
拓展URI處理邏輯
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
/*** 根據uriTemplate 把 uriVariables 分成兩類 * 一類是path params 一類是 query params 分開賦值* 如 /xx/{id}/type path params 就是 id uriVariables 剩下的就是query params 用？拼接在url后面* 如果查詢參數中有數組或集合類型的參數會轉化成 key[]=value1&key[]=value2...*/public class QueryParamsUrlTemplateHandler extends DefaultUriTemplateHandler { /** * 匹配path param */ private static final Pattern NAMES_PATTERN = Pattern.compile("\\{([^/]+?)\\}"); @Override public URI expand(String uriTemplate, Map<String, ?> uriVariables) { UriComponentsBuilder uriComponentsBuilder = UriComponentsBuilder.fromHttpUrl(uriTemplate); //解析uriTemplate 提取query param Map<String, ?> queryParam = getQueryParam(uriTemplate, uriVariables); //設置query param queryParam.forEach((k, v) -> { if (v instanceof Object[]) { Object[] arrayParam = (Object[]) v; //把數組類型的參數拼成 參數名 + [] 的形式 k[] xx&kp[]=xx&k[]=xx String key = k + "[]"; String strArrayParam = Stream.of(arrayParam).map(String::valueOf).collect(Collectors.joining("&" + key + "=")); uriComponentsBuilder.queryParam(key, strArrayParam); } else if (v instanceof Iterable) { Iterable iterable = (Iterable) v; String key = k + "[]"; String strArrayParam = Stream.of(iterable).map(String::valueOf).collect(Collectors.joining("&" + key + "=")); uriComponentsBuilder.queryParam(key, strArrayParam); } else { uriComponentsBuilder.queryParam(k, v); } }); uriTemplate = uriComponentsBuilder.build().toUriString(); //設置path param return super.expand(uriTemplate, uriVariables); } /** * 解析uriTemplate 分離 query param * * @param uriTemplate uri模板 * @param uriVariables 全部的模板變量 * @return 查詢變量 */ public Map<String, ?> getQueryParam(String uriTemplate, Map<String, ?> uriVariables) { if (uriTemplate == null) { return null; } if (uriTemplate.indexOf('{') == -1) { return uriVariables; } if (uriTemplate.indexOf(':') != -1) { uriTemplate = sanitizeSource(uriTemplate); } Map<String, Object> pathVariables = Maps.newHashMap(); Matcher matcher = NAMES_PATTERN.matcher(uriTemplate); while (matcher.find()) { String matchKey = matcher.group(1); Object value = uriVariables.get(matchKey); if (value != null) { pathVariables.put(matchKey, value); } } //此處為了圖方便使用了 guava 工具包中的類 功能就是取差集 MapDifference<String, Object> difference = Maps.difference(uriVariables, pathVariables); return difference.entriesOnlyOnLeft(); } /** * Remove nested "{}" such as in URI vars with regular expressions. */ private static String sanitizeSource(String source) { int level = 0; StringBuilder sb = new StringBuilder(); for (char c : source.toCharArray()) { if (c == '{') { level++; } if (c == '}') { level--; } if (level > 1 || (level == 1 && c == '}')) { continue; } sb.append(c); } return sb.toString(); }} |
實際使用
初始化RestTemplate
|
1
2
3
4
5
6
7
8
9
10
11
|
SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();requestFactory.setConnectTimeout(500);// 設置超時requestFactory.setReadTimeout(500);//new 自己定義的類CustomerRestTemplate restTemplate = new CustomerRestTemplate();//設置自定義的uri處理處理器QueryParamsUrlTemplateHandler queryParamsUrlTemplateHandler = new QueryParamsUrlTemplateHandler();//這里使用裝飾模式 添加rootUriRootUriTemplateHandler rootUriTemplateHandler = new RootUriTemplateHandler(outUrl, queryParamsUrlTemplateHandler);restTemplate.setUriTemplateHandler(rootUriTemplateHandler);restTemplate.setRequestFactory(requestFactory); |
get請求示例
|
1
2
3
4
5
6
7
8
|
Map<String, Object> params = new HashMap<>();params.put("id", "1");params.put("param2", "2");params.put("param", new Integer[]{1506, 1507});HttpHeaders httpHeaders = new HttpHeaders();httpHeaders.add("Authorization", "Basic " + "your authorization");ResponseEntity<Map[]> forEntity = restTemplate.getForEntity("/api/test/{id}", httpHeaders, Map[].class, params);// url 為 api/test/1?param[]=1506¶m[]=1507¶m2=2 |
思考進一步封裝
可以考慮使用建造者模式改造restTemplate
|
1
2
3
4
5
6
7
8
|
Employee employee = RestTemplate.build() .get("api/xxx/{id}") .header("xx","xx") .headers(new Headers()) .param("xx","xx") .params(new HashMap(){{put("bb","bb");}}) .targetClass(Employee.class) .execute(); |
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持服務器之家。
原文鏈接：https://blog.csdn.net/isyoungboy/article/details/86608877
