实现Web层的日志切面

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

• 使用@Aspect注解将一个java类定义为切面类
• 使用@Pointcut定义一个切入点，可以是一个规则表达式，比如下例中某个package下的所有函数，也可以是一个注解等。
• 根据需要在切入点不同位置的切入内容

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

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

  • 使用@AfterReturning在切入点return内容之后切入内容（可以用来对处理返回值做一些加工处理）

  • 使用@Around在切入点前后切入内容，并自己控制何时执行切入点自身的内容

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

package com.osvue.win.app.spr.aop;

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;

/**
 * 
 * @ClassName: LogAspect
 * @Description:TODO(这里用一句话描述这个类的作用)
 * @author: hzq
 * @date: 2022-7-27 10:35:59
 * @Copyright: 2022
 */
@Aspect
@Component
@Order(-5)
public class LogAspect {

 private Logger logger = LoggerFactory.getLogger(this.getClass());
 /*
  * 切点表达式 ~第一个 *代表任意修饰符及任意返回值.
  * 
  * ~第二个 *任意包名
  * 
  * ~第三个 *代表任意方法.
  * 
  * ~第四个 *定义在web包或者子包
  * 
  * ~第五个 *任意方法
  * 
  * ~ ..匹配任意数量的参数
  */

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

 @Before("webLog()")

 public void 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()")
 public void 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) 的内容

所以我们可以这样子总结：

在切入点前的操作，按order的值由小到大执行

在切入点后的操作，按order的值由大到小执行

在实际中order值可以设置为负值，确保是第一个进行执行的。