SpringBoot AOP获取@RequestBody参数

        项目中使用Spring Boot AOP做日志记录。当接口使用@RequestParam接收参数时,可以通过request.getParameterMap()来获得全部Parameter参数;

        而当接口使用@RequestBody接收参数时,用同样的方法获取参数会出现流已关闭的异常,这是因为Spring已经对@RequestBody提前进行处理,而HttpServletReqeust获取输入流时仅允许读取一次,所以会报java.io.IOException: Stream closed。

        解决思路:重新构建ServletRequest,读取输入流后进行缓存,然后重写进流里面,使请求输入流支持二次读取;


自定义HttpServletRequestWrapper,重新构建请求对象

import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
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.InputStreamReader;

public class RepeatedlyReadRequestWrapper extends HttpServletRequestWrapper {

    private final byte[] body;

    public RepeatedlyReadRequestWrapper(HttpServletRequest request)
            throws IOException {
        super(request);
        body = HttpHelper.readBytes(request.getReader(), "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 boolean isFinished() {
                return false;
            }

            @Override
            public boolean isReady() {
                return false;
            }

            @Override
            public void setReadListener(ReadListener listener) {

            }

            @Override
            public int read() throws IOException {
                return bais.read();
            }
        };
    }
}

自定义过滤器,用自定义的 ServletRequest 处理@RequestBody特殊请求

import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;


@Component
@WebFilter(urlPatterns = "/**", filterName = "ReqeustBodyFilter ")
public class ReqeustBodyFilter implements Filter {
    
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest req = (HttpServletRequest) request;
        String requestUri = URLUtil.getPath(req.getRequestURI());
        String method = req.getMethod();
        String contentType = request.getContentType();
        ServletRequest requestWrapper = null;
        if (request instanceof HttpServletRequest
                && !MediaType.MULTIPART_FORM_DATA_VALUE.equals(contentType)// 文件上传时不可以过滤器包装request,会报错Required request part 'file' is not present
        ) {
            if (HttpHelper.readBytes(request.getReader(), "utf-8") != null) {
                requestWrapper = new RepeatedlyReadRequestWrapper((HttpServletRequest) request);
            }
        }
        if (null == requestWrapper) {
            // 过滤器包装request不需要,将返回原来的request
            chain.doFilter(request, response);
        } else {
            // 过滤器包装request成功
            chain.doFilter(requestWrapper, response);
        }
    }

    @Override
    public void destroy() {
        LOGGER.info("----------初始化结束-------------");
    }    
}

HttpHelper工具类

import javax.servlet.ServletInputStream;
import javax.servlet.ServletRequest;
import java.io.*;
import java.nio.charset.Charset;


public class HttpHelper {

    public static String getBodyString(final ServletRequest request) {
        StringBuilder sb = new StringBuilder();
        InputStream inputStream = null;
        BufferedReader reader = null;
        try {
            inputStream = cloneInputStream(request.getInputStream());
            reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName("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: 复制输入流</br>
     *
     * @param inputStream
     *
     * @return</br>
     */
    public static InputStream cloneInputStream(ServletInputStream inputStream) {
        ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
        byte[] buffer = new byte[1024];
        int len;
        try {
            while ((len = inputStream.read(buffer)) > -1) {
                byteArrayOutputStream.write(buffer, 0, len);
            }
            byteArrayOutputStream.flush();
        } catch (IOException e) {
            e.printStackTrace();
        }
        InputStream byteArrayInputStream = new ByteArrayInputStream(byteArrayOutputStream.toByteArray());
        return byteArrayInputStream;
    }

    /**
     * 通过BufferedReader和字符编码集转换成byte数组
     * @param br
     * @param encoding
     * @return
     * @throws IOException
     */
    public static byte[] readBytes(BufferedReader br, String encoding) throws IOException{
        String str = null,retStr="";
        while ((str = br.readLine()) != null) {
            retStr += str;
        }
        if (org.apache.commons.lang3.StringUtils.isNotBlank(retStr)) {
            return retStr.getBytes(Charset.forName(encoding));
        }
        return null;
    }
}

日志切面获取@RequestBody参数

@Aspect
@Component
public class OperLogAspect {

    /**
     * 设置操作日志切入点 记录操作日志 在注解的位置切入代码
     * <功能详细描述>
     *
     * @see [类、类#方法、类#成员]
     */
    @Pointcut("@annotation(com.bw.dsm.config.aop.OperLog)")
    public void operLogPoinCut() {
    }

    /**
     * 设置操作异常切入点记录异常日志 扫描所有controller包下操作
     * <功能详细描述>
     *
     * @see [类、类#方法、类#成员]
     */
    @Pointcut("execution(* com.bw.dsm.controller..*.*(..))")
    public void operExceptionLogPoinCut() {
    }

    /**
     * 正常返回通知,拦截用户操作日志,连接点正常执行完成后执行, 如果连接点抛出异常,则不会执行
     * <功能详细描述>
     *
     * @param joinPoint,切片点
     * @param keys,返回值
     * @see [类、类#方法、类#成员]
     */
    @AfterReturning(value = "operLogPoinCut()", returning = "keys")
    public void saveOperLog(JoinPoint joinPoint, Object keys) {
    
        / 获取RequestAttributes
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        if (requestAttributes != null) {
            // 从获取RequestAttributes中获取HttpServletRequest的信息
            HttpServletRequest request = (HttpServletRequest) requestAttributes
                    .resolveReference(RequestAttributes.REFERENCE_REQUEST);
            if (request != null) {
                String params = HttpHelper.getBodyString(request);
                // ....
            }
        }
    }
}

  • 1
    点赞
  • 18
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
要在AOP获取`@RequestBody`的信息,可以使用`JoinPoint`参数和`MethodSignature`对象来获取方法的参数信息。然后,通过遍历参数注解数组,找到带有`@RequestBody`注解的参数,并获取相应的信息。 以下是一个示例代码: ```java @Aspect @Component public class RequestBodyAspect { @Before("execution(* com.example.controller.*.*(..))") public void logRequestBody(JoinPoint joinPoint) throws NoSuchMethodException { MethodSignature signature = (MethodSignature) joinPoint.getSignature(); String[] parameterNames = signature.getParameterNames(); Annotation[][] parameterAnnotations = signature.getMethod().getParameterAnnotations(); for (int i = 0; i < parameterAnnotations.length; i++) { for (Annotation annotation : parameterAnnotations[i]) { if (annotation instanceof RequestBody) { System.out.println("RequestBody parameter name: " + parameterNames[i]); // 获取参数类型 Class<?> parameterType = signature.getMethod().getParameterTypes()[i]; System.out.println("RequestBody parameter type: " + parameterType); // 其他操作... } } } } } ``` 在上述示例中,切面类`RequestBodyAspect`使用`@Before`注解标记了一个方法`logRequestBody`,该方法会在目标方法执行前执行。通过遍历参数注解数组,找到带有`@RequestBody`注解的参数,并获取参数的名称和类型。 请注意,由于`@RequestBody`注解通常用于接收请求体中的JSON或XML等数据,因此参数类型可能是自定义的POJO类或其他类型。您可以根据实际需要进行进一步操作,例如将请求体转换为对象或执行其他逻辑处理。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值