日志打印组件踩了Java反射的坑，真是一步一个脚印呢

烟雨平生

发布于 2023-09-05 11:29:44

2440

发布于 2023-09-05 11:29:44

文章被收录于专栏：数字化之路

报错了:

有同学反馈，他啥也没做，之前的一个老接口突然报错了，让帮忙看一下

"error": "Internal Server Error",

code:

@RestController
public class ReadyController {

    @GetMapping("/ready")
    String ready() {
        return "success";
    }

}

瞅了一眼代码，没有业务逻辑，用来做心跳检测用的，接口本身没有错。应该别有原因

本地复现

稳定复现：

Method method = clazz.getMethod(joinPoint.getSignature().getName(), parameterTypes);

看了下上面的code，发现没有使用public修饰符

原因已经搞清了： clazz.getMethod获取的方法没有使用public修饰符时，则会引发NoSuchMethodException异常。 解决办法： 方法1：ready方法增加public修饰符。这样clazz.getMethod就可以找到了

@RestController
public class ReadyController {

    @GetMapping("/ready")
    public String ready() {
        return "success";
    }

}

方法2： 使用能获取默认访问级别的api,譬如clazz.getDeclaredMethod()

    @Around("pointCut()")
    public Object logParameter(ProceedingJoinPoint joinPoint) throws Throwable {
        Class<?> clazz = joinPoint.getSignature().getDeclaringType();
        Class<?>[] parameterTypes = ((MethodSignature) joinPoint.getSignature()).getParameterTypes();
        Method method = clazz.getDeclaredMethod(joinPoint.getSignature().getName(), parameterTypes);
        if (!method.isAnnotationPresent(LogBizReqParameters.class)) {
            return joinPoint.proceed();
        }
        。。。
     }

方法3： 使用LogBizReqParameters.class作为切入点的筛选条件。

本次使用方法3。主要考虑到日志打印组件的高性能、作用域的合适性、可靠性。

小结： 出现异常的原因是：新增了日志打印组件，没有考虑到SpringMVC实际上是支持非public的方法提供api接口，直接使用了clazz.getMethod() 来获取类引了NoSuchMethodException异常。直接使用LogBizReqParameters.class作为切入点的筛选条件，可以减少不必要的筛选操作，提升性能。

更改后的请求参数打印效果：

com.tree.thrive.adapter.openapi.ReadyController#ready, Header THE_BIZ_FLAG:null, url : http://localhost/ready cost:0ms

code:

package com.tree.thrive.adapter.openapi.config.log;

import com.tree.thrive.adapter.openapi.config.log.annoation.LogBizReqParameters;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.Errors;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.util.Objects;

@Aspect
@Slf4j
@Configuration
public class LogParameterAspectV2 {

    @Value(("${custom.header.name:THE_BIZ_FLAG}"))
    private String customHeaderName;

    /**
     * 定义一个切入点：
     * 满足下面条件的，会走到特定逻辑：
     */
    @Around("@annotation(logBizReqParameters)")
    public Object logParameter(ProceedingJoinPoint joinPoint, LogBizReqParameters logBizReqParameters) throws Throwable {
        StringBuilder logResult = new StringBuilder();
        appendMethodParams(joinPoint, logResult);
        appendRequestParams(logResult);
        long start = System.currentTimeMillis();
        try {
            return joinPoint.proceed();
        } finally {
            logResult.append(" cost:").append(System.currentTimeMillis() - start).append("ms");
            log.info("{}", logResult);
        }
    }

    private void appendMethodParams(ProceedingJoinPoint joinPoint, StringBuilder logResult) {
        /**
         * 获取参数值
         */
        Object[] args = joinPoint.getArgs();
        /**
         * 获取到方法签名
         */
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        logResult.append(methodSignature.getDeclaringType().getName()).append("#").append(methodSignature.getName());
        /**
         * 获取方法参数名称
         */
        String[] parameterNames = methodSignature.getParameterNames();
        if (Objects.nonNull(parameterNames) && Objects.nonNull(args)
                && parameterNames.length > 0 && args.length > 0
                && parameterNames.length == args.length) {
            for (int i = 0; i < parameterNames.length; i++) {
                Object arg = args[i];
                if (Objects.nonNull(arg) &&
                        (arg instanceof ServletRequest ||
                                arg instanceof ServletResponse ||
                                arg instanceof HttpSession ||
                                arg instanceof Errors ||
                                arg instanceof WebRequest ||
                                arg instanceof MultipartFile
                        )) {
                    continue;
                }
                logResult.append(",").append("parameterNames[i]").append(":").append(arg);
            }
        }
    }

    private void appendRequestParams(StringBuilder logResult) {
        try {
            RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
            if (Objects.nonNull(requestAttributes)) {
                HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
                String theBizFlagVal = request.getHeader(customHeaderName);
                logResult.append(", Header ").append(customHeaderName).append(":").append(theBizFlagVal);
                logResult.append(", url : ").append(request.getRequestURL());
            }
        } catch (Exception ignored) {
        }
    }


}

https://gitee.com/baidumap/top-tree/blob/master/src/main/java/com/tree/thrive/adapter/openapi/config/log/LogParameterAspectV2.java

补充：

clazz.getMethod() 和 clazz.getDeclaredMethod()的区别：