springboot解析json参数,springboot接收xml参数
00-1010获取后台获取请求中的参数(非json格式的参数)。结论采集POST请求json格式的参数被检索推荐方法使用(完整方法见后面)。
目录
最近开发的项目,因为有第三方调用了我们的接口,我们用SpringBoot以JavaBean的方式接收我们期望的参数,参数接收没有任何异常。但是有一些需求需要沟通,需要拿到第三方传入的所有参数进行参数验证。
如何获取请求的所有参数?正常的想法肯定是从请求中获取。如果是GET请求,则在请求路径中拼接参数;如果是POST请求,参数在请求的请求体中。
经过一番搜索,很容易得到相关的代码。但实践后发现参数无法如期获得。想了想,我的接口是POST request,参数形式是json格式(@RequestBody用来修饰参数)。
具体过程见以下分析。
背景
00-1010方法1
enumeration string parameter names=request . get parameter names();while(parameter names . hasmoreelements()){ String paraName=parameter names . nextelement();system . out . println(paraName : request . getparameter(paraName));}方法2
MapString,String[]map=request . getparametermap();SetMap。EntryString,String[]keSet=map . entry set();for (IteratorMap。EntryString,String[]itr=keset . iterator();itr . has next();){地图。EntryString,String[]me=itr . next();object ok=me . getkey();object ov=me . getvalue();String[] value=新字符串[1];如果(ov!=null){ value=(String[])ov;} else { value[0]=ov . tostring();} for(int k=0;k值.长度;k){ system . out . println(ok = value[k]);}}
获取请求中的参数(非json格式参数)
经过测试以上两个方法可以获取GET请求的参数,以及参数格式为form-data、x-www-form-urlencoded的POST请求,但是json格式参数(postman中为raw)的参数不能获得.
根据代码的引入程度,第一种方法显然更舒服。
以上结论已经邮差测过了。
00-1010以上的方法在大部分情况下已经可以得到请求的参数,但显然不能满足要求,所以需要得到json格式的参数。
00-1010经过一番查找,网上推荐的方法一般都是使用流读取参数,也就是使用getInputStream()和getReader():
MapString,Object params=new HashMap();BufferedReader br=nulltry { try { br=request . getreader();} catch(io exception e){ e . printstacktrace();} String strStringBuilder wholeStr=new StringBuilder();while((str=objects . require nonnull(br))。readLine())!=null){ wholestr . append(str);}
if (StrUtil.isNotEmpty(wholeStr.toString())) { params = JSON.parseObject(wholeStr.toString(), Map.class); }} catch (IOException e) { e.printStackTrace();}System.out.println(params);遇到的问题及解决思路
问题1 流不能多次被调用
但是又会遇到如下问题:
ERROR m.e.handler.GlobalExceptionHandler - getInputStream() has already been called for this requestjava.lang.IllegalStateException: getInputStream() has already been called for this request at org.apache.catalina.connector.Request.getReader(Request.java:1212) at org.apache.catalina.connector.RequestFacade.getReader(RequestFacade.java:504)
根据报错信息分析简单来说,就是getInputStream()已经被调用了,不能再次调用。可是我看代码上,我也没调用。经过一番检索,原来@RequestBody注解配置后,默认会使用流来读取数据。
具体原因:
默认配置时,getInputStream()和getReader()一起使用会报错,使用两遍getInputStream(),第二遍会为空。当存在@RequestBody等注解时,springMVC已读取过一遍流,默认单独使用getInputStream()或getReader()都为空。实测,不加@RequestBody注解,可以如期获得请求中的json参数,但是又不得不加@RequestBody注解。这样就需要新的思路
解决思路
写filter继承HttpServletRequestWrapper,缓存InputStream,覆盖getInputStream()和getReader()方法,使用ByteArrayInputStream is = new ByteArrayInputStream(body.getBytes());读取InputStream。
实现方法
1.定义增强类,继承继承HttpServletRequestWrapper
将请求体中的流copy一份,覆写getInputStream()和getReader()方法供外部使用。每次调用覆写后的getInputStream()方法都是从复制出来的二进制数组中进行获取,这个二进制数组在对象存在期间一直存在,这样就实现了流的重复读取。
public class BodyReaderHttpServletRequestWrapper extends HttpServletRequestWrapper { private byte[] body; public BodyReaderHttpServletRequestWrapper(HttpServletRequest request) throws IOException { super(request); body = HttpHelper.getBodyString(request).getBytes(StandardCharsets.UTF_8); } @Override public BufferedReader getReader() throws IOException { return new BufferedReader(new InputStreamReader(getInputStream())); } @Override public ServletInputStream getInputStream() throws IOException { final ByteArrayInputStream bais = new ByteArrayInputStream(body); return new ServletInputStream() { @Override public int read() throws IOException { return bais.read(); } @Override public boolean isFinished() { return false; } @Override public boolean isReady() { return false; } @Override public void setReadListener(ReadListener readListener) { } }; } public void setInputStream(byte[] body) { this.body = body; }}
2.构建过滤器
@Slf4j@WebFilter(filterName = "RequestWrapperFilter", urlPatterns = "/api/test/test2")public class RequestWrapperFilter implements Filter { @Override public void init(FilterConfig filterConfig) throws ServletException { } @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException , IOException { ServletRequest requestWrapper = null; if (request instanceof HttpServletRequest) { requestWrapper = new BodyReaderHttpServletRequestWrapper((HttpServletRequest) request); } if (null == requestWrapper) { log.error("过滤器包装request失败!将返回原来的request"); chain.doFilter(request, response); } else { log.info("过滤器包装request成功"); chain.doFilter(requestWrapper, response); } } @Override public void destroy() { }}
注意事项:
使用@WebFilter注解的urlPatterns属性,可指定过滤哪一个接口方法。过滤器类最好不要交由Spring管理,否则每一个接口都会进行过滤(实测)。例如:不要添加@Component注解. 3.编写工具类方便调用
/** * description:http辅助工具类 * * @author RenShiWei * Date: 2021/5/7 22:11 **/public class HttpHelper { /** * description:从request获取body的json数据 * * @param request / * @return / * @author RenShiWei * Date: 2021/5/7 22:44 */ public static String getBodyString(ServletRequest request) { StringBuilder sb = new StringBuilder(); ServletInputStream inputStream = null; BufferedReader reader = null; try { inputStream = request.getInputStream(); reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8)); String line = ""; while ((line = reader.readLine()) != null) { sb.append(line); } } catch (IOException e) { e.printStackTrace(); } finally { if (inputStream != null) { try { inputStream.close(); } catch (IOException e) { e.printStackTrace(); } } if (reader != null) { try { reader.close(); } catch (IOException e) { e.printStackTrace(); } } } return sb.toString(); } /** * description:从request获取body的json数据,并格式化成map形式 * * @param request / * @return / * @author RenShiWei * Date: 2021/5/7 22:44 */ @SuppressWarnings("all") public static Map<String, Object> getBodyMap(ServletRequest request) { Map<String, Object> params = new HashMap<>(); String bodyString = getBodyString(request); if (StrUtil.isNotEmpty(bodyString)) { params = JSON.parseObject(bodyString, Map.class); } return params; }}
4.在SpringBoot启动类上添加@ServletComponentScan注解
使用
@RestController@RequestMapping("/api/test")public class TestController { @GetMapping("/test1") @AnonymousAccess public ResponseEntity<String> test1(HttpServletRequest request) { System.out.println("---GET请求 getParameterNames 入参---"); try { request.setCharacterEncoding("utf-8"); } catch (UnsupportedEncodingException e) { e.printStackTrace(); } Enumeration<String> parameterNames = request.getParameterNames(); while (parameterNames.hasMoreElements()) { String paraName = parameterNames.nextElement(); System.out.println(paraName + ": " + request.getParameter(paraName)); } System.out.println("---GET请求 getParameterMap 入参---"); Map<String, String[]> map = request.getParameterMap(); Set<Map.Entry<String, String[]>> keSet = map.entrySet(); for (Iterator<Map.Entry<String, String[]>> itr = keSet.iterator(); itr.hasNext(); ) { Map.Entry<String, String[]> me = itr.next(); Object ok = me.getKey(); Object ov = me.getValue(); String[] value = new String[1]; if (ov != null) { value = (String[]) ov; } else { value[0] = ov.toString(); } for (int k = 0; k < value.length; k++) { System.out.println(ok + "=" + value[k]); } } return ResponseEntity.ok(null); } @PostMapping("/test2") @AnonymousAccess public ResponseEntity<String> test2(@RequestBody TestParam testParam, HttpServletRequest request) { String body = HttpHelper.getBodyString(request); Map<String, Object> bodyMap = HttpHelper.getBodyMap(request); System.out.println("body: " + body); System.out.println("bodyMap: " + bodyMap); return ResponseEntity.ok(null); }}
postman测试
GET请求
POST的JSON格式参数(其他方式结果与GET请求结果一致)
结果
以上为个人经验,希望能给大家一个参考,也希望大家多多支持盛行IT。
郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。