扫码关注官方微信

扫码下载APP
返回顶部
首页 > 资讯 > 后端开发 > Python >SpringBoot如何使用RequestBodyAdvice进行统一参数处理
  • 337

0
分享到

SpringBoot如何使用RequestBodyAdvice进行统一参数处理

2024-04-02 19:04:59 337人浏览 独家记忆

Python 官方文档：入门教程 => 点击学习

摘要

SpringBoot RequestBodyAdvice参数处理 在实际项目中 , 往往需要对请求参数做一些统一的操作 , 例如参数的过滤 , 字符的编码 , 第三方的解密等等 ,

SpringBoot RequestBodyAdvice参数处理

在实际项目中 , 往往需要对请求参数做一些统一的操作 , 例如参数的过滤 , 字符的编码 , 第三方的解密等等 , spring提供了RequestBodyAdvice一个全局的解决方案 , 免去了我们在Controller处理的繁琐 .

RequestBodyAdvice仅对使用了@RqestBody注解的生效 , 因为它原理上还是aop , 所以GET方法是不会操作的.


package com.xbz.common.WEB; 
import org.springframework.core.MethodParameter;
import org.springframework.Http.HttpHeaders;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.RequestBodyAdvice; 
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Type;
 

@ControllerAdvice(basePackages = "com.xbz.controller")//此处设置需要当前Advice执行的域 , 省略默认全局生效
public class GlobalRequestBodyAdvice implements RequestBodyAdvice {
 
 
    
    @Override
    public boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
//        return methodParameter.getMethod().isAnnotationPresent(XXapiReq.class);
        return false;
    }
 
    
    @Override
    public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException {
        return new XHttpInputMessage(inputMessage, "UTF-8");
    }
 
    
    @Override
    public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
        return inputMessage;
    }
 
    
    @Override
    public Object handleEmptyBody(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
        return body;
    }
}
 
//这里实现了HttpInputMessage 封装一个自己的HttpInputMessage
class XHttpInputMessage implements HttpInputMessage {
    private HttpHeaders headers;
    private InputStream body;
 
    public XHttpInputMessage(HttpInputMessage httpInputMessage, String encode) throws IOException {
        this.headers = httpInputMessage.getHeaders();
        this.body = encode(httpInputMessage.getBody(), encode);
    }
 
    private InputStream encode(InputStream body, String encode) {
        //省略对流进行编码的操作
        return body;
    }
 
    @Override
    public InputStream getBody() {
        return body;
    }
 
    @Override
    public HttpHeaders getHeaders() {
        return null;
    }
}

Spring默认提供了接口的抽象实现类RequestBodyAdviceAdapter , 我们可以继承这个类按需实现 , 让代码更简洁一点


package org.springframework.web.servlet.mvc.method.annotation; 
import java.io.IOException;
import java.lang.reflect.Type; 
import org.springframework.core.MethodParameter;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.lang.Nullable; 
public abstract class RequestBodyAdviceAdapter implements RequestBodyAdvice {
 
	@Override
	public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter,
			Type targetType, Class<? extends HttpMessageConverter<?>> converterType)
			throws IOException { 
		return inputMessage;
	} 
 
	@Override
	public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter,
			Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
 
		return body;
	}
  
	@Override
	@Nullable
	public Object handleEmptyBody(@Nullable Object body, HttpInputMessage inputMessage,
			MethodParameter parameter, Type targetType,
			Class<? extends HttpMessageConverter<?>> converterType) { 
		return body;
	}
}

Springboot 对RequestBody的值进行统一修改的几种方式

背景

最近在项目中遇到需要统一对Request请求中的某一个自定义对象的属性进行统一修改的需求。

考虑了几种实现方式，现在记录一下。由于原项目过于复杂，自己写几个demo进行记录。

解决方式

在这里插入图片描述

方式一：利用filter进行处理

大坑：

​ 如果你想要改变加了RequestBody注解的数据，无论如何你都要通过getInputStream()方法来获取流来拿到对应的参数，然后更改。在不经过拿取流的情况下，spring的RequestBody注解也是通过getInputStream()方法来获取流来映射为request对象。

但是如果你想要的统一的进行修改，也必须经过getInputStream()来首先拿到stream然后才能进行修改。但此时stream被消费之后，就会关闭。

然后你的controller中的参数就拿不到对象，报错如下。

I/O error while reading input message; nested exception is java.io.IOException: Stream closed

可以通过创建并使用自定义的的httpservletRequestWrapper来避免这种情况。

步骤一：编写自定义HttpServletRequestWrapper 


package com.example.testlhf.filter;
import com.alibaba.fastJSON.jsON;
import com.alibaba.fastjson.JSONObject;
import com.example.testlhf.entity.Student;
import lombok.extern.slf4j.Slf4j;
import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.NIO.charset.Charset;

