解决 Spring RestTemplate post传递参数时报错问题

今天跟同事接口联调,使用RestTemplate请求服务端的post接口(使用python开发)。诡异的是,post请求,返回500 Internal Server Error,而使用get请求,返回正常。代码如下:

 HashMap<String, Object> hashMap = Maps.newHashMap();
 hashMap.put("data", JSONObject.toJSONString(params));
 url = "http://mydomain/dataDownLoad.cgi?data={data}";
 json = restTemplate.getForObject(url, String.class, hashMap);
 System.out.println("get json : " + json);
 url = "http://mydomain/dataDownLoad.cgi";
 json = restTemplate.postForObject(url, hashMap, String.class);
 System.out.println("hasmap post json : " + json);

结果为:

get json : {'status': 0, 'statusInfo': {'global': 'OK'}, 'data': 'http://mydomain/dataDownLoad.cgi?downLoadData=358300d5f9e1cc512efc178caaa0b061'}

500 Internal Server Error

最后经过另一位同学帮忙排查,发现RestTemplate在postForObject时,不可使用HashMap。而应该是MultiValueMap。改为如下:

MultiValueMap<String, String> paramMap = new LinkedMultiValueMap<>();
paramMap.add("data", JSONObject.toJSONString(params));
url = "http://mydomain/dataDownLoad.cgi";
json = restTemplate.postForObject(url, paramMap, String.class);
System.out.println("post json : " + json);

结果为:

post json : {'status': 0, 'statusInfo': {'global': 'OK'}, 'data': 'http://mydomain/dataDownLoad.cgi?downLoadData=f2fc328513886e51b3b67d35043985ae'}

然后我想起之前使用RestTemplate发起post请求时,使用POJO作为参数,是可行的。再次测试:

url = "http://mydomain/dataDownLoad.cgi";
PostData postData = new PostData();
postData.setData(JSONObject.toJSONString(params));
json = restTemplate.postForObject(url, paramMap, String.class);
System.out.println("postData json : " + json);

返回:500 Internal Server Error。

到现在为止接口调通了。但问题的探究才刚刚开始。

RestTemplate的post参数为什么使用MultiValueMap而不能使用HashMap?

为什么post接口,get请求也可以正确返回?

为什么java服务端可以接收POJO参数,python服务端不可以?python服务端使用CGI(Common Gateway Interface),与cgi有关系吗?

何为MultiValueMap

IDEA中command+N,搜索类MultiValueMap,发现apache的commons-collections包有一个MultiValueMap类,spring-core包中有一个接口MultiValueMap,及其实现类LinkedMultiValueMap。显然看spring包。

首先看LinkedMultiValueMap,实现MultiValueMap接口,只有一个域:Map<K, List<V>> targetMap = new LinkedHashMap<K, List<V>>()。 其中value为new LinkedList<V>()。再看接口方法:

public interface MultiValueMap<K, V> extends Map<K, List<V>> {
  V getFirst(K key); //targetMap.get(key).get(0)
  void add(K key, V value); //targetMap.get(key).add(value)
  void set(K key, V value); //targetMap.set(key, Lists.newLinkedList(value))
  void setAll(Map<K, V> values); //将普通map转为LinkedMultiValueMap
  Map<K, V> toSingleValueMap(); //只保留所有LinkedList的第一个值,转为LinkedHashMap
}

综上,LinkedMultiValueMap实际就是Key-LinkedList的map。

RestTemplate怎么处理post参数

首先查看RestTemplate源码,首先将请求封装成HttpEntityRequestCallback类对象,然后再处理请求。

Override
public <T> T postForObject(String url, Object request, Class<T> responseType, Object... uriVariables)
    throws RestClientException {
  //请求包装成httpEntityCallback
  RequestCallback requestCallback = httpEntityCallback(request, responseType);
  HttpMessageConverterExtractor<T> responseExtractor =
      new HttpMessageConverterExtractor<T>(responseType, getMessageConverters(), logger);
  //处理请求
  return execute(url, HttpMethod.POST, requestCallback, responseExtractor, uriVariables);
}

那么HttpEntityRequestCallback是什么样的呢?如下,实际是把请求数据放在了一个HttpEntity中。如果requestBody是HttpEntity类型,就直接转;否则,放在HttpEntity的body中。

