SpringBoot使用AOP记录接口操作日志的方法

下面是详细讲解“SpringBoot使用AOP记录接口操作日志的方法”的攻略。

1. 什么是AOP

AOP全称为Aspect Oriented Programming，即面向切面编程。它是指通过预编译方式和运行期动态代理实现程序的功能模块化，从而达到可重复使用、灵活性和可维护性的一种编程技术。

2. 利用AOP记录接口操作日志

利用AOP记录接口操作日志的思路是，通过在每个接口方法执行前后插入记录日志的逻辑代码，记录下每个接口的操作日志，方便后期的跟踪和排查。

具体实现步骤如下：

步骤1：添加AOP依赖

在maven中添加AOP依赖：

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

步骤2：编写日志切面代码

在SpringBoot项目中新建一个切面类LogAspect，代码如下：

@Aspect
@Component
public class LogAspect {

    private Logger logger = LoggerFactory.getLogger(LogAspect.class);

    @Pointcut("execution(public * " + "com.example.demo.controller..*.*(..))")
    public void log() {
    }

    @Before("log()")
    public void beforeLog(JoinPoint joinPoint) {
        logger.info("【请求URL】: {}",((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest().getRequestURL().toString());
        logger.info("【请求IP】: {}",((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest().getRemoteAddr());
        logger.info("【请求方法】: {}",
        joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("【请求参数】: {}",
        Arrays.toString(joinPoint.getArgs()));
    }

    @AfterReturning(returning = "ret", pointcut = "log()")
    public void afterLog(Object ret) {
        logger.info("【返回结果】: {}", ret);
    }

}

其中，@Aspect注解表示这是一个切面类，@Component注解表示交给Spring容器管理。@Pointcut注解表示切入点，这里的切入点表示所有com.example.demo.controller下的方法。@Before和@AfterReturning注解表示分别在方法执行前和执行后插入日志代码。

步骤3：配置日志输出格式

在application.properties中添加配置项：

logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} %m%n

这样可以使日志的输出格式更清晰。

步骤4：运行项目并测试

最后，启动SpringBoot项目并测试一下接口，每个接口的请求和返回结果都应该能被记录下来。

3. 示例说明

为了更好地理解上述过程，下面提供两个示例代码：

示例1：Controller层记录日志

@RestController
@RequestMapping("/user")
public class UserController {

    @GetMapping("/{id}")
    public User getUserById(@PathVariable Integer id) {
        //省略具体实现
        return null;
    }

}

通过上述代码，由于该接口的访问路劲为/user/{id}，因此可以匹配到LogAspect中的切入点，记录下该接口的请求方法、请求参数和返回结果。

示例2：Service层记录日志

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserRepository userRepository;

    @Override
    public User getUserById(Integer id) {
        //省略具体实现
        return null;
    }

}

通过上述代码，由于UserService实现了接口UserServiceImpl，因此可以匹配到LogAspect中的切入点，记录下该方法的请求方法、请求参数和返回结果。

通过以上示例代码可以看出，只要在具体的方法所属的包名前加上切入点匹配的“前缀”即可。这样就可以方便地实现接口操作日志的记录了。