Springboot-注解-操作日志的实现方式

2023-07-04 22:43:03 76

此组件解决的问题是：

「谁」在「什么时间」对「什么」做了「什么事」

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

使用方式

基本使用

maven依赖添加SDK依赖


io.github.mouzt
bizlog-sdk
1.0.1

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

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

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

日志埋点

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}}")
publicbooleancreateOrder(Orderorder){
log.info("【创建订单】orderNo={}",order.getOrderNo());
//dbinsertorder
returntrue;
}

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

2.期望记录失败的日志,如果抛出异常则记录fail的日志，没有抛出记录success的日志

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

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

3.日志支持种类

比如一个订单的操作日志，有些操作日志是用户自己操作的，有些操作是系统运营人员做了修改产生的操作日志，我们系统不希望把运营的操作日志暴露给用户看到，

但是运营期望可以看到用户的日志以及运营自己操作的日志，这些操作日志的bizNo都是订单号，所以为了扩展添加了类型字段,主要是为了对日志做分类，查询方便，支持更多的业务。

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

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}}")
publicbooleancreateOrder(Orderorder){
log.info("【创建订单】orderNo={}",order.getOrderNo());
//dbinsertorder
returntrue;
}

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}}")
publicbooleancreateOrder(Orderorder,StringcurrentUser){
log.info("【创建订单】orderNo={}",order.getOrderNo());
//dbinsertorder
returntrue;
}

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

第二种：通过默认实现类来自动的获取操作人，由于在大部分web应用中当前的用户都是保存在一个线程上下文中的，所以每个注解都加一个operator获取操作人显得有些重复劳动，所以提供了一个扩展接口来获取操作人

框架提供了一个扩展接口，使用框架的业务可以implements这个接口自己实现获取当前用户的逻辑，

对于使用Springboot的只需要实现IOperatorGetService接口，然后把这个Service作为一个单例放到Spring的上下文中。使用SpringMvc的就需要自己手工装配这些bean了。

@Configuration
publicclassLogRecordConfiguration{
@Bean
publicIOperatorGetServiceoperatorGetService(){
return()->Optional.of(OrgUserUtils.getCurrentUser())
.map(a->newOperatorDO(a.getMisId()))
.orElseThrow(()->newIllegalArgumentException("userisnull"));
}
}
//也可以这么搞：
@Service
publicclassDefaultOperatorGetServiceImplimplementsIOperatorGetService{
@Override
publicOperatorDOgetUser(){
OperatorDOoperatorDO=newOperatorDO();
operatorDO.setOperatorId("SYSTEM");
returnoperatorDO;
}
}

6.日志文案调整

对于更新等方法，方法的参数上大部分都是订单ID、或者产品ID等，

比如下面的例子：日志记录的success内容是：“更新了订单{{#orderId}},更新内容为…”，这种对于运营或者产品来说难以理解，所以引入了自定义函数的功能。

使用方法是在原来的变量的两个大括号之间加一个函数名称例如“{ORDER{#orderId}}”其中ORDER是一个函数名称。只有一个函数名称是不够的,需要添加这个函数的定义和实现。可以看下面例子

自定义的函数需要实现框架里面的IParseFunction的接口，需要实现两个方法：

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

apply()函数参数是"{ORDER{#orderId}}"中SpEL解析的#orderId的值，这里是一个数字1223110，接下来只需要在实现的类中把ID转换为可读懂的字符串就可以了，

一般为了方便排查问题需要把名称和ID都展示出来，例如："订单名称（ID）"的形式。

这里有个问题：加了自定义函数后，框架怎么能调用到呢？

答：对于Springboot应用很简单，只需要把它暴露在Spring的上下文中就可以了，可以加上Spring的@Component或者@Service很方便