//请求内容封装在一个HttpEntity对象中。
private HttpEntityRequestCallback(Object requestBody, Type responseType) {
  super(responseType);
  if (requestBody instanceof HttpEntity) {
    this.requestEntity = (HttpEntity<?>) requestBody;
  }
  else if (requestBody != null) {
    this.requestEntity = new HttpEntity<Object>(requestBody);
  }
  else {
    this.requestEntity = HttpEntity.EMPTY;
  }
}

接着看一下HttpEntity源码:

public class HttpEntity<T> {
  private final HttpHeaders headers;
  private final T body;
  public HttpEntity(T body) {
    this.body = body;
  }
}
public class HttpHeaders implements MultiValueMap<String, String>, Serializable{
  ......
}

至此,与MultiValueMap联系上了。

基于本次问题,我们不考虑post数据参数是HttpEntity类型的,只考虑普通POJO。那么,postForObject中对post数据的第一步处理,就是放在一个HttpEntity类型(header为MultiValueMap类型,body为泛型)的body中。

再看处理请求的部分:

Object requestBody = requestEntity.getBody();
Class<?> requestType = requestBody.getClass();
HttpHeaders requestHeaders = requestEntity.getHeaders();
MediaType requestContentType = requestHeaders.getContentType();
for (HttpMessageConverter<?> messageConverter : getMessageConverters()) {
  if (messageConverter.canWrite(requestType, requestContentType)) {
    if (!requestHeaders.isEmpty()) {
      httpRequest.getHeaders().putAll(requestHeaders);
    }
    ((HttpMessageConverter<Object>) messageConverter).write(
        requestBody, requestContentType, httpRequest);
    return;
  }
}

通过配置的HttpMessageConverter来处理。

  <bean id="restTemplate" class="org.springframework.web.client.RestTemplate">
    <constructor-arg ref="ky.clientHttpRequestFactory"/>
    <property name="errorHandler">
      <bean class="org.springframework.web.client.DefaultResponseErrorHandler"/>
    </property>
    <property name="messageConverters">
      <list>
        <bean class="org.springframework.http.converter.FormHttpMessageConverter"/>
        <bean class="cn.com.autodx.common.jsonView.ViewAwareJsonMessageConverter"/>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
          <property name="supportedMediaTypes">
            <list>
              <value>text/html;charset=UTF-8</value>
              <value>application/json</value>
            </list>
          </property>
        </bean>
      </list>
    </property>
  </bean>

符合要求的只有ViewAwareJsonMessageConverter,其自定义处理如下。post数据中hashMap只含有data一个key,不含status字段,所以会跳过写的操作,即post请求带不上参数。如果修改代码,当不含status字段时,按照父类方法处理,则服务端可以得到参数。

protected void writeInternal(Object object, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
  if(object instanceof Map) {
    Map map = (Map)object;
    HashMap statusInfo = new HashMap();
    //不含有status字段,跳过
    Object status = map.get("status");
    if(status != null) {
      int code = Integer.parseInt(String.valueOf(status));
      if(0 != code) {
        super.writeInternal(object, outputMessage);
      } else {
        statusInfo.put("global", "OK");
        map.put("statusInfo", statusInfo);
        super.writeInternal(object, outputMessage);
      }
    }
  } else {
    super.writeInternal(object, outputMessage);
  }
}

而使用MultiValueMap会由FormHttpMessageConverter正确处理。

首先判断是否可以执行写操作,如果可以,执行写操作。

  @Override
  public boolean canWrite(Class<?> clazz, MediaType mediaType) {
    if (!MultiValueMap.class.isAssignableFrom(clazz)) {
      return false;
    }
    if (mediaType == null || MediaType.ALL.equals(mediaType)) {
      return true;
    }
    for (MediaType supportedMediaType : getSupportedMediaTypes()) {
      if (supportedMediaType.isCompatibleWith(mediaType)) {
        return true;
      }
    }
    return false;
  }
@Override
@SuppressWarnings("unchecked")
public void write(MultiValueMap<String, ?> map, MediaType contentType, HttpOutputMessage outputMessage)
    throws IOException, HttpMessageNotWritableException {
  if (!isMultipart(map, contentType)) { //LinkedList中是否含有多个数据
    //只是普通的K-V,写form
    writeForm((MultiValueMap<String, String>) map, contentType, outputMessage);
  }
  else {
    writeMultipart((MultiValueMap<String, Object>) map, outputMessage);
  }
}

既如此,那么post参数为POJO时,如何呢?

POJO也会被ViewAwareJsonMessageConverter处理,在其writeInternal中,object不是map,所以调用 super.writeInternal(object, outputMessage),如下:

