Spring AOP 应用场景之--日志收集（含代码）

在学习了 Spring AOP 知识之后，只了解了其一些基本的概念。比如它是为了解决 OOP 的弊端，使代码更易于维护；使用了动态代理，Spring 中有两种动态代理实现方式，一种是 JDK，一种是Cglib；使用场景有权限、缓存、日志、balabala…

但是并不清楚其具体使用。最近看了一些代码，正好记录一下( •̀ ω •́ )✧。

让我们正式开始。

什么是 AOP

面向切面编程，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

一些重要名词：

切面（Aspect）：横切关注点被模块化的特殊对象。即，它是一个类。
通知（Advice）：切面必须要完成的工作。即，它是类中的一个方法。
目标（Target）：被通知对象。
代理（Proxy）：向目标对象应用通知之后创建的对象。
切入点（PointCut）：切面通知执行的 “地点”的定义。
连接点（JointPoint）：与切入点匹配的执行点。

Spring AOP 支持的五种通知：

@Before: 前置通知, 在方法执行之前执行，前置通知不会影响连接点的执行，除非此处抛出异常

@After: 后置通知, 在连接点正常执行完成后执行，如果连接点抛出异常，则不会执行

@AfterRunning: 返回通知, 在方法返回结果之后执行

@AfterThrowing: 异常通知, 在方法抛出异常之后执行

@Around: 环绕通知, 围绕着方法执行，比如一个方法调用的前后。这是最强大的通知类型，能在方法 调用前后自定义一些操作。

具体实现

如果要使用 Spring AOP 需要先导入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

在 yaml 文件中开启 AOP 功能

spring:
  aop:
    proxy-target-class: true		# 决定是基于接口的还是基于类的代理被创建
    auto: true		# 开启 aop 注解

自定义注解，我们需要将这个注解写在需要记录日志的方法上

/**
 * @author mei
 */
@Target({ElementType.METHOD}) // 作用方法上
@Retention(RetentionPolicy.RUNTIME)
public @interface DefaultLog {
    DefaultLogEnum Type() default DefaultLogEnum.NON;
}

定义一个枚举类，可以帮助我们更规范地管理

/**
 * @author mei
 */

@Data
public enum DefaultLogEnum {
    // 空
    NON("non","non"),
    USER_LOGIN("userLogin", "用户登录"),
    USER_LOGOUT("userLogin", "用户注销");

    /**
     * 类型
     */
    private String type;
    /**
     * 描述
     */
    private String desc;

}

然后就是 AOP 的切面类了

@Aspect
@Component
public class LogAspect {

    @Pointcut("@annotation(cafe.meix.aoptest.aop.DefaultLog)")
    public void pointCut(){}

    @Around(value = "pointCut()")
    public Object setDefaultLog(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取 request 和 session
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        HttpSession session = request.getSession();

        // 获取注解
        Method targetMethod = findTargetMethod(joinPoint);
        DefaultLog actionLog = AnnotationUtils.findAnnotation(targetMethod, DefaultLog.class);

        // 注解信息
        DefaultLogEnum type = actionLog.Type();

        // 插入日志，通过 joinPoint 和 session 可以获得 ip、path、clint、请求参数等信息
        insertLog(joinPoint, session, type);

        return joinPoint.proceed();
    }
    
    private void insertLog(ProceedingJoinPoint joinPoint, HttpSession session, DefaultLogEnum type) {
		// 写日志插入的相关代码
        System.out.println("记录日志：" + session.getId() + ", " + "type: " + type);
    }

    private Method findTargetMethod(ProceedingJoinPoint joinPoint) throws NoSuchMethodException {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Class[] parameterTypes = signature.getParameterTypes();
        return joinPoint.getTarget().getClass()
                .getMethod(joinPoint.getSignature().getName(), parameterTypes);
    }

}

最后在需要记录日志的地方添加注解，比如：

@Controller
@RequestMapping("/user")
public class LogController {

    @PostMapping("/login")
    @DefaultLog(Type = DefaultLogEnum.USER_LOGIN)
    public String userLogin(User user) {
        // 具体代码实现 ......
        return "success";
    }

}

最后我们测试一下，使用 postman 发送请求

可以看到，控制台成功打印了

结尾

好了，以上就是我的理解，是一个小 demo。

AOP 可以帮助我们将一些通用的功能代码与具体的业务代码分开，使代码解耦。同时它能帮助我们对某个功能进行统一管理，提高了可维护性。

文章原地址：Spring AOP 应用场景之–日志收集