一个注解搞定 Spring Boot 日志！还有谁不会？

时间  2021-03-26
标签 java git github web 面试 spring 数据库 mvc intellij-idea app 栏目 Spring 繁體版
原文   原文链接

此组件解决的问题是：java

「谁」在「什么时间」对「什么」作了「什么事」git

本组件目前针对 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 就能够github

@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 最新教程推荐看下面这个。web

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”spring

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. 日志支持种类

好比一个订单的操做日志，有些操做日志是用户本身操做的，有些操做是系统运营人员作了修改产生的操做日志，咱们系统不但愿把运营的操做日志暴露给用户看到，mvc

可是运营指望能够看到用户的日志以及运营本身操做的日志，这些操做日志的bizNo都是订单号，因此为了扩展添加了类型字段,主要是为了对日志作分类，查询方便，支持更多的业务。intellij-idea

@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() 方法。app

若是保存 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开发手册（嵩山版）》最新发布，速速下载！

以为不错，别忘了随手点赞+转发哦！

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程