@Override
protected void writeInternal(Object obj, HttpOutputMessage outputMessage) throws IOException,                              HttpMessageNotWritableException {
  OutputStream out = outputMessage.getBody();
  String text = JSON.toJSONString(obj, features);
  byte[] bytes = text.getBytes(charset);
  out.write(bytes);
}

如果注释掉ViewAwareJsonMessageConverter,跟踪发现,会报错,返回没有合适的HttpMessageConverter处理。

使用ViewAwareJsonMessageConverter和使用FormHttpMessageConverter写数据的格式是不一样的,所以,post POJO后,会返回错误,但实际已将参数传递出去。

所以,对于我们配置的RestTemplate来说,post参数可以是map(有字段要求),也可以是POJO。即,输入输出数据由RestTemplate配置的messageConverters决定。

至此,我们已经清楚了第一个问题,剩下的问题同样的思路。跟踪一下getForObject的处理路径。get方式请求时,把所有的参数拼接在url后面,发给服务端,就可以把参数带到服务端。

剩下的问题就是python服务端是怎么处理请求的。首先研究一下CGI。

何为CGI

通用网关接口(CGI,Common Gateway Interface)是一种Web服务器和服务器端程序进行交互的协议。CGI完全独立于编程语言,操作系统和Web服务器。这个协议可以用vb,c,php,python 来实现。

工作方式如图所示:

browser->webServer: HTTP protocol

webServer->CGI脚本: 通过CGI管理模块调用脚本

CGI脚本->CGI脚本: 执行脚本程序

CGI脚本->webServer: 返回结果

webServer->browser: HTTP protocol

web服务器获取了请求cgi服务的http请求后,启动cgi脚本,并将http协议参数和客户端请求参数转为cgi协议的格式,传给cgi脚本。cgi脚本执行完毕后,将数据返回给web服务器,由web服务器返回给客户端。

cgi脚本怎么获取参数呢?

CGI脚本从环境变量QUERY_STRING中获取GET请求的数据

CGI脚本从stdin(标准输入)获取POST请求的数据,数据长度存在环境变量CONTENT_LENGTH中。

了解CGI大概是什么东东后,看一下python实现的CGI。

python的CGI模块,要获取客户端的post参数,可以使用cgi.FieldStorage()方法。FieldStorage相当于python中的字典,支持多个方法。可以支持一般的key-value,也可以支持key-List<Value>,即类似于MultiValueMap形式的参数(如多选的表单数据)。

至此,本问题主要是在于程序怎么传递参数,对于spring restTemplate而言,就是messageConverters怎么配置的。

更多关于RestTemplate post传递参数时报错问题文章大家看看下面的相关链接

(0)

