SpringBoot（三）：RestTemplate提交表单数据的三种⽅法
在REST接⼝的设计中，利⽤RestTemplate进⾏接⼝测试是种常见的⽅法，但在使⽤过程中，由于其⽅法参数众多，很多同学⼜混淆了表单提交与Payload提交⽅式的差别，⽽且接⼝设计与传统的浏览器使⽤的提交⽅式⼜有差异，经常出现各种各样的错误，如405错误，或者根本就得不到提交的数据，错误样例如下：
Exception in thread "main" org.springframework.web.client.HttpClientErrorException: 405 Method Not Allowed
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.ute(RestTemplate.java:613)
at org.springframework.web.hange(RestTemplate.java:531)
1. ⽤exchange⽅法提交
exchange既可以执⾏POST⽅法，还可以执⾏GET，所以应⽤最为⼴泛，使⽤⽅法如下：
String url = "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 = hange(url, HttpMethod.POST, requestEntity, String.class);
//  输出结果springboot结构
System.out.Body());
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(@RequestBody@ModelAttribute Account account)
public Account getAccount(@RequestBody Account account) {
account.setVersion(new Date());
return account;
}
再次强调⼀次，千万不要画蛇添⾜再次添加“@ModelAttribute”，因为其优先级⽐较⾼，所以系统会采⽤表单⽅式解析提交内容。
对于Payload⽅式，提交的内容⼀定要是String，且Header要设置为“application/json”，⽰例如下：
//  请求地址
String url = "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= wHashMap();
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.Body());
如果内容不是以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.ute(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.Parameter("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 = "localhost/mirana-ee/app/{path}";
//  准备格式化参数
Map<String, String> varParams = wHashMap();
varParams.put("path", "login");
//  其他代码略
//  格式化提交地址
ResponseEntity<String> response = client.postForEntity(url, requestEntity , String.class, varParams);
6. 关于HttpMessageConverter的说明
在⽹上的很多例⼦中，我发现很多⼈为了处理Payload提交，都添加了⾃定义的HttpMessageConverter，如下：
//  完全没有必要
然后，经过我查看源码与调试发现，RestTemplate内置了7种HttpMessageConverter，如下：
1. org.verter.ByteArrayHttpMessageConverter
2. org.verter.StringHttpMessageConverter
3. org.verter.ResourceHttpMessageConverter
4. org.l.SourceHttpMessageConverter
5. org.verter.support.AllEncompassingFormHttpMessageConverter
6. org.l.Jaxb2RootElementHttpMessageConverter
7. org.verter.json.MappingJackson2HttpMessageConverter
“`
结论
RestTemplate能⼤幅简化了提交表单数据的难度，并且附带了⾃动转换JSON数据的功能，但只有理解了HttpEntity的组成结构（header 与body），且理解了与uriVariables之间的差异，才能真正掌握其⽤法。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。