乐趣区

关于java:一个注解搞定-Spring-Boot-日志还有谁不会

jiezi

此组件解决的问题是：

「谁」在「什么工夫」对「什么」做了「什么事」

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

应用形式

根本应用

maven 依赖增加 SDK 依赖

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

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);
    }
}

Spring Boot 最新教程举荐看上面这个。

https://github.com/javastacks…

日志埋点

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;
}

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

2. 冀望记录失败的日志, 如果抛出异样则记录 fail 的日志，没有抛出记录 success 的日志
@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）” 的模式。

这里有个问题：加了自定义函数后，框架怎么能调用到呢？
答：对于 Spring boot 利用很简略，只须要把它裸露在 Spring 的上下文中就能够了，能够加上 Spring 的 @Component 或者 @Service 很不便😄。Spring mvc 利用须要本人拆卸 Bean。

// 没有应用自定义函数
@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;}

框架的扩大点

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

@Service
public class DefaultOperatorGetServiceImpl implements IOperatorGetService {

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

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(小明)，12(张三)
    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(",$", "");
    }
}

变量相干

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

待扩大

实现一个 Log 的 Context，能够解决办法参数中没有的变量然而想应用的问题，初步想法是能够通过在办法中 add 变量的模式实现，很快就能够实现了 😄

留神点：

⚠️ 整体日志拦挡是在办法执行之后记录的，所以对于办法外部批改了办法参数之后，LogRecordAnnotation 的注解上的 SpEL 对变量的取值是批改后的值哦。

源码：https://github.com/mouzt/mzt-…

版权申明：本文为 CSDN 博主「mztBang」的原创文章，遵循 CC 4.0 BY-SA 版权协定，转载请附上原文出处链接及本申明。
原文链接：https://blog.csdn.net/weixin_…

近期热文举荐：

1.600+ 道 Java 面试题及答案整顿(2021 最新版)

2. 终于靠开源我的项目弄到 IntelliJ IDEA 激活码了，真香！

3. 阿里 Mock 工具正式开源，干掉市面上所有 Mock 工具！

4.Spring Cloud 2020.0.0 正式公布，全新颠覆性版本！

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！

退出移动版