相关推荐

  • Spring Boot使用RestTemplate消费REST服务的几个问题记录

    我们可以通过Spring Boot快速开发REST接口,同时也可能需要在实现接口的过程中,通过Spring Boot调用内外部REST接口完成业务逻辑. 在Spring Boot中,调用REST Api常见的一般主要有两种方式,通过自带的RestTemplate或者自己开发http客户端工具实现服务调用. RestTemplate基本功能非常强大,不过某些特殊场景,我们可能还是更习惯用自己封装的工具类,比如上传文件至分布式文件系统.处理带证书的https请求等. 本文以RestTemplate来

  • Spring cloud restTemplate 传递复杂参数的方式(多个对象)

    使用微服务的时候往往服务之间调用比较麻烦,spring cloud提供了Feign接口调用,RestTemplate调用的方式 这里我探讨下RestTemplate调用的方式: 服务A:接收三个对象参数  这三个参数的是通过数据库查询出来的 服务B:要调用服务A 服务B提供了查询三个参数的方法,后面要使用三个参数 对于服务A,处理的方式有两中 1. 服务B提供一个Feign接口将查询三个参数的方法公开,服务A直接引用Feign来查询参数,服务B只需要将三个查询关键字传递过去即可 服务A acti

  • 详解SpringBoot通过restTemplate实现消费服务

    一.RestTemplate说明 RestTemplate是Spring提供的用于访问Rest服务的客户端,RestTemplate提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率.前面的博客中http://www.jb51.net/article/132885.htm,已经使用Jersey客户端来实现了消费spring boot的Restful服务,接下来,我们使用RestTemplate来消费前面示例中的Restful服务,前面的示例: springboot整合H2内存

  • SpringBoot RestTemplate 简单包装解析

    RestTemplate设计是为了Spring更好的请求并解析Restful风格的接口返回值而设计的,通过这个类可以在请求接口时直接解析对应的类. 在SpringBoot中对这个类进行简单的包装,变成一个工具类来使用,这里用到的是getForEntity和postForEntity方法,具体包装的代码内容 如下: package cn.eangaie.demo.util; import com.alibaba.fastjson.JSONObject; import org.springframe

  • Spring学习笔记之RestTemplate使用小结

    前言 作为一个Java后端,需要通过HTTP请求其他的网络资源可以说是一个比较常见的case了:一般怎么做呢? 可能大部分的小伙伴直接捞起Apache的HttpClient开始做,或者用其他的一些知名的开源库如OkHttp, 当然原生的HttpURLConnection也是没问题的 本篇博文则主要关注点放在Sprig的生态下,利用RestTemplate来发起Http请求的使用姿势 I. RestTempalate 基本使用 0. 目标 在介绍如何使用RestTemplate之前,我们先抛出一些

  • Spring RestTemplate具体使用详解

    1.什么是REST? REST(RepresentationalState Transfer)是Roy Fielding 提出的一个描述互联系统架构风格的名词.REST定义了一组体系架构原则,您可以根据这些原则设计以系统资源为中心的Web 服务,包括使用不同语言编写的客户端如何通过 HTTP处理和传输资源状态. 为什么称为 REST?Web本质上由各种各样的资源组成,资源由URI 唯一标识.浏览器(或者任何其它类似于浏览器的应用程序)将展示出该资源的一种表现方式,或者一种表现状态.如果用户在该页

  • Spring Boot RestTemplate提交表单数据的三种方法

    在REST接口的设计中,利用RestTemplate进行接口测试是种常见的方法,但在使用过程中,由于其方法参数众多,很多同学又混淆了表单提交与Payload提交方式的差别,而且接口设计与传统的浏览器使用的提交方式又有差异,经常出现各种各样的错误,如405错误,或者根本就得不到提交的数据,错误样例如下: Exception in thread "main" org.springframework.web.client.HttpClientErrorException: 405 Metho

  • 如何使用Spring RestTemplate访问restful服务

    一. 什么是RestTemplate Spring's central class for synchronous client-side HTTP access. It simplifies communication with HTTP servers, and enforces RESTful principles. It handles HTTP connections, leaving application code to provide URLs(with possible tem

  • Spring boot2X Consul如何通过RestTemplate实现服务调用

    这篇文章主要介绍了spring boot2X Consul如何通过RestTemplate实现服务调用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 Consul可以用于实现分布式系统的服务发现与配置 服务调用有两种方式: A.使用RestTemplate 进行服务调用 负载均衡--通过Ribbon注解RestTemplate B.使用Feign 进行声明式服务调用 负载均衡--默认使用Ribbon实现 先使用RestTemplate来实现 1

  • Spring使用RestTemplate模拟form提交示例

    RestTemplate是用来在客户端访问Web服务的类.和其他的Spring中的模板类(如JdbcTemplate.JmsTemplate)很相似,我们还可以通过提供回调方法和配置HttpMessageConverter类来客户化该模板.客户端的操作可以完全使用RestTemplate和HttpMessageConveter类来执行. 1.声明RestTemplate的bean @Bean public RestTemplate restTemplate(){ return new RestT

  • Springboot RestTemplate 简单使用解析

    前言 spring框架提供的RestTemplate类可用于在应用中调用rest服务,它简化了与http服务的通信方式,统一了RESTful的标准,封装了http链接, 我们只需要传入url及返回值类型即可. 相较于之前常用的HttpClient,RestTemplate是一种更优雅的调用RESTful服务的方式.该类主要用到的函数有:exchange.getForEntity.postForEntity等.我主要用的是后面两个函数,来执行发送get跟post请求. 首先是RestTemplat

  • 详解SpringBoot中RestTemplate的几种实现

    RestTemplate的多种实现 使用JDK默认的http library 使用Apache提供的httpclient 使用Okhttp3 @Configuration public class RestConfig { @Bean public RestTemplate restTemplate(){ RestTemplate restTemplate = new RestTemplate(); return restTemplate; } @Bean("urlConnection"

  • springMVC中RestTemplate传值接值方法

    我们需要给接口推送数据以及接口接收数据的时候,可以用springmvc中的一种简单方法 1.需要在spring-mvc.xml中配置信息转化器. <bean id = "stringHttpMessageConverter" class = "org.springframework.http.converter.StringHttpMessageConverter"/> <bean id="jsonHttpMessageConverter

随机推荐