controller输入输出参数打印

程序猿小蝌蚪黄小帅

已于 2024-02-01 14:50:15 修改

阅读量380

点赞数 4

文章标签： java 开发语言

于 2024-02-01 14:49:04 首次发布

本文链接：https://blog.csdn.net/weixin_38822255/article/details/135973979

版权

package com.XX.project.backend.printParam;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 *  @description:
 *  @author: 
 *  @create: 2023/9/26 15:31
 * 说明：在方法上添加@PrintParams注解即可
 * 方式1（默认同时打印入参和返回结果）：@PrintParams
 * 方式2（可选打印入参或返回结果），如打印入参但不打印返回结果：@PrintParams(requestParam = true,responseParam = false)
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface PrintParams {
    /**
     * 是否打印请求参数
     * @return
     */
    boolean requestParam() default true;

    /**
     * 是否打印返回结果
     * @return
     */
    boolean responseParam() default true;
}

package com.XX.project.backend.printParam;

import com.alibaba.fastjson.JSONObject;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;
import java.util.Arrays;

/**
 * @description:
 * @author: 
 * @create: 2023/9/26 15:31
 * restful接口请求参数打印切面
 * 说明：在方法上添加@PrintParams注解即可
 * 方式1（默认同时打印入参和返回结果）：@PrintParams
 * 方式2（可选打印入参或返回结果），如打印入参但不打印返回结果：@PrintParams(requestParam = true,responseParam = false)
 */
@Aspect
@Component
public class PrintParamsAspect {

    private static final Logger logger = LoggerFactory.getLogger(PrintParamsAspect.class);

    @Around(value = "@annotation(PrintParams)")
    public Object printParams(ProceedingJoinPoint joinPoint) throws Throwable {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        String methodName = method.getName();
        Object[] args = joinPoint.getArgs();
        String declaringTypeName = signature.getDeclaringTypeName();
        String methodFullPath = declaringTypeName+"."+method.getName();
        String[] paramNames = signature.getParameterNames();
        PrintParams printParams = method.getAnnotation(PrintParams.class);
        try {
            if(printParams.requestParam()){
                logger.info("调用接口{}，请求入参：参数名{}，参数值{}", methodFullPath, Arrays.toString(paramNames), Arrays.toString(args));
            }
        }catch (Exception e){
            logger.error("打印请求参数失败");
        }
        Object result = joinPoint.proceed();
        try {
            if(printParams.responseParam()){
                logger.info("调用接口{}，返回结果：{}", methodFullPath, JSONObject.toJSONString(result));
            }
        }catch (Exception e){
            logger.error("打印返回结果参数失败");
        }
        return result;
    }
}

应用