springCloud AOP功能实现

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

 

     由于须要对web请求作切面来记录日志，因此先引入web模块，并建立一个简单的hello请求的处理。

<dependency>

      <groupId>org.springframework.boot</groupId>

      <artifactId>spring-boot-starter-web</artifactId>

</dependency>

 

实现一个简单请求处理：

@RestController

publicclass HelloController {

   

    @RequestMapping("/hello")

    public String hello(String name,int state){

       return"name "+name+"---"+state;

    }

}

 

引入AOP依赖

<dependency>

      <groupId>org.springframework.boot</groupId>

      <artifactId>spring-boot-starter-aop</artifactId>

</dependency>

 

在完成了引入AOP依赖包后，通常来讲并不须要去作其余配置。也许在Spring中使用过注解配置方式的人会问是否须要在程序主类中增长@EnableAspectJAutoProxy来启用，实际并不须要。

能够看下面关于AOP的默认配置属性，其中spring.aop.auto属性默认是开启的，也就是说只要引入了AOP依赖后，默认已经增长了@EnableAspectJAutoProxy。

# AOP spring.aop.auto=true # Add @EnableAspectJAutoProxy.

spring.aop.proxy-target-class=false # Whether subclass-based (CGLIB) proxies are to be created (true) as opposed to standard Java interface-based proxies (false).

我在作测试的时候，以上两个配置我都没有进行使用，请自行进行测试。

       而当咱们须要使用CGLIB来实现AOP的时候，须要配置spring.aop.proxy-target-class=true，否则默认使用的是标准Java的实现。

 

实现Web层的日志切面

实现AOP的切面主要有如下几个要素：

使用@Aspect注解将一个java类定义为切面类

使用@Pointcut定义一个切入点，能够是一个规则表达式，好比下例中某个package下的全部函数，也能够是一个注解等。

根据须要在切入点不一样位置的切入内容

使用@Before在切入点开始处切入内容

使用@After在切入点结尾处切入内容

使用@AfterReturning在切入点return内容以后切入内容（能够用来对处理返回值作一些加工处理）

使用@Around在切入点先后切入内容，并本身控制什么时候执行切入点自身的内容

使用@AfterThrowing用来处理当切入内容部分抛出异常以后的处理逻辑

 

 

import java.util.Arrays;

import java.util.Enumeration;

import javax.servlet.http.HttpServletRequest;

import org.aspectj.lang.JoinPoint;

import org.aspectj.lang.annotation.AfterReturning;

import org.aspectj.lang.annotation.Aspect;

import org.aspectj.lang.annotation.Before;

import org.aspectj.lang.annotation.Pointcut;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.core.annotation.Order;

import org.springframework.stereotype.Component;

import org.springframework.web.context.request.RequestContextHolder;

import org.springframework.web.context.request.ServletRequestAttributes;

 

/**

 * 实现Web层的日志切面

 * @author 

 * @version v.0.1

 */

@Aspect

@Component

@Order(-5)

public class WebLogAspect {

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

   

    /**

     * 定义一个切入点.

     * 解释下：

     *

     * ~ 第一个 * 表明任意修饰符及任意返回值.

     * ~ 第二个 * 任意包名

     * ~ 第三个 * 表明任意方法.

     * ~ 第四个 * 定义在web包或者子包

     * ~ 第五个 * 任意方法

     * ~ .. 匹配任意数量的参数.

     */

     @Pointcut("execution(public * com.kfit.*.web..*.*(..))")

     publicvoid webLog(){}

     

     @Before("webLog()")

     publicvoid doBefore(JoinPoint joinPoint){

        

       // 接收到请求，记录请求内容

        logger.info("WebLogAspect.doBefore()");

        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()));

       //获取全部参数方法一：

        Enumeration<String> enu=request.getParameterNames(); 

        while(enu.hasMoreElements()){ 

            String paraName=(String)enu.nextElement(); 

            System.out.println(paraName+": "+request.getParameter(paraName)); 

        } 

     }

     

     @AfterReturning("webLog()")

     publicvoid  doAfterReturning(JoinPoint joinPoint){

       // 处理完请求，返回内容

        logger.info("WebLogAspect.doAfterReturning()");

     }

     

}

 

优化：AOP切面的优先级

       因为经过AOP实现，程序获得了很好的解耦，可是也会带来一些问题，好比：咱们可能会对Web层作多个切面，校验用户，校验头信息等等，这个时候常常会碰到切面的处理顺序问题。

       因此，咱们须要定义每一个切面的优先级，咱们须要@Order(i)注解来标识切面的优先级。i的值越小，优先级越高。假设咱们还有一个切面是CheckNameAspect用来校验name必须为didi，咱们为其设置@Order(10)，而上文中WebLogAspect设置为@Order(5)，因此WebLogAspect有更高的优先级，这个时候执行顺序是这样的：

在@Before中优先执行@Order(5)的内容，再执行@Order(10)的内容

在@After和@AfterReturning中优先执行@Order(10)的内容，再执行@Order(5)的内容

因此咱们能够这样子总结：