一个注解搞定 Spring Boot 操作日志

﹏ヽ暗。殇╰゛Y 2021-09-07 06:15 375阅读 0赞 
  1. 此组件解决的问题是：「谁」在「什么时间」对「什么」做了「什么事」

本组件目前针对 Spring-boot 做了 Autoconfig，如果是 SpringMVC，也可自己在 xml 初始化 bean

基本使用

maven依赖添加SDK依赖

  1. <dependency>
  2.    <groupId>io.github.mouzt</groupId>
  3.    <artifactId>bizlog-sdk</artifactId>
  4.    <version>1.0.1</version>
  5.  </dependency>

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

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

  1. @SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
  2. @EnableTransactionManagement
  3. @EnableLogRecord(tenant = "com.mzt.test")
  4. public class Main {
  6.     public static void main(String[] args) {
  7.         SpringApplication.run(Main.class, args);
  8.     }
  9. }

日志埋点

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 = “{

    1. {#order.purchaseName}}下了一个订单,购买商品「{
    2. {#order.productName}}」,下单结果:{
    3. {#_ret}}",
    4.           prefix = LogRecordType.ORDER, bizNo = "{
    5. {#order.orderNo}}")

    public boolean createOrder(Order order) {

    1.   log.info("【创建订单】orderNo={}", order.getOrderNo());
    2.   // db insert order
    3.   return true;

    }

此时会打印操作日志 “张三下了一个订单,购买商品「超值优惠红烧肉套餐」,下单结果:true”

2. 期望记录失败的日志, 如果抛出异常则记录fail的日志，没有抛出记录 success 的日志
  1.     @LogRecordAnnotation(
  2.             fail = "创建订单失败，失败原因：「{
  3.     {#_errorMsg}}」",
  4.             success = "{
  5.     {#order.purchaseName}}下了一个订单,购买商品「{
  6.     {#order.productName}}」,下单结果:{
  7.     {#_ret}}",
  8.             prefix = LogRecordType.ORDER, bizNo = "{
  9.     {#order.orderNo}}")
  10.     public boolean createOrder(Order order) {
  11.         log.info("【创建订单】orderNo={}", order.getOrderNo());
  12.         // db insert order
  13.         return true;
  14.     }

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

  1. 日志支持种类

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

  1.     @LogRecordAnnotation(
  2.             fail = "创建订单失败，失败原因：「{
  3.     {#_errorMsg}}」",
  4.             category = "MANAGER",
  5.             success = "{
  6.     {#order.purchaseName}}下了一个订单,购买商品「{
  7.     {#order.productName}}」,下单结果:{
  8.     {#_ret}}",
  9.             prefix = LogRecordType.ORDER, bizNo = "{
  10.     {#order.orderNo}}")
  11.     public boolean createOrder(Order order) {
  12.         log.info("【创建订单】orderNo={}", order.getOrderNo());
  13.         // db insert order
  14.         return true;
  15.     }
4. 支持记录操作的详情或者额外信息

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

  1.  @LogRecordAnnotation(
  2.             fail = "创建订单失败，失败原因：「{
  3.     {#_errorMsg}}」",
  4.             category = "MANAGER_VIEW",
  5.             detail = "{
  6.     {#order.toString()}}",
  7.             success = "{
  8.     {#order.purchaseName}}下了一个订单,购买商品「{
  9.     {#order.productName}}」,下单结果:{
  10.     {#_ret}}",
  11.             prefix = LogRecordType.ORDER, bizNo = "{
  12.     {#order.orderNo}}")
  13.     public boolean createOrder(Order order) {
  14.         log.info("【创建订单】orderNo={}", order.getOrderNo());
  15.         // db insert order
  16.         return true;
  17.     }
5. 如何指定操作日志的操作人是什么？框架提供了两种方法

  • 第一种：手工在LogRecord的注解上指定。这种需要方法参数上有operator

    1. @LogRecordAnnotation(
    2.         fail = "创建订单失败，失败原因：「{
    3. {#_errorMsg}}」",
    4.         category = "MANAGER_VIEW",
    5.         detail = "{
    6. {#order.toString()}}",
    7.         operator = "{
    8. {#currentUser}}",
    9.         success = "{
    10. {#order.purchaseName}}下了一个订单,购买商品「{
    11. {#order.productName}}」,下单结果:{
    12. {#_ret}}",
    13.         prefix = LogRecordType.ORDER, bizNo = "{
    14. {#order.orderNo}}")
    15. public boolean createOrder(Order order, String currentUser) {
    16.     log.info("【创建订单】orderNo={}", order.getOrderNo());
    17.     // db insert order
    18.     return true;
    19. }

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

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

    @Configuration
    public class LogRecordConfiguration {

    1. @Bean
    2. public IOperatorGetService operatorGetService() {
    3.     return () -> Optional.of(OrgUserUtils.getCurrentUser())
    4.             .map(a -> new OperatorDO(a.getMisId()))
    5.             .orElseThrow(() -> new IllegalArgumentException("user is null"));
    6. }

    }

    //也可以这么搞：
    @Service
    public class DefaultOperatorGetServiceImpl implements IOperatorGetService {

    1. @Override
    2. public OperatorDO getUser() {
    3.     OperatorDO operatorDO = new OperatorDO();
    4.     operatorDO.setOperatorId("SYSTEM");
    5.     return operatorDO;
    6. }

    }

6. 日志文案调整

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

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

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

  1.     // 没有使用自定义函数
  2.     @LogRecordAnnotation(success = "更新了订单{
  3.     {#orderId}},更新内容为....",
  4.             prefix = LogRecordType.ORDER, bizNo = "{
  5.     {#order.orderNo}}",
  6.             detail = "{
  7.     {#order.toString()}}")
  8.     public boolean update(Long orderId, Order order) {
  9.         return false;
  10.     }
  12.     //使用了自定义函数，主要是在 {
  13.     {#orderId}} 的大括号中间加了 functionName
  14.     @LogRecordAnnotation(success = "更新了订单ORDER{#orderId}},更新内容为...",
  15.             prefix = LogRecordType.ORDER, bizNo = "{
  16.     {#order.orderNo}}",
  17.             detail = "{
  18.     {#order.toString()}}")
  19.     public boolean update(Long orderId, Order order) {
  20.         return false;
  21.     }
  23.     // 还需要加上函数的实现
  24.     @Component
  25.     public class OrderParseFunction implements IParseFunction {
  26.         @Resource
  27.         @Lazy //为了避免类加载顺序的问题 最好为Lazy，没有问题也可以不加
  28.         private OrderQueryService orderQueryService;
  30.         @Override
  31.         public String functionName() {
  32.             //  函数名称为 ORDER
  33.             return "ORDER";
  34.         }
  36.         @Override
  37.         //这里的 value 可以吧 Order 的JSON对象的传递过来，然后反解析拼接一个定制的操作日志内容
  38.         public String apply(String value) {
  39.             if(StringUtils.isEmpty(value)){
  40.                 return value;
  41.             }
  42.             Order order = orderQueryService.queryOrder(Long.parseLong(value));
  43.             //把订单产品名称加上便于理解，加上 ID 便于查问题
  44.             return order.getProductName().concat("(").concat(value).concat(")");
  45.         }
  46.     }
7. 日志文案调整 使用 SpEL 三目表达式
  1.     @LogRecordAnnotation(prefix = LogRecordTypeConstant.CUSTOM_ATTRIBUTE, bizNo = "{
  2.     {#businessLineId}}",
  3.             success = "{
  4.     {#disable ? '停用' : '启用'}}了自定义属性{ATTRIBUTE{#attributeId}}")
  5.     public CustomAttributeVO disableAttribute(Long businessLineId, Long attributeId, boolean disable) {
  6.      return xxx;
  7.     }

框架的扩展点

  • 重写OperatorGetServiceImpl通过上下文获取用户的扩展，例子如下

    @Service
    public class DefaultOperatorGetServiceImpl implements IOperatorGetService {

    1. @Override
    2. public Operator getUser() {
    3.      return Optional.ofNullable(UserUtils.getUser())
    4.                     .map(a -> new Operator(a.getName(), a.getLogin()))
    5.                     .orElseThrow(()->new IllegalArgumentException("user is null"));
    7. }

    }

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

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

  1. @Service
  2. public class DbLogRecordServiceImpl implements ILogRecordService {
  4.     @Resource
  5.     private LogRecordMapper logRecordMapper;
  7.     @Override
  8.     @Transactional(propagation = Propagation.REQUIRES_NEW)
  9.     public void record(LogRecord logRecord) {
  10.         log.info("【logRecord】log={}", logRecord);
  11.         LogRecordPO logRecordPO = LogRecordPO.toPo(logRecord);
  12.         logRecordMapper.insert(logRecordPO);
  13.     }
  15.     @Override
  16.     public List<LogRecord> queryLog(String bizKey, Collection<String> types) {
  17.         return Lists.newArrayList();
  18.     }
  20.     @Override
  21.     public PageDO<LogRecord> queryLogByBizNo(String bizNo, Collection<String> types, PageRequestDO pageRequestDO) {
  22.         return logRecordMapper.selectByBizNoAndCategory(bizNo, types, pageRequestDO);
  23.     }
  24. }

  • IParseFunction 自定义转换函数的接口，可以实现IParseFunction 实现对LogRecord注解中使用的函数扩展 例子：

    @Component
    public class UserParseFunction implements IParseFunction {

    1. private final Splitter splitter = Splitter.on(",").trimResults();
    3. @Resource
    4. @Lazy
    5. private UserQueryService userQueryService;
    7. @Override
    8. public String functionName() {
    9.     return "USER";
    10. }
    12. @Override
    13. // 11,12 返回 11(小明)，12(张三)
    14. public String apply(String value) {
    15.     if (StringUtils.isEmpty(value)) {
    16.         return value;
    17.     }
    18.     List<String> userIds = Lists.newArrayList(splitter.split(value));
    19.     List<User> misDOList = userQueryService.getUserList(userIds);
    20.     Map<String, User> userMap = StreamUtil.extractMap(misDOList, User::getId);
    21.     StringBuilder stringBuilder = new StringBuilder();
    22.     for (String userId : userIds) {
    23.         stringBuilder.append(userId);
    24.         if (userMap.get(userId) != null) {
    25.             stringBuilder.append("(").append(userMap.get(userId).getUsername()).append(")");
    26.         }
    27.         stringBuilder.append(",");
    28.     }
    29.     return stringBuilder.toString().replaceAll(",$", "");
    30. }

    }

变量相关

LogRecordAnnotation 可以使用的变量出了参数也可以使用返回值#_ret变量，以及异常的错误信息#_errorMsg，也可以通过SpEL的 T 方式调用静态方法噢

待扩展

实现一个 Log的 Context，可以解决方法参数中没有的变量但是想使用的问题，初步想法是可以通过在方法中 add 变量的形式实现，很快就可以实现了 ????

注意点：

⚠️ 整体日志拦截是在方法执行之后记录的，所以对于方法内部修改了方法参数之后，LogRecordAnnotation 的注解上的 SpEL 对变量的取值是修改后的值哦～

源码

https://github.com/mouzt/mzt-biz-log

Author

原创出处 blog.csdn.net/weixin_43954303/article/details/113781801

「mztBang」欢迎转载，保留摘要，谢谢！

  1. -END-
  2. 如果看到这里，说明你喜欢这篇文章，请 转发、点赞。微信搜索「web_resource」，关注后回复「进群」或者扫描下方二维码即可进入无广告交流群。
  3. ↓扫描二维码进群↓
  5. 推荐阅读 
  6. 1.  一份 Spring Boot 项目搭建模板
  7. 2.  Spring Boot 实现应用监控和报警
  8. 3.  Nginx 从入门到实战
  9. 4.  一键式搭建分布式文件服务器
  10. 5.  团队开发中 Git 最佳实践
  12. 喜欢文章，点个在看

发表评论

表情：
评论列表 （有 0 条评论，375人围观）

还没有评论，来说两句吧...

相关阅读

    相关 【Spring Boot】日志

    0. 前言 1.张三在一个系统中写了很多的system.out.printin("…");这样可以更好的了解系统运行状况。 2.张三觉得这个功能非常好，于是就开发...

    灰太狼灰太狼/ 0 赞/ 200 阅读

    相关 Spring boot实现AOP记录操作日志

    前言 在实际的项目中，特别是管理系统中，对于那些重要的操作我们通常都会记录操作日志。比如对数据库的`CRUD`操作，我们都会对每一次重要的操作进行记录，通常的做法是向数据

    红太狼红太狼/ 0 赞/ 87 阅读

    相关 Spring boot实现AOP记录操作日志

    前言 在实际的项目中，特别是管理系统中，对于那些重要的操作我们通常都会记录操作日志。比如对数据库的CRUD操作，我们都会对每一次重要的操作进行记录，通常的做法是向数据库指定

    蔚落蔚落/ 0 赞/ 431 阅读