SpingBoot日志切面（使用自定义注解打印日志）

 

使用Sping AOP切面打印日志时，为了不影响之前的代码，可以不拦截全部的controller层接口，而使用时注解的形式，在相应的接口方法加上日志注解，就可以打印请求参数和请求结果信息。

 

代码如下：

1.定义切面类

@Aspect
@Component
@Slf4j
public class LogAspect {

    private LogModel logModel;

    /**
     * 这里我们使用注解的形式
     * 当然，我们也可以通过切点表达式直接指定需要拦截的package,需要拦截的class 以及 method
     * 切点表达式:   execution(...)
     */
    @Pointcut("@annotation(com.zto.poseidon.datacenter.common.annotation.OperationLog)")
    public void restControllerLog() {
    }

    /**
     * 需要忽略的返回日志
     */
    @Pointcut("!@annotation(com.zto.poseidon.datacenter.common.annotation.IgnoreResponseLog)")
    public void ignoreResponseLog() {
    }

    @Before("restControllerLog()")
    public void exBefore(JoinPoint joinPoint) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        logModel = new LogModel();
        logModel.setUrl(request.getRequestURL().toString());
        logModel.setReqIp(request.getRemoteAddr());
        logModel.setStartTime(DateTime.now().toDate());
        logModel.setMethod(joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        try {
            logModel.setParams(getRequestParamsByJoinPoint(joinPoint));
            log.info("--------------请求参数日志------------");
            log.info(" ---> 请求参数 :{}", JSON.toJSONString(logModel));
        } catch (Exception e) {
            log.info("异常信息：{}", ExceptionUtils.getStackTrace(e));
        }
    }

    @After("restControllerLog()")
    public void exAfter(JoinPoint joinPoint) {
        log.info(" ---> request method:" + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName() + " 执行完毕!");
    }

    @AfterReturning(returning = "result", pointcut = "restControllerLog()  && ignoreResponseLog()")
    public void exAfterReturning(Object result) {
        log.info("--------------请求结果日志------------");
        log.info(" ---> 请求结果 :{}", JSON.toJSONString(result));
    }

    private Map<String, Object> getRequestParamsByJoinPoint(JoinPoint joinPoint) {
        //参数名
        String[] paramNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();
        //参数值
        Object[] paramValues = joinPoint.getArgs();
        return buildRequestParam(paramNames, paramValues);
    }

    private Map<String, Object> buildRequestParam(String[] paramNames, Object[] paramValues) {
        Map<String, Object> requestParams = new HashMap<>();
        for (int i = 0; i < paramNames.length; i++) {
            Object value = paramValues[i];
            //如果是文件对象
            if (value instanceof MultipartFile) {
                MultipartFile file = (MultipartFile) value;
                //获取文件名
                value = file.getOriginalFilename();
            }
            requestParams.put(paramNames[i], value);
        }
        return requestParams;
    }

    @Data
    public static class LogModel {

        private String url;

        private Date startTime;

        private Date endTime;

        private Long tookTime;

        private Object result;

        private String reqIp;

        private Boolean success = Boolean.FALSE;

        private String errMsg;

        private Object queryString;

        private String method;

        private Map<String, Object> params;

        private RuntimeException exception;

    }

}

 

2.添加自定义日志打印注解，打印入参和出参日志

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface OperationLog {
}

 

3.忽视请求结果日志打印注解

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface IgnoreResponseLog {
    boolean required() default true;
}

 

4.然后在需要打印的接口方法上添加 @OperationLog 注解就ok了

 

 自定义注解@OperationLog 注解定义了可以使用在类和方法上，但使用在类上不生效。

看官方文档解释：

 

 

 

//@Around("@annotation(自定义注解)")//自定义注解标注在方法上的方法执行aop方法
如：@Around("@annotation(org.springframework.transaction.annotation.Transactional)")

//@Around("@within(自定义注解)")//自定义注解标注在的类上；该类的所有方法（不包含子类方法）执行aop方法
如：@Around("@within(org.springframework.transaction.annotation.Transactional)")

//@Around("within(包名前缀.*)")//com.aop.within包下所有类的所有的方法都会执行(不包含子包) aop方法
如：@Around("within(com.aop.test.*)")

//@Around("within(包名前缀..*)")//com.aop.within包下所有的方法都会执行(包含子包)aop 方法
如：@Around("within(com.aop.test..*)")

//@Around("this(java类或接口)")//实现了该接口的类、继承该类、该类本身的类---的所有方法（包括不是接口定义的方法，但不包含父类的方法）都会执行aop方法
如：@Around("this(com.aop.service.TestService)")

//@Around("target(java类或接口)")//实现了该接口的类、继承该类、该类本身的类---的所有方法（包括不是接口定义的方法，包含父类的方法）
如：@Around("this(com.aop.service.TestService)")

//@Around("@target(自定义注解)")//springboot项目启动报如下错误，没有解决
// Caused by: java.lang.IllegalStateException:
// StandardEngine[Tomcat].StandardHost[localhost].TomcatEmbeddedContext[] failed to start

 

所以，如果想在类上使用自定义注解，需要将 LogAspect.class 切面类里的

@Pointcut("@annotation(com.zto.poseidon.datacenter.common.annotation.OperationLog)")
    public void restControllerLog() {
    }

改为：

@Pointcut("@within(com.zto.poseidon.datacenter.common.annotation.OperationLog)")
    public void restControllerLog() {
    }

 

这样就可以使用在类上了，但是我经过测试发现，改了之后只能用在类上，用在方法上就失效了，不能正常打印日志。暂时没找到原因，如果有找到原因的朋友，可以留言评论一下。