利用AOP与ToStringBuilder简化日志记录

刚学spring的时候书上就强调spring的核心就是ioc和aop blablabla......

IOC到处都能看到...AOP么刚开始接触的时候使用在声明式事务上面..当时书上还提到一个用到aop的例子.那就是用aop去简化日志记录.

当初有点疑问,如果这个日志是由aop来记录的,那记录的信息应该是很通用的,不是每个类定制的,那能记录一些什么信息呢?到底能有多详细的日志呢?

于是真正开始做项目的时候关注了一下公司到时是怎么做的.....

利用AOP记录关键方法的入参与返回

spring aop的语法我就不列举了,网上一大堆...公司主要用他记录Controller Facade 与 service等关键方法的入参与返回.

package com.labofjet.aspect;

import java.util.UUID;

import org.aspectj.lang.ProceedingJoinPoint;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public abstract class BaseLogAspect {

    private static final Logger LOGGER = LoggerFactory.getLogger(BaseLogAspect.class);

    protected Object doLog(ProceedingJoinPoint pjp, String type) throws Throwable {// NOSONAR
        UUID uuid = UUID.randomUUID();
        String signature = pjp.getSignature().toString();
        LOGGER.info("识别号[sequenceid:{}]: 调用{}方法: {}", uuid, type, signature);
        LOGGER.debug("识别号[sequenceid:{}]: 参数为 {}", uuid, pjp.getArgs());
        try {
            long start = System.currentTimeMillis();
            Object result = pjp.proceed();
            LOGGER.info("识别号[sequenceid:{}]: 调用{}方法: {} 成功! 返回 {}", uuid, type, signature, result);
            LOGGER.info("识别号[sequenceid:{}]: 调用消耗时间为[timecost:{}]", uuid, System.currentTimeMillis() - start);
            return result;
        }
        catch (Exception e) {
            LOGGER.error("识别号[sequenceid:{}]: 调用{}方法: {} 失败!", uuid, type, signature);
            LOGGER.error("识别号[sequenceid:{}]: 异常时输入为 {}", uuid, pjp.getArgs());
            LOGGER.error("识别号[sequenceid:{}]: 异常为: ", uuid, e);
            throw e;
        }
    }

}

上面这段代码是一个简化版本的日志记录类.利用AOP可以获取到ProceedingJoinPoint,用它可以获取到方法的签名,参数等信息,十分有用.

上面那个BaseLogAspect只是一个基础父类,描述了通用的记录方法...那具体要记录哪些类的方法的信息呢? 这就需要我们去写个子类定义具体的日志记录规则.

package com.labofjet.blogv3.aspect;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import com.labofjet.aspect.BaseLogAspect;

@Aspect
@Component
public class LogAspect extends BaseLogAspect {

    // private static final Logger LOGGER =
    // LoggerFactory.getLogger(LogAspect.class);

    @Around("within(@org.springframework.stereotype.Controller *)")
    public Object logController(ProceedingJoinPoint pjp) throws Throwable {
        return doLog(pjp, "Controller");
    }

    // @Around("execution(* gov.gt3.iitms.sbf..*Service.*(..))")
    public Object logService(ProceedingJoinPoint pjp) throws Throwable {
        return doLog(pjp, "Service");
    }

    // @Around("execution(* gov.gt3.iitms.sbf..*Facade.*(..))")
    public Object logFacade(ProceedingJoinPoint pjp) throws Throwable {
        return doLog(pjp, "Facade");
    }

}

这是一种实现,公司记录了controller,facade和service..利用的是around通知..我自己的代码比较简单,不需要这么多,我只需要记录controller的日志就行了,所以我注释掉了另外2个通知.

BaseLogAspect是通用的日志实现,它可以在不同的项目里公用,所以可以放到基础的依赖里去,每个独立的项目依赖这个BaseLogAspect然后实现自己的记录即可.

利用ToStringBuilder来简化参数记录

前面看到日志记录里会把调用方法的入参和结果打印出来...打印一个对象就是调用它的toString方法..如果这个方法不被重写...那么你懂得...完全和没打印差不了多少...

每个DTO,VO等对象都有非常非常多的属性,而且有时候还会不停的增加属性.写toString方法是一件很痛苦的事情(不过eclipse也有快捷键ctrl+alt+s再按s可以生成toString方法).因为要把对象的每个属性拼接起来,很容易错,而且很占用资源(因为String相加了很多次)比较好的做法是使用ToStringBuilder的reflectionToString方法.(ToStringBuilder是org.apache.commons.lang3下的一个类...)

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this);
    }

代码非常简短,而且以后修改对象属性也不需要修改toString方法.是不是很简单呢?

==========20170206补==========

eclipse里shift+alt+s然后再按s也可以快速生成toString方法