zoukankan      html  css  js  c++  java
  • 如何优雅地读写HttpServletRequest和HttpServletResponse的请求体

    最近很多交互要同原生的HttpServletRequestHttpServletResponse打交道。从HttpServletRequest中读取body数据封装成某种数据结构;向HttpServletResponse写入数据并响应。传统的写法非常不优雅,今天给大家介绍一种比较优雅的方式。

    HttpMessageConverter

    HttpMessageConverter是Spring框架提供的一个消息转换器模型,用于在 HTTP 请求和响应之间进行转换的策略接口。它可以对输入消息HttpInputMessage进行读;也可以对输出消息HttpOutputMessage进行写。

    HttpMessageConverter

    Spring MVC的消息转换都是通过这个接口的实现来完成的。HttpMessageConverter有很多实现:

    HttpMessageConverter常见实现

    通常Spring MVC中处理Form表单提交、JSONXML、字符串、甚至Protobuf都由HttpMessageConverter 的实现来完成,前端传递到后端的body参数,后端返回给前端的数据都是由这个接口完成转换的。在Spring IoC中(Spring MVC环境)还存在一个存放HttpMessageConverter的容器HttpMessageConverters:

        @Bean
        @ConditionalOnMissingBean
        public HttpMessageConverters messageConverters(ObjectProvider<HttpMessageConverter<?>> converters) {
            return new HttpMessageConverters((Collection)converters.orderedStream().collect(Collectors.toList()));
        }
    

    我们可以直接拿来使用。那么到底怎么使用呢?那首先要搞清楚HttpInputMessageHttpOutputMessage是干什么用的。

    HttpInputMessage

    HttpInputMessage表示一个 HTTP 输入消息,由请求头headers和一个可读的请求体body组成,通常由服务器端的 HTTP 请求句柄或客户端的 HTTP 响应句柄实现。

    HttpInputMessage

    HttpServletRequestServletRequest的扩展接口,提供了HTTP Servlet的请求信息,也包含了请求头和请求体,所以两者是有联系的。我们只要找出两者之间的实际关系就能让HttpMessageConverter去读取并处理HttpServletRequest携带的请求信息。

    ServletServerHttpRequest

    说实话还真找到了:

    ServletServerHttpRequest

    ServletServerHttpRequest不仅仅是HttpInputMessage的实现,它还持有了一个HttpServletRequest实例属性,ServletServerHttpRequest的所有操作都是基于HttpServletRequest进行的。我们可以通过构造为其注入HttpServletRequest实例,这样HttpMessageConverter就能间接处理HttpServletRequest了。

    提取请求体实战

    这里聚焦的场景是在Servlet过滤器中使用HttpMessageConverter,在Spring MVC中不太建议去操作HttpServletRequest。我选择了FormHttpMessageConverter,它通常用来处理application/x-www-form-urlencoded请求。我们编写一个过滤器来拦截请求提取body

    /**
     * 处理 application/x-www-form-urlencoded 请求
     *
     * @author  felord.cn
     */
    
    @Component
    public class FormUrlencodedFilter implements Filter {
        private final FormHttpMessageConverter formHttpMessageConverter = new FormHttpMessageConverter();
        private static final Logger log = LoggerFactory.getLogger(FormUrlencodedFilter.class);
    
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException {
            String contentType = request.getContentType();
            MediaType type= StringUtils.hasText(contentType)? MediaType.valueOf(contentType):null;
            ServletServerHttpRequest serverHttpRequest = new ServletServerHttpRequest((HttpServletRequest) request);
            
            if (formHttpMessageConverter.canRead(MultiValueMap.class,type)) {
                MultiValueMap<String, String> read = formHttpMessageConverter.read(null, serverHttpRequest);
                 log.info("打印读取到的请求体:{}",read);
            }
        }
    }
    

    然后执行一个POST类型,Content-Typeapplication/x-www-form-urlencoded的请求:

    POST /ind HTTP/1.1
    Host: localhost:8080
    Content-Type: application/x-www-form-urlencoded
    Content-Length: 20
    
    a=b123&c=d123&e=f123
    

    控制台会打印:

    2021-12-30 6:43:56.409  INFO 12408 --- [nio-8080-exec-1] sfds: 打印读取到的请求体:{a=[b123], c=[d123], e=[f123]}
    

    ServletServerHttpResponse

    ServletServerHttpRequest就有ServletServerHttpResponse,大致原理差不多。它正好和ServletServerHttpRequest相反,如果我们需要去处理响应问题,比如想通过HttpServletResponse写个JSON响应,大概可以这么写:

    ServletServerHttpResponse servletServerHttpResponse = new ServletServerHttpResponse(response);
    // 使用json converter
    MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
    //  authentication 指的是需要写的对象实例
    mappingJackson2HttpMessageConverter.write(authentication, MediaType.APPLICATION_JSON,servletServerHttpResponse);
    

    总结

    HttpMessageConverter抽象了HTTP消息转换的策略,可以帮助我们优雅地处理一些请求响应的问题。不过有一点需要注意,请求体body只能读取一次,即使它包裹在ServletServerHttpRequest中,要注意和HttpServletRequestWrapper 的区别。

    关注公众号:Felordcn 获取更多资讯

    个人博客:https://felord.cn

    博主:码农小胖哥
    出处:felord.cn
    本文版权归原作者所有,不可商用,转载需要声明出处,否则保留追究法律责任的权利。如果文中有什么错误,欢迎指出。以免更多的人被误导。
  • 相关阅读:
    转载:c++内存泄露机制
    推荐一款不错的dialog小工具:artDialog
    写的一些推广方法 拿出来分享下
    struts2标签具体解释
    父亲节:再见,总有一天
    Hadoop是什么
    熊猫烟花集团完美见证异速联远程接入系统
    OpenStack Networking
    管道(Pipe)/createPipe
    百度2014校园招聘算法——给出一组数据A=[a_0, a_1, a-2, ... a_n](当中n可变),打印出该数值元素的全部组合。
  • 原文地址:https://www.cnblogs.com/felordcn/p/15753963.html
Copyright © 2011-2022 走看看