使用Spring Boot和AOP实现可插拔式日志

107 阅读1分钟

在这个示例中,我将向您展示如何使用Spring Boot和AOP(面向切面编程)实现可插拔式日志。以下是实现此功能的关键步骤和代码示例:

  1. 引入依赖

在您的pom.xml文件中添加以下依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
  1. 创建自定义注解SysLog
package com.example.aop.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SysLog {
    String value() default "";
}
  1. 创建SysLogAspect切面类
package com.example.aop.aspect;

import com.example.aop.annotation.SysLog;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

@Aspect
@Component
public class SysLogAspect {

    @Pointcut("@annotation(com.example.aop.annotation.SysLog)")
    public void logPointCut() {}

    @Before("logPointCut()")
    public void before(JoinPoint joinPoint) {
        // 在这里实现日志记录的逻辑
    }

    @Around("logPointCut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        // 在这里实现日志记录的逻辑
        Object result = joinPoint.proceed();
        return result;
    }

    @After("logPointCut()")
    public void after(JoinPoint joinPoint) {
        // 在这里实现日志记录的逻辑
    }

    @AfterReturning("logPointCut()")
    public void afterReturning(JoinPoint joinPoint) {
        // 在这里实现日志记录的逻辑
    }

    @AfterThrowing("logPointCut()")
    public void afterThrowing(JoinPoint joinPoint) {
        // 在这里实现日志记录的逻辑
    }
}
  1. 在需要记录日志的方法上使用@SysLog注解
package com.example.aop.service;

import com.example.aop.annotation.SysLog;
import org.springframework.stereotype.Service;

@Service
public class TestService {

    @SysLog("log-example")
    public void exampleMethod(String input) {
        // 在这里