@Slf4j
public class ChangeStudentNameRequestWrapper extends HttpServletRequestWrapper {
    
    private byte[] body;
    public ChangeStudentNameRequestWrapper(HttpServletRequest request) throws IOException {
        super(request);
        //接下来的request使用这个
        String bodyStr = getBodyString(request);
        body = bodyStr.getBytes(Charset.defaultCharset());
    }
    
    public String getBodyString(final ServletRequest request) {
        try {
            return inputStream2String(request.getInputStream());
        } catch (IOException e) {
            log.error("", e);
            throw new RuntimeException(e);
        }
    }
    
    public String getBodyString() {
        final InputStream inputStream = new ByteArrayInputStream(body);
        return inputStream2String(inputStream);
    }
    
    private String inputStream2String(InputStream inputStream) {
        StringBuilder sb = new StringBuilder();
        BufferedReader reader = null;
        try {
            reader = new BufferedReader(new InputStreamReader(inputStream, Charset.defaultCharset()));
            String line;
            while ((line = reader.readLine()) != null) {
                sb.append(line);
            }
        } catch (IOException e) {
            log.error("", e);
            throw new RuntimeException(e);
        } finally {
            if (reader != null) {
                try {
                    reader.close();
                } catch (IOException e) {
                    log.error("", e);
                }
            }
        }
        JSONObject jsonObject = JSONObject.parseObject(sb.toString());
        if (jsonObject != null && jsonObject.get("student") != null) {
            Student student = JSON.toJavaObject((JSON) jsonObject.get("student"), Student.class);
            log.info("修改之前的学生名称为：" + student.getName());
            student.setName("amd");
            jsonObject.put("student", student);
            return jsonObject.toJSONString();
        }
        return sb.toString();
    }
    @Override
    public BufferedReader getReader() throws IOException {
        return new BufferedReader(new InputStreamReader(getInputStream()));
    }
    @Override
    public ServletInputStream getInputStream() throws IOException {
        final ByteArrayInputStream inputStream = new ByteArrayInputStream(body);
        return new ServletInputStream() {
            @Override
            public int read() throws IOException {
                return inputStream.read();
            }
            @Override
            public boolean isFinished() {
                return false;
            }
            @Override
            public boolean isReady() {
                return false;
            }
            @Override
            public void setReadListener(ReadListener readListener) {
            }
        };
    }
}

步骤二：使用自定义的HttpServletRequestWrapper取代原有的

使用自定义的request取代原有的传递给过滤器链。


package com.example.testlhf.filter;
import lombok.extern.slf4j.Slf4j;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

@Slf4j
public class ReplaceStreamFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("StreamFilter初始化...");
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        ServletRequest requestWrapper = null;
         //获取请求中的流，将取出来的字符串，再次转换成流，然后把它放入到新request对象中,
        if (request instanceof HttpServletRequest) {
            requestWrapper = new ChangeStudentNameRequestWrapper((HttpServletRequest) request);
        }
        // 在chain.doFiler方法中传递新的request对象
        if (requestWrapper == null) {
            chain.doFilter(request, response);
        } else {
            chain.doFilter(requestWrapper, response);
        }
    }
    @Override
    public void destroy() {
        log.info("StreamFilter销毁...");
    }
}

步骤三：将过滤器注册进spring容器 


package com.example.testlhf.filter;
import org.springframework.boot.web.servlet.FilterReGIStrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.servlet.Filter;

@Configuration
public class MyFilterConfig {
    
