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

最新推荐文章于 2024-09-13 22:29:24 发布
最新推荐文章于 2024-09-13 22:29:24 发布
阅读量426 收藏
点赞数
文章标签： 数据库 java spring spring boot redis 
此组件解决的问题是：「谁」在「什么时间」对「什么」做了「什么事」

本组件目前针对 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);
    }
}

日志埋点

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-biz-log

Author

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

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

-END-
如果看到这里，说明你喜欢这篇文章，请 转发、点赞。微信搜索「web_resource」，关注后回复「进群」或者扫描下方二维码即可进入无广告交流群。
↓扫描二维码进群↓

推荐阅读 
1.  一份 Spring Boot 项目搭建模板
2.  Spring Boot 实现应用监控和报警
3.  Nginx 从入门到实战
4.  一键式搭建分布式文件服务器
5.  团队开发中 Git 最佳实践

喜欢文章，点个在看 
SpringBoot基于Aop实现自定义日志注解（提供Gitee源码）
黄团团的个人博客
06-17 1960
日志在我们的日常开发当中是必定会用到的，在每个方法的上都会习惯性打上@Log注解，这样系统就会自动帮我们记录日志，整体的代码结构就会非常优雅，这边我自己搭建了一个demo去实现了一些这个项目当中必定会用的功能。
《滚雪球学Spring Boot》教程导航帖（更新于2024.06.20）
热门推荐
**My Coding Family**
06-29 4万+
《滚雪球学Spring Boot》是由CSDN博主bug菌创作的全面Spring Boot教程。作者是全栈开发专家，在多个技术社区如CSDN、掘金、InfoQ、51CTO等担任博客专家，并拥有超过30万的全网粉丝。该教程分为入门篇和进阶篇，每篇包含详细的教学步骤，涵盖Spring Boot的基础和高级主题。
爽！一个注解，搞定 SpringBoot 操作日志
m0_52987358的博客
02-23 1034
来源：blog.csdn.net/weixin_43954303/article/details/113781801 使用方式 基本使用 源码 此组件解决的问题是：「谁」在「什么时间」对「什么」做了「什么事」 本组件目前针对 Spring-boot 做了 Autoconfig，如果是 SpringMVC，也可自己在 xml 初始化 bean 使用方式 基本使用 maven依赖添加SDK依赖 <dependency> <groupId>io.gi
springboot下日志注解开发
jiyuean的博客
01-06 1042
springboot，日志注解，aop，el表达式
mzt-biz-log：Spring Boot下的智能操作日志管理组件
最新发布
gitblog_09315的博客
09-13 531
mzt-biz-log：Spring Boot下的智能操作日志管理组件 mzt-biz-log 支持Springboot，基于注解的可使用变量、可以自定义函数的通用操作日志组件 项目地址: https://gitcode.com/...
springboot—日志注解
weixin_30467087的博客
08-15 374
作用： 1.生成文档。这是最常见的，也是java 最早提供的注解。常用的有 @see @param @return 等2..跟踪代码依赖性，实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。3.在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检...
Springboot集成注解日志切面
攀登Fox的博客
01-01 150
目录1、引入依赖2、自定义注解3、日志切面4、使用方式5、效果 1、引入依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> 2、自定义注解 package com.exampl
Spring Boot入门(21)：轻松搞定日志记录！Spring Boot入门之Log4j2整合及配置详解
**My Coding Family**
08-26 1727
Spring Boot如何整合Log4j2日志框架，一文带你吃透它。
一个注解搞定，记录项目日志
java_beautiful的博客
06-20 2212
最近正在录制 TienChin 项目视频～采用 Spring Boot+Vue3 技术栈，里边会涉及到各种好玩的技术，小伙伴们来和我一起做一个完成率超 90% 的项目。 前段时间做了一个支线任务，现在还是回到我们的主线上面来，继续完成 TienChin 项目。 小伙伴们知道我最近在录制 TienChin 项目视频教程，这是一个基于 RuoYi-Vue 脚手架的项目，用过这个脚手架的小伙伴可能知道，这个脚手架有一个功能，就是如果你需要记录下来一个接口的操作信息，那么只需要在 Controller 接口中加
一个小小的注解，帮你搞定 SpringBoot 操作日志
JavaMBa的博客
07-08 770
此组件解决的问题是： 「谁」在「什么时间」对「什么」做了「什么事」 本组件目前针对 Spring-boot 做了 Autoconfig，如果是 SpringMVC，也可自己在 xml 初始化 bean 使用方式 基本使用 maven 依赖添加 SDK 依赖 <dependency> <groupId>io.github.mouzt</groupId> <artifactId>bizlog-sdk</artifactId> <ver
Spring Boot入门(04)：实现多环境配置文件切换，轻松搞定不同环境部署问题
**My Coding Family**
08-13 3万+
在使用Spring Boot进行应用开发时，部署到不同的环境下会面临不同的配置问题。为了解决这个问题，可以使用多环境配置文件切换。这样可以轻松地切换不同环境下的配置，避免因环境不一致而引发的问题，提高应用的可靠性和稳定性。本文将介绍如何在Spring Boot中实现多环境配置文件切换，为读者解决不同环境部署的问题。
SpringBoot 一个注解，搞定业务操作日志记录
weixin_45738731的博客
06-21 802
业务操作日志记录中包含了用户操作的功能名称、功能描述、操作人、操作时间和操作的参数报文，参数报文之所以选择存储在文件中，是因为正常情况下，是不需要知道具体的参数报文，只有在回滚操作的时候才会用到，可以根据上一次的参数报文逆向操作。
spring boot 日志记录-注解式
先天牛马圣体
02-07 729
2020年，悲伤！ 那天，我突然好想打球。 前言 上篇文章主要是针对性的日志记录，这篇文章为切面式的日志记录。总体结构为通过自定义注解的方式，通过 aop 切点拦截来实现日志记录。 项目源码：https://github.com/XGLLHZ/springboot-frame.git 正文 1、首先我们需要一个日志实体类。像主键、操...
springboot 自定义日志注解
tumu6889的博客
06-28 2592
SpringBoot自定义注解
SpringBoot 自定义日志注解
daixinmei
07-28 547
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) @Documented public @interface LogPrint { String description() default ""; } @Slf4j @Aspect @Component public class LogPrintAspect { /** * 以自定义 @LogPrint 注解为切点 */ @Point
springboot自定义日志注解实现日志管理
dxjren的博客
10-18 1255
springBoot，AOP切面实现日志记录，自定义注解，注解属性动态传参
基于springboot自定义日志注解
qq_40905367的博客
03-08 280
使用AOP实现自定义的日志注解 最近在学习反射和注解的使用，以及AOP思想，觉得自定义注解挺好玩的，在此记录一下学习经验 1.自定义注解 2.自定义AOP切面 3.使用自定义注解 自定义注解 //配置注解的使用范围，可以是数组类型 //这里配置的METHOD是表示可以使用再方法上，具体可以查看ElementType类 @Target(ElementType.METHOD) //配置注解的有效期 RUNTIME表示运行期时有效 @Retention(RetentionPolicy.RUNTIME) publi
SpringBoot AOP实现日志注解
wertd_fgegg的博客
10-30 211
背景 对于页面关键操作进行日志记录 实现方式：自定义注解+AOP 引入aop包 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> 自定义注解 package com.example.shiro.annotation; imp
SpringBoot通过自定义注解记录日志
qq_33140257的博客
03-20 900
1.自定义注解类 Loggable@Target({ElementType . METHOD }) //注解作用于方法级别 @Retention(RetentionPolicy . RUNTIME) //运行时起作用 public @interface Loggable {/*** 是否输出日志/*** 日志信息描述,可以记录该方法的作用等信息。/*** 请求所属模块。/*** 日志类型，可能存在多种接口类型都需要记录日志，比如dubbo接口，web接口/**
Spring Boot AOP实践：自定义注解与日志管理
通过Spring Boot的AOP和自定义注解，我们可以创建一个更模块化、可维护的系统，减少代码重复，提高开发效率。这种最佳实践方式让开发者能够专注于核心业务逻辑，而将通用功能如日志记录委托给AOP处理。在实际项目中...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值