Spring Boot(三):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.client.RestTemplate.execute(RestTemplate.java:613)
    at org.springframework.web.client.RestTemplate.exchange(RestTemplate.java:531)

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方式提交,详细的差异请参见《 $.ajax使用总结(一):Form提交与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 = "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之间的差异,才能真正掌握其用法。

  • 28
    点赞
  • 83
    收藏
    觉得还不错? 一键收藏
  • 11
    评论
### 回答1: 在Spring Boot中,RestTemplate是一个用于访问RESTful API的HTTP客户端工具。您可以使用RestTemplate来执行HTTP请求并获取响应。以下是使用RestTemplate的基本步骤: 1. 在Spring Boot应用程序中添加RestTemplate依赖项。如果您使用的是Maven,则可以在pom.xml文件中添加以下依赖项: ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> ``` 2. 在Java类中创建一个RestTemplate对象。您可以使用Spring Boot的自动配置机制来创建RestTemplate对象。在您的类中使用@Autowired注解即可创建RestTemplate对象。 ``` @Autowired private RestTemplate restTemplate; ``` 3. 使用RestTemplate执行HTTP请求。您可以使用RestTemplate的不同方法执行GET、POST、PUT、DELETE等HTTP请求。例如,以下是使用RestTemplate执行GET请求的示例代码: ``` String url = "http://example.com/api/v1/users"; User[] users = restTemplate.getForObject(url, User[].class); ``` 在这个例子中,我们使用getForObject方法执行一个GET请求,将返回的JSON数据映射为一个User数组。 4. 处理响应。您可以使用RestTemplate的不同方法来处理响应。例如,以下是处理响应的示例代码: ``` ResponseEntity<String> response = restTemplate.getForEntity(url, String.class); HttpStatus statusCode = response.getStatusCode(); String responseBody = response.getBody(); ``` 在这个例子中,我们使用getForEntity方法执行一个GET请求,并获取响应实体。我们使用getStatusCode方法获取HTTP状态码,使用getBody方法获取响应体。 这是使用RestTemplate的基本步骤。您可以使用RestTemplate执行不同类型的HTTP请求,并处理响应。 ### 回答2: Spring Boot中的RestTemplate是一个用于发送HTTP请求并接收HTTP响应的模板类。使用RestTemplate可以简化开发人员对HTTP请求的处理,可以发送GET、POST、PUT、DELETE等不同类型的请求,并且可以处理返回的JSON或XML格式的数据使用RestTemplate首先需要在Spring Boot项目中添加相应的依赖,一般在pom.xml文件中添加如下依赖: ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> ``` 接下来,可以在代码中使用RestTemplate类的实例来发送HTTP请求。首先需要在Spring Boot配置类中配置RestTemplate的Bean: ```java @Bean public RestTemplate restTemplate() { return new RestTemplate(); } ``` 然后,可以在其他类中使用@Autowired注解将RestTemplate注入进行使用: ```java @Autowired private RestTemplate restTemplate; ``` 接下来,可以使用RestTemplate实例的各种方法来发送HTTP请求,例如发送GET请求: ```java String url = "http://api.example.com/getData"; ResponseEntity<String> responseEntity = restTemplate.getForEntity(url, String.class); String responseBody = responseEntity.getBody(); ``` 还可以发送POST请求,并传递参数和请求体: ```java String url = "http://api.example.com/submitData"; MultiValueMap<String, String> requestParams = new LinkedMultiValueMap<>(); requestParams.add("param1", "value1"); requestParams.add("param2", "value2"); HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); HttpEntity<MultiValueMap<String, String>> requestEntity = new HttpEntity<>(requestParams, headers); ResponseEntity<String> responseEntity = restTemplate.postForEntity(url, requestEntity, String.class); String responseBody = responseEntity.getBody(); ``` 以上是RestTemplate的基本使用方法,开发人员可以根据实际需求来调用不同的方法来发送HTTP请求和处理响应结果。 ### 回答3: 在Spring Boot中,可以使用RestTemplate来进行HTTP请求和响应的处理。RestTemplate是一个提供了简化HTTP请求的高级工具类。 首先,需要在Spring Boot的项目中引入RestTemplate的依赖。可以在pom.xml文件中添加以下依赖: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> ``` 在完成依赖引入后,可以在代码中实例化一个RestTemplate对象,并使用其提供的方法发送HTTP请求。以下是一个示例: ```java // 实例化RestTemplate对象 RestTemplate restTemplate = new RestTemplate(); // 发送GET请求,并返回响应结果 String url = "https://api.example.com/data"; String response = restTemplate.getForObject(url, String.class); // 发送POST请求,并传递JSON数据 String url = "https://api.example.com/data"; String requestBody = "{\"name\":\"John\",\"age\":30}"; HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); HttpEntity<String> requestEntity = new HttpEntity<>(requestBody, headers); ResponseEntity<String> responseEntity = restTemplate.postForEntity(url, requestEntity, String.class); String response = responseEntity.getBody(); ``` 以上示例中,使用RestTemplate提供的getForObject方法发送了一个GET请求,并返回了响应结果;同时也使用postForEntity方法发送了一个POST请求,并传递了JSON数据。 除了GET和POST请求之外,RestTemplate还提供了其他常用的HTTP方法,例如PUT、DELETE等,可以根据业务需求选择适合的方法进行使用。 需要注意的是,RestTemplate是在Spring 5.x中被标记为过时API,建议在新项目中使用WebClient代替。
评论 11
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值