mzt-biz-log 项目常见问题解决方案

项目基础介绍

mzt-biz-log 是一个基于 Spring Boot 的通用操作日志组件，支持通过注解的方式记录操作日志。该项目的主要编程语言是 Java。它通过注解的方式，允许开发者自定义变量和函数，从而灵活地记录操作日志。

新手使用注意事项及解决方案

1. 注解 @LogRecord 的使用

问题描述：新手在使用 @LogRecord 注解时，可能会遇到注解不生效的问题。

解决步骤：

1. 确保 Spring Boot 版本兼容：检查项目的 Spring Boot 版本是否与 mzt-biz-log 兼容。建议使用最新版本的 Spring Boot。
2. 开启日志记录功能：在 Spring Boot 的启动类上添加 @EnableLogRecord 注解，并设置 tenant 属性。

   @SpringBootApplication
   @EnableLogRecord(tenant = "com.mzt.test")
   public class Main {
       public static void main(String[] args) {
           SpringApplication.run(Main.class, args);
       }
   }
   

3. 检查注解位置：确保 @LogRecord 注解正确地添加在需要记录日志的方法上。

2. 自定义函数的使用

问题描述：新手在自定义函数时，可能会遇到函数无法解析或调用的问题。

解决步骤：

1. 定义自定义函数：创建一个类，实现 ILogRecordService 接口，并在其中定义自定义函数。

   @Component
   public class CustomLogFunction implements ILogRecordService {
       @Override
       public String functionName() {
           return "customFunction";
       }
   
       @Override
       public String function(Object param) {
           return "Custom Function Result";
       }
   }
   

2. 在注解中使用自定义函数：在 @LogRecord 注解中使用自定义函数。

   @LogRecord(success = "customFunction(#param)")
   public void someMethod(String param) {
       // 业务逻辑
   }
   

3. 确保函数被 Spring 管理：确保自定义函数类被 Spring 容器管理，即添加 @Component 注解。

3. 日志记录异常处理

问题描述：新手在记录日志时，可能会遇到日志记录异常导致业务逻辑中断的问题。

解决步骤：

1. 配置异常处理：在 @LogRecord 注解中配置 fail 属性，确保日志记录异常不影响业务逻辑。

   @LogRecord(success = "操作成功", fail = "操作失败")
   public void someMethod() {
       // 业务逻辑
   }
   

2. 捕获异常：在业务逻辑中捕获可能的异常，并进行处理。

   @LogRecord(success = "操作成功", fail = "操作失败")
   public void someMethod() {
       try {
           // 业务逻辑
       } catch (Exception e) {
           // 异常处理
       }
   }
   

3. 日志记录不影响业务：确保日志记录的异常不会影响业务逻辑的正常执行。

通过以上步骤，新手可以更好地理解和使用 mzt-biz-log 项目，避免常见问题的发生。