    @Bean
    public FilterRegistrationBean someFilterRegistration() {
        FilterRegistrationBean<Filter> registration = new FilterRegistrationBean<>();
        registration.setFilter(replaceStreamFilter());
        registration.addUrlPatterns("
    @Bean(name = "replaceStreamFilter")
    public Filter replaceStreamFilter() {
        return new ReplaceStreamFilter();
    }
}

看下效果：

到此使用过滤器对post请求中的参数的修改已经完毕。

方式二：使用拦截器进行处理

当我自以为可以使用拦截器前置通知进行处理时才发现，事情并不简单。

步骤一：自定义一个拦截器

如下图实现一个拦截器，preHandle中有HttpServletRequest request参数，虽然可以通过它的流获取到body中数据，但是如果将body中数据进行修改的话，其并不能传递给controller。因为request只有两个set方法。如果将要统一修改的值摄入Attribute，则还仍需从controller中拿到

步骤二：在controller中获取值

虽然用这种方式可以在request中添加统一的参数，也可以从每一个controller中获取值，但仍需要对每一个controller进行代码修改，显然这种方式并不是我们需要的。

方式三：使用切面处理

步骤一：引入aspect所需要使用的maven依赖 


        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>5.1.3.RELEASE</version>
        </dependency>

步骤二：编写自定义的前置通知以及表达 


@Component
@Aspect
public class ChangeStudentNameAdvice {
    @Before("execution(* com.example.testlhf.service.impl.*.*(..))&&args(addStudentRequset)")
    public void aroundPoints(AddStudentRequset addStudentRequset) {
        addStudentRequset.getStudent().setName("amd");
    }
}

注意此处的形参需要和args括号内的字符串保持一致，否则报错。

注意此处的形参需要和args括号内的字符串保持一致，否则报错。

步骤三：开启注解@EnableAspectJAutoProxy

在这里插入图片描述

总结：

首先说下filter和interceptor的区别：两者之间的所依赖的环境不一致，filter作为javaweb三大组件之一，其作用为：拦截请求，以及过滤相应。其依赖于servlet容器。但interceptor依赖于web框架，例如springMVC框架。最常见的面向切面编程AOP所使用的动态代理模式，即是使用拦截器在service方法执行前或者执行后进行一些操作。他们都可以适用于如下的场景：权限检查，日志记录，事务管理等等。当然包括，对所有的请求某些参数进行统一的修改。

比较三种方式，方式一和方式二所谓的拦截基本都是基于对http请求的拦截，filter执行在interceptor之前。虽然filter和interceptor都有类似链这种概念，但filter可以将request请求修改之后传递给后面的filter，就像电路中的串联，而interceptor的链是独立的，修改其中一个request并不会影响其他的interceptor，类似并联，不能做到只修改一处其他不用修改的方式。

简单来说方式一和方式二针对进入controller进行拦截，而后做一些操作。方式三使用的拦截的理念是针对业务方法的，在执行业务方法的前面对参数进行修改，和spring中对事务控制的实现方式类似。

思考：

虽然第一，第三种方式都可以在技术上实现针对某些方法进行统一的参数修改。但是如果将项目当做一个工程来思考的话，不同于日志打印或者事务控制这种非业务逻辑的处理，这种统一修改某些参数来完成一些操作，已严重入侵了业务逻辑。

真正的解决方式要么在请求的源头就做好参数设置，要么通过配置文件在需要使用的地方来进行某些参数的赋值。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程网。

您可能感兴趣的文档:

--结束END--

本文标题: SpringBoot如何使用RequestBodyAdvice进行统一参数处理

本文链接: https://lsjlt.com/news/129363.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • SpringBoot如何使用RequestBodyAdvice进行统一参数处理
    SpringBoot RequestBodyAdvice参数处理 在实际项目中 , 往往需要对请求参数做一些统一的操作 , 例如参数的过滤 , 字符的编码 , 第三方的解密等等 , ...
    99+
    2024-04-02
  • SpringBoot中如何进行统一异常处理
    目录1、处理前2、进行系统异常全局处理3、进行自定义异常处理总结如何在SpringBoot项目里进行统一异常处理 需要了解的知识 @ControllerAdvice的作用 1、处理前...
    99+
    2024-04-02
  • 如何在SpringBoot项目里进行统一异常处理
    目录1、处理前2、进行系统异常全局处理3、进行自定义异常处理效果前言： 需要了解的知识： @ControllerAdvice的作用 1、处理前 异常代码： @ApiOperatio...
    99+
    2024-04-02
  • SpringBoot怎么进行统一异常处理
    这篇文章主要介绍“SpringBoot怎么进行统一异常处理”的相关知识，小编通过实际案例向大家展示操作过程，操作方法简单快捷，实用性强，希望这篇“SpringBoot怎么进行统一异常处理”文章能帮助大家解决问题。1、处理前异常代码@ApiO...
    99+
    2023-06-29
  • Springboot如何使用filter对requestbody参数进行校验
    目录使用filter对request body参数进行校验通过filter修改body参数的思路知识点步骤使用filter对request body参数进行校验 @Slf4j pub...
    99+
    2024-04-02
  • SpringBoot接口如何对参数进行校验
    目录前言什么是不优雅的参数校验实现案例POM请求参数封装Controller中获取参数绑定结果校验结果进一步理解Validation分组校验？@Validate和@Valid什么区别...
    99+
    2024-04-02
  • 如何使用批处理参数
    这篇文章给大家分享的是有关如何使用批处理参数的内容。小编觉得挺实用的，因此分享给大家做个参考，一起跟随小编过来看看吧。可以在批处理文件内的任何地方使用批处理参数，以提取有关环境设置的信息。 Cmd.exe 提供批处理参数扩展变量（...
    99+
    2023-06-09
  • 如何进行处理Python对象参数的解析
    这期内容当中小编将会给大家带来有关如何进行处理Python对象参数的解析，文章内容丰富且以专业的角度为大家分析和叙述，阅读完这篇文章希望大家可以有所收获。在Python对象中使用C语言编写的扩展模块，必须将其编译成动态链接库的形式，通常使用...
    99+
    2023-06-17
  • SpringBoot如何进行参数校验实例详解
    目录前言为什么需要参数校验SpringBoot中集成参数校验第一步，引入依赖第二步，定义要参数校验的实体类第三步，定义校验类进行测试第四步，体验效果参数异常加入全局异常处理器体验效果...
    99+
    2024-04-02
  • PHP 中如何使用数组进行数据处理？
    PHP是一种广泛应用于Web开发的脚本语言。在PHP中，数组是一种非常重要的数据结构，用于存储和处理大量数据。数组提供了一种方便的方式来组织和访问数据，使得数据处理变得更加容易和高效。在本文中，我们将介绍PHP中如何使用数组进行数据处理，希...
    99+
    2023-10-24
    数组 unix numpy
  • 如何使用 PHP 函数进行数据预处理？
    php 数据预处理函数可用于进行类型转换、数据清理、日期和时间处理。具体来说，类型转换函数允许变量类型转换（例如 int、float、string）；数据清理函数可删除或替换无效数据（如...
    99+
    2024-05-02
    数据预处理 php 函数
  • 如何进行SpringBoot开发的集成参数校验
    这期内容当中小编将会给大家带来有关如何进行SpringBoot开发的集成参数校验，文章内容丰富且以专业的角度为大家分析和叙述，阅读完这篇文章希望大家可以有所收获。对于 web服务来说，为防止非法参数对业务造...
    99+
    2024-04-02
  • 如何使用NumPy进行高效的数据处理？
    NumPy是Python科学计算的核心库，它提供了一系列高效的数据结构和算法，能够大大简化数据处理和分析的过程。在本文中，我们将介绍如何使用NumPy进行高效的数据处理。 安装NumPy 在开始使用NumPy之前，需要先安装它。可以使用...
    99+
    2023-06-17
    教程 编程算法 numy
  • 如何使用Go语言进行大数据处理？
    使用Go语言进行大数据处理的方法有安装Go语言环境、编写数据处理程序、读取和处理数据、并发处理、写入输出结果等。详细介绍：1、安装Go语言环境：首先，需要在你的计算机上安装Go语言环境。可以从Go官方网站下载并安装适合你操作系统的版本；2、...
    99+
    2023-12-21
    go语言 大数据处理
  • 如何使用@Valid+BindingResult进行controller参数校验
    这篇文章主要介绍“如何使用@Valid+BindingResult进行controller参数校验”，在日常操作中，相信很多人在如何使用@Valid+BindingResult进行controller参数校验问题上存在疑惑，小编查阅了各式资...
    99+
    2023-06-21
  • SpringBoot接口如何统一异常处理
    目录为什么要优雅的处理异常实现案例@ControllerAdvice异常统一处理Controller接口运行测试进一步理解@ControllerAdvice还可以怎么用？@Contr...
    99+
    2024-04-02
  • SpringBoot如何实现统一异常处理
    这篇文章将为大家详细讲解有关SpringBoot如何实现统一异常处理，文章内容质量较高，因此小编分享给大家做个参考，希望大家阅读完这篇文章后对相关知识有一定的了解。1.介绍在日常开发中发生了异常，往往是需要通过一个统一的异常处理处理所有异常...
    99+
    2023-05-31
    springboot 统一异常 异常处理
  • SpringBoot统一处理功能如何实现
    本文小编为大家详细介绍“SpringBoot统一处理功能如何实现”，内容详细，步骤清晰，细节处理妥当，希望这篇“SpringBoot统一处理功能如何实现”文章能帮助大家解决疑惑，下面跟着小编的思路慢慢深入，一起来学习新知识吧。在处理网络请求...
    99+
    2023-07-05
  • 如何使用PHP进行视频处理？
    随着网络技术的飞速发展，视频已经成为人们日常生活中不可或缺的一部分。在这个数字时代，如何使用PHP进行视频处理已经成为了一个热门话题，本文将介绍PHP的一些基本功能和工具，以帮助大家更好地处理视频。一、认识PHPPHP是一种高级程序设计语言...
    99+
    2023-05-22
    PHP 视频处理 多媒体应用
  • 使用Rest如何对API进行处理
    这篇文章给大家介绍使用Rest如何对API进行处理，内容非常详细，感兴趣的小伙伴们可以参考借鉴，希望对大家能有所帮助。一、项目目标动静分离的架构，即客户端和服务器端的分离，客户端可以是IOS、android或者静态的页面。需要服务器端提供w...
    99+
    2023-05-31
    rest api
软考高级职称资格查询
热门wiki
近期文章
推荐阅读
热门问答
热门标签
编程网，编程工程师的家园，是目前国内优秀的开源技术社区之一，形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容，为IT开发者提供了一个发现、使用、并交流开源技术的平台。

  • 官方手机版

  • 微信公众号

  • 商务合作