RuoYi-Vue-Pro项目中API错误日志的优化实践

背景介绍

在基于Spring Boot的企业级开发框架RuoYi-Vue-Pro中，API错误日志的记录是一个重要功能。默认情况下，系统会将所有API接口的异常信息记录到数据库中，便于后续排查和分析。然而在实际开发过程中，开发环境和测试环境可能并不需要将所有错误日志都持久化存储。

问题分析

在开发模式下，开发者通常可以通过控制台或日志文件直接查看错误信息，将错误日志保存到数据库反而会增加不必要的存储开销。而在测试环境中，虽然QA人员可能需要查看错误日志进行验收，但频繁的数据库写入也可能影响性能。

解决方案

配置开关方案

最理想的解决方案是在application.yml配置文件中增加类似access-log的开关配置，例如：

yudao:
  exception-log:
    enable: true # 是否记录API错误日志到数据库

这样可以根据不同环境灵活控制错误日志的存储行为。

自定义异常处理器方案

考虑到框架升级的兼容性，可以采用自定义@RestControllerAdvice的方式覆盖框架默认的全局异常处理逻辑：

1. 创建自定义异常处理器UniExceptionHandler继承框架的GlobalExceptionHandler
2. 在处理器中增加日志存储开关判断逻辑
3. 通过@AutoConfiguration自动配置替换原有处理器

关键代码片段：

public class UniExceptionHandler extends GlobalExceptionHandler {
    private final Boolean apiErrorLogEnabled;
    
    private void createExceptionLog(HttpServletRequest req, Throwable e) {
        if (!Boolean.TRUE.equals(apiErrorLogEnabled)) {
            log.info("接口错误日志入库功能未启用");
            return;
        }
        // 原有日志存储逻辑
    }
}

技术实现细节

异常处理增强

在自定义异常处理器中，我们可以对特定异常进行更精细化的处理：

1. 参数转换异常：对HttpMessageConversionException进行特殊处理，提供更友好的错误提示
2. 业务异常：对ServiceException进行堆栈精简，避免过多无用日志
3. 表不存在异常：识别特定模块的表缺失情况，给出明确的模块提示

性能优化考虑

1. 异步存储：通过createApiErrorLogAsync方法异步保存错误日志，减少对主流程的影响
2. 日志精简：对已知的业务异常不记录完整堆栈，只记录关键信息
3. 开关控制：完全关闭非必要环境的日志存储功能

最佳实践建议

1. 开发环境：建议关闭数据库存储，通过控制台和日志文件查看错误
2. 测试环境：根据实际需求决定是否开启，性能测试时建议关闭
3. 生产环境：必须开启，并确保异步存储正常工作
4. 特殊场景：对于支付、交易等核心模块，即使测试环境也建议开启日志存储

总结

通过对RuoYi-Vue-Pro项目API错误日志存储机制的优化，我们可以实现更灵活、更高效的错误日志管理。这种方案不仅减少了非必要环境的资源消耗，还保留了生产环境完整的错误追踪能力，是框架使用中的一个实用优化技巧。开发者可以根据项目实际需求，选择最适合的配置方案。