7. Spring Boot 中使用切片

AOP为Aspect Oriented Programming的缩写，意为：面向切面编程，通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是Spring框架中的一个重要内容，它通过对既有程序定义一个切入点，然后在其前后切入不同的执行内容，比如常见的有：打开数据库连接/关闭数据库连接、打开事务/关闭事务、记录日志等。基于AOP不会破坏原来程序逻辑，因此它可以很好的对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

下面主要讲两个内容，一个是如何在Spring Boot中引入Aop功能，二是如何使用Aop做切面去统一处理Web请求的日志。

1. 添加依赖

在spring boot中通过其starter可以方便的引入aop的依赖，如下实例：

        
            org.springframework.boot
            spring-boot-starter-aop
        

2. 创建切面Component类

创建一个基本的日志切面类，需要包含以下的要点：

1. 添加@Aspect注解，声明是切片
2. 添加@Component注解，将其作为一个元素注入进去
3. 使用@Pointcut定义一个切入点，可以是一个规则表达式，比如下例中某个package下的所有函数
4. 根据需要在需要切片的地方切入内容

• 使用@Before在切入点开始处切入内容
• 使用@After在切入点结尾处切入内容
• 使用@AfterReturning在切入点return内容之后切入内容（可以用来对处理返回值做一些加工处理）
• 使用@Around在切入点前后切入内容，并自己控制何时执行切入点自身的内容
• 使用@AfterThrowing用来处理当切入内容部分抛出异常之后的处理逻辑

下面是一个标准的实例：

@Aspect
@Component
public class WebLogAspect {

    private Logger logger = Logger.getLogger(getClass());

    @Pointcut("execution(public * com.didispace.web..*.*(..))")
    public void webLog(){}

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 记录下请求内容
        logger.info("URL : " + request.getRequestURL().toString());
        logger.info("HTTP_METHOD : " + request.getMethod());
        logger.info("IP : " + request.getRemoteAddr());
        logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));

    }

    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 处理完请求，返回内容
        logger.info("RESPONSE : " + ret);
    }

}

可以看上面的例子，通过@Pointcut定义的切入点为com.didispace.web包下的所有函数（对web层所有请求处理做切入点），然后通过@Before实现，对请求内容的日志记录（本文只是说明过程，可以根据需要调整内容），最后通过@AfterReturning记录请求返回的对象。

通过运行程序并访问：http://localhost:8080/hello?name=didi，可以获得下面的日志输出

2016-05-19 13:42:13,156  INFO WebLogAspect:41 - URL : http://localhost:8080/hello
2016-05-19 13:42:13,156  INFO WebLogAspect:42 - HTTP_METHOD : http://localhost:8080/hello
2016-05-19 13:42:13,157  INFO WebLogAspect:43 - IP : 0:0:0:0:0:0:0:1
2016-05-19 13:42:13,160  INFO WebLogAspect:44 - CLASS_METHOD : com.didispace.web.HelloController.hello
2016-05-19 13:42:13,160  INFO WebLogAspect:45 - ARGS : [didi]
2016-05-19 13:42:13,170  INFO WebLogAspect:52 - RESPONSE:Hello didi

声明
部分内容来自互联网，参考文档

1. http://blog.didispace.com/springbootaoplog/

扩展：@PointCut详解

1. 匹配包/类型_ within()

1. 匹配 ProductService 类里头的所有方法

@Pointcut("within(com.zhb.service.ProductService)")

2. 匹配 com.zhb 包及子包下所有类的方法

@Pointcut("within(com.zhb..*)")

2. 匹配对象

1. 匹配AOP对象的目标对象为指定类型的方法，即 LogService 的 AOP 代理对象的方法

@Pointcut("this(com.zhb.log.Loggable)")

2. 匹配实现Loggable接口的目标对象(而不是 AOP 代理后的对象)的方法

@Pointcut("target(com.zhb.log.Loggable)")

• this 可以拦截 DeclareParents(Introduction)
• target 不拦截 DeclareParents(Introduction)

3. 匹配所有以Service结尾的bean里头的方法

@Pointcut("bean(*Service)")

3. 匹配参数 args()

1. 匹配任何以 find 开头而且只有一个Long 参数的方法

@Pointcut("execution(* ..find(Long))")

2. 匹配任何以 find 开头的而且第一个参数为 Long型的方法

@Pointcut("execution(* ..find(Long,..))")

3. 匹配任何只有一个Long参数的方法

@Pointcut("within(com.zhb..*) && args(Long)")

4. 匹配第一个参数为Long型的方法

@Pointcut("within(com.zhb..*) && args(Long,..)")

4. 匹配注解

1. 匹配方法标注有AdminOnly的注解的方法

@Pointcut("@annotation(com.zhb.anno.AdminOnly) && within(com.zhb..*)")

2. 匹配标注有NeedSecured的类底下的方法 //class级别

@Pointcut("@within(com.zhb.anno.NeedSecured) && within(com.zhb..*)")

3. 匹配标注有NeedSecured的类及其子类的方法 //runtime级别

在spring context的环境下,二者没有区别

@Pointcut("@target(com.zhb.anno.NeedSecured) && within(com.zhb..*)")

4. 匹配传入的参数类标注有Repository注解的方法

@Pointcut("@args(com.zhb.anno.NeedSecured) && within(com.zhb..*)")

5. 匹配方法

1. 匹配任何公共方法

@Pointcut("execution(public * com.zhb.service..(..))")

2. 匹配com.zhb包及子包下Service类中无参方法

@Pointcut("execution(* com.zhb..Service.())")

3. 匹配com.zhb包及子包下Service类中的任何只有一个参数的方法

@Pointcut("execution(* com.zhb..Service.(*))")

4. 匹配com.zhb包及子包下任何类的任何方法

@Pointcut("execution(* com.zhb...(..))")

5. 匹配com.zhb包及子包下返回值为String的任何方法

@Pointcut("execution(String com.zhb...(..))")

6. 匹配异常

execution(public * com.zhb.service..(..) throws java.lang.IllegalAccessException)