Spring: RestTemplate提交表單資料的三種方法
1. 用exchange方法提交
exchange既可以執行POST方法,還可以執行GET,所以應用最為廣泛,使用方法如下:
String url = "http://localhost/mirana-ee/app/login"; RestTemplate client = new RestTemplate(); HttpHeaders headers = new HttpHeaders(); // 請勿輕易改變此提交方式,大部分的情況下,提交方式都是表單提交 headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED); // 封裝引數,千萬不要替換為Map與HashMap,否則引數無法傳遞 MultiValueMap<String, String> params= new LinkedMultiValueMap<String, String>(); // 也支援中文 params.add("username", "使用者名稱"); params.add("password", "123456"); HttpEntity<MultiValueMap<String, String>> requestEntity = new HttpEntity<MultiValueMap<String, String>>(params, headers); // 執行HTTP請求 ResponseEntity<String> response = client.exchange(url, HttpMethod.POST, requestEntity, String.class); // 輸出結果 System.out.println(response.getBody());
2. 用postForEntity進行提交
postForEntity是對exchange的簡化,僅僅只需要減少HttpMethod.POST引數,如下:
// 上面的程式碼完全一樣
// 僅需替換exchange方法
ResponseEntity<String> response = client.postForEntity(url, requestEntity , String.class );
3. 關於表單提交與Payload提交的差異
在Controller的方法引數中,如果將“@ModelAttribute”改為“@RequestBody”註解,則此時的提交方式為Payload方式提交,詳細的差異請參見
// 請注意@RequestBody註解 @RequestMapping(value="/login", method=RequestMethod.POST, consumes="application/json") // 千萬不要畫蛇添足新增@ModelAttribute,否則會被其覆蓋,如下 // public Account getAccount(@[email protected] Account account) public Account getAccount(@RequestBody Account account) { account.setVersion(new Date()); return account; }
再次強調一次,千萬不要畫蛇添足再次新增“@ModelAttribute”,因為其優先順序比較高,所以系統會採用表單方式解析提交內容。
對於Payload方式,提交的內容一定要是String,且Header要設定為“application/json”,示例如下:
// 請求地址
String url = "http://localhost/mirana-ee/app/login";
RestTemplate client = new RestTemplate();
// 一定要設定header
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
// 將提交的資料轉換為String
// 最好通過bean注入的方式獲取ObjectMapper
ObjectMapper mapper = new ObjectMapper();
Map<String, String> params= Maps.newHashMap();
params.put("username", "國米");
params.put("password", "123456");
String value = mapper.writeValueAsString(params);
HttpEntity<String> requestEntity = new HttpEntity<String>(value, headers);
// 執行HTTP請求
ResponseEntity<String> response = client.postForEntity(url, requestEntity , String.class );
System.out.println(response.getBody());
如果內容不是以String方式提交,那麼一定會出現以下錯誤:
Exception in thread "main" org.springframework.web.client.HttpClientErrorException: 400 Bad Request
at org.springframework.web.client.DefaultResponseErrorHandler.handleError(DefaultResponseErrorHandler.java:63)
at org.springframework.web.client.RestTemplate.handleResponse(RestTemplate.java:700)
at org.springframework.web.client.RestTemplate.doExecute(RestTemplate.java:653)
at org.springframework.web.client.RestTemplate.execute(RestTemplate.java:613)
at org.springframework.web.client.RestTemplate.postForEntity(RestTemplate.java:407)
最後需要強調的是,通過@RequestBody是無法獲取到請求引數,如將上面服務端的程式碼改為如下格式,則肯定得不到資料,但表單提交則相反。
@RequestMapping(value="/login", consumes="application/json", method=RequestMethod.POST)
public Account getAccount(@RequestBody Account account, HttpServletRequest request) {
// 肯定得不到引數值
System.out.println(request.getParameter("username"));
account.setVersion(new Date());
return account;
}
4. HttpEntity的結構
HttpEntity是對HTTP請求的封裝,包含兩部分,header與body,header用於設定請求頭,而body則用於設定請求體,所以其的構造器如下:
// value為請求體
// header為請求頭
HttpEntity<String> requestEntity = new HttpEntity<String>(value, headers);
5. HttpEntity與uriVariables
在RestTemplate的使用中,HttpEntity用於傳遞具體的引數值,而uriVariables則用於格式化Http地址,而不是地址引數,正確的用法如下:
// 在地址中加入格式化引數path
String url = "http://localhost/mirana-ee/app/{path}";
// 準備格式化引數
Map<String, String> varParams = Maps.newHashMap();
varParams.put("path", "login");
// 其他程式碼略
// 格式化提交地址
ResponseEntity<String> response = client.postForEntity(url, requestEntity , String.class, varParams);
6. 關於HttpMessageConverter的說明
在網上的很多例子中,我發現很多人為了處理Payload提交,都添加了自定義的HttpMessageConverter,如下:
// 完全沒有必要
client.getMessageConverters().add(new MappingJackson2HttpMessageConverter());
client.getMessageConverters().add(new StringHttpMessageConverter());
然後,經過我檢視原始碼與除錯發現,RestTemplate內建了7種HttpMessageConverter,如下:
1. org.springframework.http.converter.ByteArrayHttpMessageConverter
2. org.springframework.http.converter.StringHttpMessageConverter
3. org.springframework.http.converter.ResourceHttpMessageConverter
4. org.springframework.http.converter.xml.SourceHttpMessageConverter
5. org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter
6. org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter
7. org.springframework.http.converter.json.MappingJackson2HttpMessageConverter
結論
RestTemplate能大幅簡化了提交表單資料的難度,並且附帶了自動轉換JSON資料的功能,但只有理解了HttpEntity的組成結構(header與body),且理解了與uriVariables之間的差異,才能真正掌握其用法。