Spring AOP 的日志管理实现

在学习Spring框架的历程中，最重要的是要理解Spring的IOC和AOP了，不但要学会怎么用，最好是知道它是怎么实现的，经过这个国庆假期，好好地过了一下spring的AOP的皮毛，故记录一下学习心得。

1、为何须要AOP

假如咱们应用中有n个业务逻辑组件，每一个业务逻辑组件又有m个方法，那如今咱们的应用就一共包含了n*m个方法，我会抱怨方法太多。。。如今，我有这样一个需求，每一个方法都增长一个通用的功能，常见的如：事务处理，日志，权限控制。。。最容易想到的方法，先定义一个额外的方法，实现该功能，而后再每一个须要实现这个功能的地方去调用这个额外的方法。这种作法的好处和坏处分别是。
好处：能够动态地添加和删除在切面上的逻辑而不影响原来的执行代码。
坏处：一旦要修改，就要打开全部调用到的地方去修改。
好，如今咱们用AOP的方式能够实如今不修改源方法代码的前提下，能够统一为原多个方法增长横切性质的“通用处理”。

2、什么是AOP

都说AOP好用，那如今咱们来谈谈什么是AOP。

AOP（Aspect-OrientedProgramming，面向方面编程），能够说是OOP（Object-Oriented Programing，面向对象编程）的补充和完善。本文提供Spring官方文档出处：Aspect Oriented Programming with Spring

从官方文档上摘抄的解释就是：面向方面编程（AOP）是面向对象编程（OOP）补充的另外一种提供思考程序结构补充。在OOP中模块化的关键单元是类，而在AOP模块的单位是一个方面。面对关注点，如事务管理跨越多个类型和对象切模块化。（这些关注常常被称为在AOP文学横切关注点。）

相关概念（只需作个大概的了解就好）----来自于官方文档直译（本人英文水平有限。。。）：

Aspect：这横切多个对象关心的模块化。事务管理是企业Java应用程序的横切关注点的一个很好的例子。在Spring AOP中，切面可使用类（基于模式）或@Aspect注解（@AspectJ风格）注解普通班实施。
Join point：程序在执行过程当中的一个点，如方法的执行或异常的处理。在Spring AOP中，一个链接点老是表明一个方法的执行。
Advice：在切面的某个特定的动做链接点。不一样类型的意见，包括 "around," "before" and "after"的advice。 （通知的类型将在下面讨论）。许多AOP框架，包括Spring都是以拦截器做为通知模型，去维护一条围绕着一个链接点的拦截器链。
Pointcut：匹配链接点的断言。通知是跟一个切入点表达式，并在运行在切入点匹配的链接点相关联（例如，一个方法的执行要有一个肯定的名字）。切入点表达式做为匹配的链接点的概念是重要的对AOP和Spring缺省使用AspectJ切入点表达式语言。
Introduction：声明表明的类型的额外的方法或字段。 Spring容许引入新的接口（以及一个对应的实现）到任何被代理的对象。例如，你可使用引入来使一个bean实现IsModified接口，以便简化缓存。 （介绍被誉为AspectJ的社会类型间的声明。）
Target object：对象由一个或多个方面被建议。也被称做被通知对象。既然Spring AOP是经过运行时代理实现的，这个对象永远是一个被代理对象。
AOP proxy：AOP框架，以实现切面契约（例如通知方法执行等等）建立的对象。在Spring中，AOP代理能够是JDK动态代理或者CGLIB代理。
Weaving：与链接其余应用程序类型或对象方面来建立一个被通知的对象。这是能够作到在编译时（使用AspectJ编译器，例如），加载时间，或在运行时。 Spring AOP中，像其余纯Java AOP框架，在运行时进行编织。

以上概念我的感受在作实验的时候就差很少理解了，不须要咬文嚼字地区啃。

那问题来了，AOP是在何时去改咱们的代码的？即给咱们加上额外的横切性质的"通用处理"的？

两个时机：

1.在编译java源代码的时候 ----编译时加强
2.在运行时动态地修改类 ----运行时加强（动态代理）

咱们的Spring的AOP的实现原理就是基于动态代理。（以后我会尝试一下跟随源码看看Spring在AOP方面作了哪些事情）

3、Spring AOP的3种实现方式

对于框架的学习，我以为得先会用，而后再深刻原理。关于Spring AOP的实现我在这里划分红3个方式（以日志管理为例）废话很少说，直接上代码了。（如下代码是基于我以前所写的SSM框架整合的例子，若是有须要可查看我以前的博客）

配置以前注意配置文件要加上命名空间：xmlns:aop="http://www.springframework.org/schema/aop"

1.基于xml配置的实现

spring-mvc.xml

