SpringAOP实现统一记录日志

在项目开发过程中，希望对业务进行记录日志。首先想到可以采用上文的统一处理异常的方式 @ControllerAdvice，但业务中，不但需要对异常进行记录日志，对一些普通的业务方法，也需要进行记录。其次，可以想到使用拦截器的方式，对所有方法进行拦截，记录日志，但拦截器是对Controller进行处理，对于一些Service甚至Dao层的方法，不能很好的记录日志。最后想到一种简单粗暴的方式，在所有业务方法中，添加记录日志的方法，这种方式可以解决问题，但这样无疑会造成业务方法和系统方法的耦合，当系统方法需要改变时，比如，之前是在执行业务方法前记录日志，现在需要改成在执行业务方法后记录日志，这样需要对所有方法进行修改，工作量巨大。因此，最终应该采用AOP，面向切面编程的方式统一记录日志，这样就提高了编程的效率。

AOP的术语

• Target: 一个个业务组件是需要处理的目标对象。
  *Joinpoint: 连接点，Target中运行织入到的位置，属性、构造器、成员方法…
• Aspect: 系统方法不直接写在Target中，而是封装在Aspect中，Aspect叫切面。
  *Pointcut: 切点， 最终织入到哪些Target的哪些位置。
  *Advice: 通知，实现具体的系统逻辑，具体织入什么，具体织入到哪里。
• Weaving: 将Aspect的代码织入到Target中，是Spring框架提供的功能。有不同的织入方式：1、编译时织入，需要使用特殊的编译器。2、装载时织入，需要使用特殊的类装载器。3、运行时织入，需要为目标生成代理对象。

AOP的实现

AspectJ（全面的解决方案）

*AspectJ是语言级的实现，它扩展了Java语言，定义了AOP语法。
*AspectJ在编译期织入代码，它有一个专门的编译器，用来生成遵守Java字节码规范的class文件。

Spring AOP（高性价比的解决方案）

*Spring AOP使用纯Java实现，它不需要专门的编译过程，也不需要特殊的类装载器。
*Spring AOP在运行时通过代理的方式织入代码，只支持方法类型的连接点。
*Spring支持对AspectJ的集成。

Spring AOP

JDK动态代理

• Java提供的动态代理技术，可以在运行时创建接口的代理实例。
• Spring AOP默认采用此种方式，在接口的代理实例中织入代码。

CGLib动态代理

• 采用底层的字节码技术，在运行时创建子类代理实例。
• 当目标对象不存在接口时，Spring AOP会采用此种方式，在子类实例中织入代码。

AOP代码实现

@Component
@Aspect
public class AspectClass {
	//对所有service包下的所有类的所有方法进行切面编程
    @Pointcut("execution(*.service.*.*(..))")
    public void pointcut() {

    }
	
	//在业务方法执行前加入的系统方法
    @Before("pointcut()")
    public void before() {
        System.out.println("before");
    }
	//在业务方法执行后加入的系统方法
    @After("pointcut()")
    public void after() {
        System.out.println("after");
    }
	//在业务方法得到返回值后加入的系统方法
    @AfterReturning("pointcut()")
    public void afterRetuning() {
        System.out.println("afterRetuning");
    }
	//在业务方法抛异常后加入的系统方法
    @AfterThrowing("pointcut()")
    public void afterThrowing() {
        System.out.println("afterThrowing");
    }
	//在业务方法执行前后均加入的系统方法
    @Around("pointcut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("around before");
        //执行业务方法
        Object obj = joinPoint.proceed();
        System.out.println("around after");
        return obj;
    }
}

统一记录日志

@Aspect
@Component
public class ServiceLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(ServiceLogAspect.class);

    @Pointcut("execution(*.service.*.*(..))")
    public void pointcut() {

    }

    @Before("pointcut()")
    public void before(JoinPoint joinPoint) {
        // 用户[ip],在[什么时刻],访问了[类名.方法名].
        /*
        	获取用户IP
        */
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        String ip = request.getRemoteHost();
        /*
        	获取时间
        */
        String now = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
        /*
        	获取 类名-方法名
        */
        String target = joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName();
        logger.info(String.format("用户[%s],在[%s],访问了[%s].", ip, now, target));
    }
}