#日志 - 注解实现操作日志记录-1 - 《Java》

依赖
添加 @EnableLogRecord 注解
日志埋点

biz-log是一个依赖工具类，可以帮助我们对操作日志进行记录

依赖

<!-- https://mvnrepository.com/artifact/io.github.mouzt/bizlog-sdk -->
<dependency>
    <groupId>io.github.mouzt</groupId>
    <artifactId>bizlog-sdk</artifactId>
    <version>1.0.3</version>
</dependency>

添加 @EnableLogRecord 注解

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

tenant是代表租户的标识，一般一个服务或者一个业务下的多个服务都写死一个 tenant 就可以

日志埋点

1.普通的日志记录

pefix：是拼接在 bizNo 上作为 log 的一个标识。避免 bizNo 都为整数 ID 的时候和其他的业务中的 ID 重复。比如订单 ID、用户 ID 等
bizNo：就是业务的 ID，比如订单ID，我们查询的时候可以根据 bizNo 查询和它相关的操作日志
success：方法调用成功后把 success 记录在日志的内容中

SpEL 表达式：其中用双大括号包围起来的（例如：{{#order.purchaseName}}）#order.purchaseName 是 SpEL表达式。Spring中支持的它都支持的。比如调用静态方法，三目表达式。SpEL 可以使用方法中的任何参数

@LogRecordAnnotation(success = "{{#order.purchaseName}}下了一个订单,购买商品「{{#order.productName}}」,下单结果:{{#_ret}}",
            prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}")
public boolean createOrder(Order order) {
    log.info("【创建订单】orderNo={}", order.getOrderNo());
    // db insert order
    return true;
}

2. 期望记录失败的日志

如果抛出异常则记录fail的日志，没有抛出记录 success 的日志其中的 #_errorMsg 是取的方法抛出异常后的异常的 errorMessage。

@LogRecordAnnotation(
          fail = "创建订单失败，失败原因：「{{#_errorMsg}}」",
          success = "{{#order.purchaseName}}下了一个订单,购买商品「{{#order.productName}}」,下单结果:{{#_ret}}",
          prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}")
  public boolean createOrder(Order order) {
      log.info("【创建订单】orderNo={}", order.getOrderNo());
      // db insert order
      return true;
  }

其中的 #_errorMsg 是取的方法抛出异常后的异常的 errorMessage。

3. 日志支持种类

比如一个订单的操作日志，有些操作日志是用户自己操作的，有些操作是系统运营人员做了修改产生的操作日志，我们系统不希望把运营的操作日志暴露给用户看到，但是运营期望可以看到用户的日志以及运营自己操作的日志，这些操作日志的bizNo都是订单号，所以为了扩展添加了类型字段,主要是为了对日志做分类，查询方便，支持更多的业务。

    @LogRecordAnnotation(
            fail = "创建订单失败，失败原因：「{{#_errorMsg}}」",
            category = "MANAGER",
            success = "{{#order.purchaseName}}下了一个订单,购买商品「{{#order.productName}}」,下单结果:{{#_ret}}",
            prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}")
    public boolean createOrder(Order order) {
        log.info("【创建订单】orderNo={}", order.getOrderNo());
        // db insert order
        return true;
    }

4. 支持记录操作的详情或者额外信息

如果一个操作修改了很多字段，但是success的日志模版里面防止过长不能把修改详情全部展示出来，这时候需要把修改的详情保存到 detail 字段， detail 是一个 String ，需要自己序列化。这里的 #order.toString() 是调用了 Order 的 toString() 方法。如果保存 JSON，自己重写一下 Order 的 toString() 方法就可以。

 @LogRecordAnnotation(
            fail = "创建订单失败，失败原因：「{{#_errorMsg}}」",
            category = "MANAGER_VIEW",
            detail = "{{#order.toString()}}",
            success = "{{#order.purchaseName}}下了一个订单,购买商品「{{#order.productName}}」,下单结果:{{#_ret}}",
            prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}")
    public boolean createOrder(Order order) {
        log.info("【创建订单】orderNo={}", order.getOrderNo());
        // db insert order
        return true;
    }

5. 如何指定操作日志的操作人是什么

第一种：手工在LogRecord的注解上指定

这种需要方法参数上有operator

    @LogRecordAnnotation(
            fail = "创建订单失败，失败原因：「{{#_errorMsg}}」",
            category = "MANAGER_VIEW",
            detail = "{{#order.toString()}}",
            operator = "{{#currentUser}}",
            success = "{{#order.purchaseName}}下了一个订单,购买商品「{{#order.productName}}」,下单结果:{{#_ret}}",
            prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}")
    public boolean createOrder(Order order, String currentUser) {
        log.info("【创建订单】orderNo={}", order.getOrderNo());
        // db insert order
        return true;
    }

这种方法手工指定，需要方法参数上有 operator 参数，或者通过 SpEL 调用静态方法获取当前用户。

第二种：通过默认实现类来自动的获取操作人

由于在大部分web应用中当前的用户都是保存在一个线程上下文中的，所以每个注解都加一个operator获取操作人显得有些重复劳动，所以提供了一个扩展接口来获取操作人框架提供了一个扩展接口，使用框架的业务可以 implements 这个接口自己实现获取当前用户的逻辑，对于使用 Springboot 的只需要实现 IOperatorGetService 接口，然后把这个 Service 作为一个单例放到 Spring 的上下文中。使用 Spring Mvc 的就需要自己手工装配这些 bean 了。

@Configuration
public class LogRecordConfiguration {
    @Bean
    public IOperatorGetService operatorGetService() {
        return () -> Optional.of(OrgUserUtils.getCurrentUser())
                .map(a -> new OperatorDO(a.getMisId()))
                .orElseThrow(() -> new IllegalArgumentException("user is null"));
    }
}
//也可以这么搞：
@Service
public class DefaultOperatorGetServiceImpl implements IOperatorGetService {
    @Override
    public OperatorDO getUser() {
        OperatorDO operatorDO = new OperatorDO();
        operatorDO.setOperatorId("SYSTEM");
        return operatorDO;
    }
}

6. 日志文案调整

对于更新等方法，方法的参数上大部分都是订单ID、或者产品ID等，比如下面的例子：日志记录的success内容是：“更新了订单{{#orderId}},更新内容为…”，这种对于运营或者产品来说难以理解，所以引入了自定义函数的功能。使用方法是在原来的变量的两个大括号之间加一个函数名称例如 “{ORDER{#orderId}}” 其中 ORDER 是一个函数名称。只有一个函数名称是不够的,需要添加这个函数的定义和实现。可以看下面例子自定义的函数需要实现框架里面的IParseFunction的接口，需要实现两个方法：

functionName() 方法就返回注解上面的函数名；

apply()函数参数是 “{ORDER{#orderId}}”中SpEL解析的#orderId的值，这里是一个数字1223110，接下来只需要在实现的类中把 ID 转换为可读懂的字符串就可以了，一般为了方便排查问题需要把名称和ID都展示出来，例如：”订单名称（ID）”的形式。

// 没有使用自定义函数
  @LogRecordAnnotation(success = "更新了订单{{#orderId}},更新内容为....",
          prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}",
          detail = "{{#order.toString()}}")
  public boolean update(Long orderId, Order order) {
      return false;
  }

  //使用了自定义函数，主要是在 {{#orderId}} 的大括号中间加了 functionName
  @LogRecordAnnotation(success = "更新了订单ORDER{#orderId}},更新内容为...",
          prefix = LogRecordType.ORDER, bizNo = "{{#order.orderNo}}",
          detail = "{{#order.toString()}}")
  public boolean update(Long orderId, Order order) {
      return false;
  }

  // 还需要加上函数的实现
  @Component
  public class OrderParseFunction implements IParseFunction {
      @Resource
      @Lazy //为了避免类加载顺序的问题 最好为Lazy，没有问题也可以不加
      private OrderQueryService orderQueryService;

      @Override
      public String functionName() {
          //  函数名称为 ORDER
          return "ORDER";
      }

      @Override
      //这里的 value 可以吧 Order 的JSON对象的传递过来，然后反解析拼接一个定制的操作日志内容
      public String apply(String value) {
          if(StringUtils.isEmpty(value)){
              return value;
          }
          Order order = orderQueryService.queryOrder(Long.parseLong(value));
          //把订单产品名称加上便于理解，加上 ID 便于查问题
          return order.getProductName().concat("(").concat(value).concat(")");
      }
  }

7. 日志文案调整使用 SpEL 三目表达式

 @LogRecordAnnotation(prefix = LogRecordTypeConstant.CUSTOM_ATTRIBUTE, bizNo = "{{#businessLineId}}",
          success = "{{#disable ? '停用' : '启用'}}了自定义属性{ATTRIBUTE{#attributeId}}")
  public CustomAttributeVO disableAttribute(Long businessLineId, Long attributeId, boolean disable) {
   return xxx;
  }

注解实现操作日志记录-1

依赖