Springboot 使用开源框架实现业务日志输出

小希爸爸
1,396 阅读7分钟

1、基本使用

1. maven依赖添加SDK依赖

        <dependency>
          <groupId>io.github.mouzt</groupId>
          <artifactId>bizlog-sdk</artifactId>
          <version>2.0.1</version>
        </dependency>

2、 SpringBoot入口打开开关,添加 @EnableLogRecord 注解

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

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
@EnableTransactionManagement
@EnableLogRecord(tenant = "com.mzt.test")
public class Main {

    public static void main(String[] args) {
        SpringApplication.run(Main.class, args);
    }
}

3、日志埋点

1. 普通的记录日志

  • type：是拼接在 bizNo 上作为 log 的一个标识。避免 bizNo 都为整数 ID 的时候和其他的业务中的 ID 重复。比如订单 ID、用户 ID 等，type可以是订单或者用户
  • bizNo：就是业务的 ID，比如订单ID，我们查询的时候可以根据 bizNo 查询和它相关的操作日志
  • success：方法调用成功后把 success 记录在日志的内容中
  • SpEL 表达式：其中用双大括号包围起来的（例如：{{#order.purchaseName}}）#order.purchaseName 是 SpEL表达式。Spring中支持的它都支持的。比如调用静态方法，三目表达式。SpEL 可以使用方法中的任何参数
@LogRecord(
      success = "{{#order.purchaseName}}下了一个订单,购买商品「{{#order.productName}}」,测试变量「{{#innerOrder.productName}}」,下单结果:{{#_ret}}",
      type = "order", bizNo = "{{#order.orderNo}}")

@PostMapping("/createOrder")
public boolean createOrder(Order order) {
   log.info("【创建订单】orderNo={}", order.getOrderNo());
   // db insert order
   Order order1 = new Order();
   order1.setProductName("内部变量测试");
   LogRecordContext.putVariable("innerOrder", order1);
   return true;
}

访问 http://localhost:8080/createOrder

image.png

日志输出如下：

【logRecord】log=LogRecord(id=null, tenant=com.example.learn, type=order, subType=, bizNo=123, operator=111, action=一辉下了一个订单,购买商品「自行车」,测试变量「内部变量测试」,下单结果:true, fail=false, createTime=Mon Apr 25 14:06:00 CST 2022, extra=)

2. 期望记录失败的日志

如果抛出异常则记录fail的日志，没有抛出记录 success 的日志。

  • subType:日志支持子类型
  • extra: 记录操作的详情或者额外信息
@LogRecord(
      extra = "{{#order.toString()}}",
      subType = "MANAGER_VIEW",
      fail = "创建订单失败，失败原因：「{{#_errorMsg}}」",
      success = "{{#order.purchaseName}}下了一个订单,购买商品「{{#order.productName}}」,测试变量「{{#innerOrder.productName}}」,下单结果:{{#_ret}}",
      type = "order", bizNo = "{{#order.orderNo}}")
@PostMapping("/createOrderFail")
public boolean createOrderFail(Order order) {
   log.info("【创建订单】orderNo={}", order.getOrderNo());
   // db insert order
   int i = 1 / 0;
   Order order1 = new Order();
   order1.setProductName("内部变量测试");
   LogRecordContext.putVariable("innerOrder", order1);
   return true;
}

访问 http://localhost:8080/createOrderFail

输出如下：

【logRecord】log=LogRecord(id=null, tenant=com.example.learn, type=order, subType=MANAGER_VIEW, bizNo=123, operator=111, action=创建订单失败，失败原因：「/ by zero」, fail=true, createTime=Mon Apr 25 14:10:08 CST 2022, extra=Order(orderNo=123, productName=自行车, purchaseName=一辉))

3、如何指定操作日志的操作人是什么？ 框架提供了两种方法

  • 第一种：手工在LogRecord的注解上指定。这种需要方法参数上有operator
@LogRecord(
      operator = "{{#currentUser}}",
      success = "{{#order.purchaseName}}下了一个订单,
      购买商品「{{#order.productName}}」,下单结果:{{#_ret}}",
      type = "order", bizNo = "{{#order.orderNo}}")
@PostMapping("/createOrderUser")
public boolean createOrderUser(Order order, String currentUser) {
   log.info("【创建订单】orderNo={}", order.getOrderNo());
   // db insert order
   return true;
}

image.png

日志输出如下：

` 【logRecord】log=LogRecord(id=null, tenant=com.example.learn, type=order, subType=, bizNo=123, operator=张三, action=一辉下了一个订单,购买商品「自行车」,下单结果:true, fail=false, createTime=Mon Apr 25 14:17:18 CST 2022, extra=)

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

  • 第二种： 通过默认实现类来自动的获取操作人，由于在大部分web应用中当前的用户都是保存在一个线程上下文中的，所以每个注解都加一个operator获取操作人显得有些重复劳动，所以提供了一个扩展接口来获取操作人 框架提供了一个扩展接口，使用框架的业务可以 implements 这个接口自己实现获取当前用户的逻辑， 对于使用 Springboot 的只需要实现 IOperatorGetService 接口，然后把这个 Service 作为一个单例放到 Spring 的上下文中。使用 Spring Mvc 的就需要自己手工装配这些 bean 了。
@Service
public class DefaultOperatorGetServiceImpl implements IOperatorGetService {
   
   @Override
   public Operator getUser() {
      // 获取用户信息
      Operator operator = new Operator("一辉");
      return operator;
   }
}

测试

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

访问

image.png

输出日志如下：

` 【logRecord】log=LogRecord(id=null, tenant=com.example.learn, type=order, subType=, bizNo=123, operator=一辉, action=一辉下了一个订单,购买商品「自行车」,下单结果:true, fail=false, createTime=Mon Apr 25 14:28:22 CST 2022, extra=)

`

4、日志文案调整

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

  • functionName() 方法就返回注解上面的函数名；
  • executeBefore() true：这个函数解析在注解方法执行之前运行，false：方法执行之后。有些更新方法，需要在更新之前查询出数据，这时候可以吧executeBefore返回true， executeBefore为true的时候函数内不能使用_ret和errorMsg的内置变量
  • apply()函数参数是 "{ORDER{#orderId}}"中SpEL解析的#orderId的值，这里是一个数字1223110，接下来只需要在实现的类中把 ID 转换为可读懂的字符串就可以了， 一般为了方便排查问题需要把名称和ID都展示出来，例如："订单名称（ID）"的形式。

这里有个问题：加了自定义函数后，框架怎么能调用到呢？ 答：对于Spring boot应用很简单，只需要把它暴露在Spring的上下文中就可以了，可以加上Spring的 @Component 或者 @Service 很方便😄。Spring mvc 应用需要自己装配 Bean。

@Slf4j
@Component
public class OrderParseFunction implements IParseFunction {
   
   /**
    * 方法就返回注解上面的函数名；
    * @return
    */
   @Override
   public String functionName() {
      return "ORDER";
   }
   
   /**
    * 实现函数返回的逻辑
    * @param value
    * @return
    */
   @Override
   public String apply(Object value) {
      log.info("@@@@@@@@");
      if (StringUtils.isEmpty(value)) {
         return "";
      }
      log.info("###########,{}", value);
      Order order = new Order();
      order.setProductName("宝马");
      return order.getProductName().concat("(").concat(value.toString()).concat(")");
   }
}

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

测试

image.png

输出如下：

【logRecord】log=LogRecord(id=null, tenant=com.example.learn, type=order, subType=, bizNo=123, operator=一辉, action=更新了订单宝马(236),更新内容为..., fail=false, createTime=Mon Apr 25 14:43:16 CST 2022, extra=Order(orderNo=123, productName=自行车, purchaseName=一辉))

5、使用 condition，满足条件的时候才记录日志

比如下面的例子：condition 变量为空的情况 才记录日志；condition 中的 SpEL 表达式必须是 bool 类型才生效。不配置 condition 默认日志都记录

@LogRecord(success = "更新了订单ORDER{#orderId}},更新内容为...",
      type = "order", bizNo = "{{#order.orderNo}}",
      condition = "{{#condition.equals('123')}}")
@PostMapping("/testCondition")
public boolean testCondition(Long orderId, Order order, String condition) {
   return false;
}

只有订单id 为 "123" 才输出日志

2、框架的扩展点

  • ILogRecordService 保存/查询日志的例子,使用者可以根据数据量保存到合适的存储介质上，比如保存在数据库/或者ES。自己实现保存和删除就可以了

也可以只实现保存的接口，毕竟已经保存在业务的存储上了，查询业务可以自己实现，不走 ILogRecordService 这个接口，毕竟产品经理会提一些千奇百怪的查询需求。

@Service
public class DbLogRecordServiceImpl implements ILogRecordService {

    @Resource
    private LogRecordMapper logRecordMapper;

    @Override
    @Transactional(propagation = Propagation.REQUIRES_NEW)
    public void record(LogRecord logRecord) {
        log.info("【logRecord】log={}", logRecord);
        LogRecordPO logRecordPO = LogRecordPO.toPo(logRecord);
        logRecordMapper.insert(logRecordPO);
    }

    @Override
    public List<LogRecord> queryLog(String bizKey, Collection<String> types) {
        return Lists.newArrayList();
    }

    @Override
    public PageDO<LogRecord> queryLogByBizNo(String bizNo, Collection<String> types, PageRequestDO pageRequestDO) {
        return logRecordMapper.selectByBizNoAndCategory(bizNo, types, pageRequestDO);
    }
}
  • IParseFunction 自定义转换函数的接口，可以实现IParseFunction 实现对LogRecord注解中使用的函数扩展 例子：
@Component
public class UserParseFunction implements IParseFunction {
    private final Splitter splitter = Splitter.on(",").trimResults();

    @Resource
    @Lazy
    private UserQueryService userQueryService;

    @Override
    public String functionName() {
        return "USER";
    }

    @Override
    // 11,12 返回 11(小明，张三)
    public String apply(String value) {
        if (StringUtils.isEmpty(value)) {
            return value;
        }
        List<String> userIds = Lists.newArrayList(splitter.split(value));
        List<User> misDOList = userQueryService.getUserList(userIds);
        Map<String, User> userMap = StreamUtil.extractMap(misDOList, User::getId);
        StringBuilder stringBuilder = new StringBuilder();
        for (String userId : userIds) {
            stringBuilder.append(userId);
            if (userMap.get(userId) != null) {
                stringBuilder.append("(").append(userMap.get(userId).getUsername()).append(")");
            }
            stringBuilder.append(",");
        }
        return stringBuilder.toString().replaceAll(",$", "");
    }
}
avatar
文章
阅读
粉丝