<!-- 使用xml配置aop -->  
<!-- 强制使用cglib代理，若是不设置，将默认使用jdk的代理，可是jdk的代理是基于接口的 -->  
<aop:config proxy-target-class="true" />    
<aop:config>  
<!--定义切面-->  
    <aop:aspect id="logAspect" ref="logInterceptor">  
    <!-- 定义切入点 (配置在com.gray.user.controller下全部的类在调用以前都会被拦截)-->  
    <aop:pointcut expression="execution(* com.gray.user.controller.*.*(..))" id="logPointCut"/>  
    <!--方法执行以前被调用执行的-->  
    <aop:before method="before" pointcut-ref="logPointCut"/><!--一个切入点的引用-->  
    <aop:after method="after" pointcut-ref="logPointCut"/><!--一个切入点的引用-->  
    </aop:aspect>  
</aop:config>

 LogInterceptor.java

package com.gray.interceptor;  
  
import org.springframework.stereotype.Component;  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
  
@Component  
public class LogInterceptor {  
    private final Logger logger = LoggerFactory.getLogger(LogInterceptor.class);  
    public void before(){  
        logger.info("login start!");  
    }  
      
    public void after(){  
        logger.info("login end!");  
    }  
}

在这里我没有配bean是由于我在以前的配置文件里面写了自动扫描组件的配置了
要加入日志管理逻辑的地方

@RequestMapping("/dologin.do") //url  
public String dologin(User user, Model model){  
    logger.info("login ....");  
    String info = loginUser(user);  
    if (!"SUCC".equals(info)) {  
        model.addAttribute("failMsg", "用户不存在或密码错误！");  
        return "/jsp/fail";  
    }else{  
        model.addAttribute("successMsg", "登录成功！");//返回到页面说夹带的参数  
        model.addAttribute("name", user.getUsername());  
        return "/jsp/success";//返回的页面  
    }  
  }

结果截图：

2.基于注解的实现

spring-mvc.xml

<aop:aspectj-autoproxy proxy-target-class="true">  
</aop:aspectj-autoproxy>

LogInterceptor.java

@Aspect  
@Component  
public class LogInterceptor {  
    private final Logger logger = LoggerFactory.getLogger(LogInterceptor.class);  
    @Before(value = "execution(* com.gray.user.controller.*.*(..))")  
    public void before(){  
        logger.info("login start!");  
    }  
    @After(value = "execution(* com.gray.user.controller.*.*(..))")  
    public void after(){  
        logger.info("login end!");  
    }  
}

要加入逻辑的地方同上。

结果截图：

3.基于自定义注解的实现

基于注解，因此spring-mvc.xml也是和上面的同样的。

首先自定义注释类  LogAnnotation

package com.controller.annote;


import java.lang.annotation.*;

@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)  
@Documented 
public @interface LogAnnotation {
	String note() default "";
}

加入切面类 LogInterceptor.java

package com.gray.interceptor;  
  
import java.lang.reflect.Method;  
  
import org.aspectj.lang.JoinPoint;  
import org.aspectj.lang.annotation.Aspect;  
import org.aspectj.lang.annotation.Before;  
import org.aspectj.lang.annotation.Pointcut;  
import org.aspectj.lang.reflect.MethodSignature;  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
import org.springframework.stereotype.Component;  
  
import com.gray.annotation.Log;  
  
@Aspect  
@Component  
public class LogInterceptor {  
    private final Logger logger = LoggerFactory.getLogger(LogInterceptor.class);  
  
    @Pointcut("@annotation(logAnnotation)")      
    public void controllerAspect(LogAnnotation logAnnotation) {  
          
    }  
    @Before("controllerAspect(logAnnotation)")  
    public void before(LogAnnotation logAnnotation){  
        logger.info("自定义日志" + logAnnotation.note());  
    }
}

同时，在须要开启日志的地方加入自定义注释类

@RequestMapping("/login")   
@LogAnnotation(note="login action")  
public String dologin(User user, Model model){  
    logger.info("login ....");  
    String info = loginUser(user);  
    if (!"SUCC".equals(info)) {  
        model.addAttribute("failMsg", "用户不存在或密码错误！");  
        return "/jsp/fail";  
    }else{  
        model.addAttribute("successMsg", "登录成功！");//返回到页面说夹带的参数  
        model.addAttribute("name", user.getUsername());  
        return "/jsp/success";//返回的页面  
    }  
  }

输入结果顺序：

    自定义日志 login action 

    login ....

以上就是我总结的SpringAOP的3种实现方式，对于这我还有点话要说，常见的基于注解的方式除了before和after，还有around和AfterThrowing等，在作第三种方式实验的时候还遇到这种错误：error at ::0 can't find referenced pointcut。

个人解决办法是：由于个人jdk是1.7，与原来在pom.xml中配的那个aspectjweaver的jar包版本不匹配，因此我须要升级，由1.5.4改为1.7.4。

此外多说一句，对于日志，权限等业务逻辑不少人其实也喜欢用拦截器来实现的。