spring-boot使用AOP统一处理日志

新的项目，把之前用到的知识点总结一下。

有时候我们需要处理一些请求日志,或者对某些方法进行一些监控,这是就可以使用AOP（比如shiro中通常会加aop配置，以使用shiro认证注解（@RequiresPermissions、@RequiresRoles、@RequiresUser、@RequiresGuest））

1:pom.xml添加依赖:

<!--引用AOP-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2:添加工具类

注意：如果(WebControllerAop) 类不准备放在项目启动目录下,启动类组件扫描需要添加(WebControllerAop) 类所在的包路径

比如我的：@ComponentScan(basePackages="com.example.config")

package com.example.config;
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.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.util.Enumeration;
/**
 * @Description: 使用aop做统一请求日志
 */
@Aspect
@Component
public class WebControllerAop {
    private static final Logger log = LoggerFactory.getLogger(WebControllerAop.class);
    @Pointcut("execution(public * com.example.transfer.controller.*.*(..))")
    public void webLog() {
    }
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) {
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 记录下请求内容
        log.info("URL : " + request.getRequestURL().toString());
        log.info("HTTP_METHOD : " + request.getMethod());
        log.info("IP : " + request.getRemoteAddr());
        Enumeration<String> enu = request.getParameterNames();
        while (enu.hasMoreElements()) {
            String name = (String) enu.nextElement();
            log.info("name:{},value:{}", name, request.getParameter(name));
        }
    }
    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) {
        // 处理完请求，返回内容
        log.info("RESPONSE : " + ret);
    }
}

3:注释讲解

类注解:

@Aspect将一个类定义为一个切面类

@order(i)标记切面类的处理优先级,i值越小,优先级别越高.PS:可以注解类,也能注解到方法上

方法注解:

@Pointcut定义一个方法为切点里面的内容为一个表达式,下面详细介绍

@Before 在切点前执行方法,内容为指定的切点

@After 在切点后,return前执行,

@AfterReturning在切入点,return后执行,如果想对某些方法的返回参数进行处理,可以在这操作

@Around 环绕切点,在进入切点前,跟切点后执行

@AfterThrowing 在切点后抛出异常进行处理

@order(i) 标记切点的优先级,i越小,优先级越高

上面我们定义了一个切点

@Pointcut("execution(public * com.example.transfer.controller.*.*(..))")
   public void webLog() {
}

@Pointcut注解中的execution表达式:public * com.example.transfer.controller.*.*(..)

第一个 public 表示方法的修饰符,可以用*代替

第一个 * 表示返回值,*代表所有

com.example.transfer.controller.* 包路径,.*表示路径下的所有包

第三个.* 表示路径下,所有包下的所有类的方法

(..) 表示不限方法参数

如果我们要添加多个节点，

关于@order(i)注解的一些注意事项:

注解类,i值是,值越小,优先级越高

注解方法,分两种情况

注解的是 @Before 是i值越小,优先级越高

注解的是 @After或者@AfterReturning 中,i值越大,优先级越高

总结两者的概括就是:在切入点前的操作，按order的值由小到大执行；在切入点后的操作，按order的值由大到小执行

扩展

如果我要打印请求从进来,到结束,所需要的时间,怎么做：

1.定义一个成员变量（引用一个ThreadLocal指定泛型的对象）,用来统计时间

2.在@Before记录请求的时间,在@AfterReturning扣除记录的时间,就是消耗的时间

package com.example.config;
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.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.util.Enumeration;
/**
 * @Auther: 
 * @Date: 
 * @Description: 
 */
@Aspect
@Component
public class WebControllerAop {
    private static final Logger log = LoggerFactory.getLogger(WebControllerAop.class);
    ThreadLocal<Long> startTime = new ThreadLocal<Long>();
    @Pointcut("execution(public * com.example.transfer.controller.*.*(..))")
    public void webLog() {
    }
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) {
        startTime.set(System.currentTimeMillis());
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 记录下请求内容
        log.info("URL : " + request.getRequestURL().toString());
        log.info("HTTP_METHOD : " + request.getMethod());
        log.info("IP : " + request.getRemoteAddr());
        Enumeration<String> enu = request.getParameterNames();
        while (enu.hasMoreElements()) {
            String name = (String) enu.nextElement();
            log.info("name:{},value:{}", name, request.getParameter(name));
        }
    }
    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) {
        // 处理完请求，返回内容
        log.info("RESPONSE : " + ret);
        log.info("请求处理时间为:"+(System.currentTimeMillis() - startTime.get()));
    }
}

来源：oschina

链接：https://my.oschina.net/u/4416364/blog/4462551

标签

Spring Boot

shiro

java

around