--- theme: cyanosis --- 为了更方便地排查问题，电商交易系统的日志中需要记录用户id和订单id等字段。然而，每次打印日志都需要手动设置用户id，这一过程非常繁琐，需要想个办法优化下。 ```Java log.warn("user:{}, orderId:{} 订单提单成功",userId, orderId); log.warn("user:{}, orderId:{} 订单支付成功",userId, orderId); log.warn("user:{}, orderId:{} 订单收到履约请求",userId, orderId); log.warn("user:{}, orderId:{} 订单履约成功",userId, orderId); ``` ## 1. 目标打印日志时，自动填充用户id和订单Id等通参，无需手动指定 ## 2. 实现思路 1. 日志模板中声明占位符 userId，orderId 2. 在业务入口将userId放入到线程ThreadLocal本地变量中。 3. 使用SpringAop+ 注解自动将第二步的用户信息放到线程上下文 ## 3. 配置日志变量，读取上下文变量 %X{}可以自定义占位符，例如本例中使用 `userId:%X{userId} orderId:%X{orderId}`，定义了userId和orderId两个占位符。 ```XML

``` ## 4. 基于MDC 将订单和用户信息放到线程的上下文Map 为了给每个请求添加唯一标识，用户可将上下文信息放入MDC(Mapped Diagnostic Context)。 slfj 提供了MDC 类，可以将变量设置在线程上下文中，**日志框架会自动将线程上下文中的变量放置到日志占位符中**。Slf4j 作为java日志标准，log4j和logback都实现了slfj 日志标准。 MDC是基于每个线程进行管理的，允许每个服务器线程具有不同的MDC标记。MDC类中的put()和get()等操作仅影响当前线程的MDC。其他线程中的MDC不会受到影响，所以可以理解MDC是基于ThreadLocal的Map。例如下面这种方式，打印日志的效果是这样的。 ```java MDC.put("userId", userId); MDC.put("orderId", orderId); log.warn("订单履约完成"); ``` 当使用`log.warn("订单履约完成")` 方式打印日志时，代码中会自动包含userId和订单Id。 ```js 2024-08-17 21:35:38,284 [main] WARN - userId:32894934895 orderId:8497587947594859232 订单履约完成 ``` > 接下来，声明一个注解加切面，自动将用户和订单信息放到日志占位符中。 ## 5. 注解 + SpringAop，自动将UserId放到MDC 通过注解的方式，在方法执行之前自动将UserId注入到MDC中。其中的难点在于如何获取到UserId。我的思路是，方法的入参中肯定包含了UserId。可以在注解中声明UserId的获取路径，在切面中获取到UserId，并将其注入到MDC中。 ### 5.1 定义注解 ```java @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface UserLog { String userId() default ""; String orderId() default ""; } ``` 使用时，要求输入userId属性的路径。例如UserOrder中包含userId和orderId属性，则像如下方式声明。 @UserLog(userId = "userId", orderId = "orderId") public void orderPerform(UserOrder order) { log.warn("订单履约完成"); } @Data public static class UserOrder { String userId; String orderId; } ### 5.2 定义切面声明注解的Aop切面，在方法执行前，将UserId从入参中取出来，放到MDC中。全部代码如下 ```java @Aspect @Component public class UserLogAspect { @Pointcut("@annotation(UserLog) && execution(public * *(..))") public void pointcut() { } @Around(value = "pointcut()") public Object around(ProceedingJoinPoint joinPoint) throws Throwable { //无参方法不处理 Method method = ((MethodSignature) joinPoint.getSignature()).getMethod(); Object[] args = joinPoint.getArgs(); //获取注解 UserLog userLogAnnotation = method.getAnnotation(UserLog.class); if (userLogAnnotation != null && args != null && args.length > 0) { //使用工具类获取userId。 String userId = String.valueOf(PropertyUtils.getProperty(args[0], userLogAnnotation.userId())); String orderId = String.valueOf(PropertyUtils.getProperty(args[0], userLogAnnotation.orderId())); // 放到MDC中 MDC.put("userId", userId); MDC.put("orderId", orderId); } try { Object response = joinPoint.proceed(); return response; } catch (Exception e) { throw e; } finally { //清理MDC MDC.clear(); } } } ``` ### 5.3 关键代码解读 #### 5.3.1 获取UserLog注解 ```java UserLog userLogAnnotation = method.getAnnotation(UserLog.class); ``` #### 5.3.2 使用PropertyUtils.getProperty 获取userId ```java PropertyUtils.getProperty(args[0], userLogAnnotation.userId()) ``` 要注意 PropertyUtils 是commons-beanutils提供的工具类，可以指定属性的路径，自动提取属性值。如果存在多层关系，可以使用 `.` 级联取属性值。例如 info.userId，则从对象的info属性中取userId属性。 commons-beanutils commons-beanutils 1.9.4 #### 5.3.3 使用MDC设置变量和清除变量。 ```java MDC.put("userId", userId); MDC.clear(); ``` ## 6. 验证使用效果 #### 6.1 声明业务Service ```java @Service public class OrderService { public static final Logger log = LoggerFactory.getLogger(OrderService.class); @UserLog(userId = "userId", orderId = "orderId") public void orderPerform(UserOrder order) { log.warn("订单履约完成"); } @Data public static class UserOrder { String userId; String orderId; } } ``` #### 6.2 测试日志打印 @Test public void testUserLog() { OrderService.UserOrder order = new OrderService.UserOrder(); order.setUserId("32894934895"); order.setOrderId("8497587947594859232"); orderService.orderPerform(order); } #### 6.3 日志效果 ![image.png](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/92fe107d5eb1478b90e649c4a754ff30~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg5LqU6Ziz:q75.awebp?rk3s=f64ab15b&x-expires=1762322965&x-signature=Mi3oAfl1SK5Fl58ykNaR1TqmJsg%3D) ## 7. 总结不同的业务场景有不同的日志需求，一般情况下为了排查问题方便，需要唯一标识把一系列请求串联起来，使用 UserLog 注解+Aop ，自动将这部分默认参数放到日志中，可以简化业务日志打印，**极大地提高了生产力。** 另外大家可以自行扩展能力，例如自动打印出入参日志，自动上报监控打点等等。各位朋友，以上工具的关键代码不超过30行，快点试试吧。 > 欢迎点赞、收藏加关注。 # 我的开源项目最后夹带一点私货，五阳最近花了3个月的时间完成一个开源项目。开源3周以来，已有近 **230** 多个关注和Fork Gitee： GitHub [https://github.com/juejin-wuyang/memberclub](https://gitee.com/link?target=https%3A%2F%2Fgithub.com%2Fjuejin-wuyang%2Fmemberclub) 开源平台上有很多在线商城系统，功能很全，很完善，关注者众多，然而实际业务场景非常复杂和多样化，开源的在线商城系统很难完全匹配实际业务，广泛的痛点是 * 功能堆砌，大部分功能用不上，需要大量裁剪； * 逻辑差异点较多，需要大量修改； * 功能之间耦合，难以独立替换某个功能。由于技术中间件功能诉求较为一致，使用者无需过多定制化，技术中间件开源项目以上的痛点不明显，然而电商交易等业务系统虽然通用性较多，但各行业各产品的业务差异化极大，所以导致以上痛点比较明显所以我在思考，有没有一个开源系统，能提供电商交易的基础能力，能让开发者搭积木的方式，快速搭建一个完全契合自己业务的新系统呢？ * 他们可以通过编排和配置选择自己需要的功能，而无需在一个现成的开源系统上进行裁剪 * 他们可以轻松的新增扩展业务的差异化逻辑，不需要阅读然后修改原有的系统代码！ * 他们可以轻松的替换掉他们认为垃圾的、多余的系统组件，而不需要考虑其他功能是否会收到影响开发者们，可以择需选择需要的能力组件，组件中差异化的部分有插件扩展点能轻松扩展。或者能支持开发者快速的重新写一个完全适合自己的新组件然后编排注册到系统中？ memberclub 就是基于这样的想法而设计的。它的定位是电商类交易系统工具箱，以SDK方式对外提供通用的交易能力，能让开发者像搭积木方式，从0到1，快速构建一个新的电商交易系统！ ![image.png](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/617c1762a80c46aa99a406569876368f~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg5LqU6Ziz:q75.awebp?rk3s=f64ab15b&x-expires=1762322965&x-signature=ANrnUWpcTqhgyDmVOrV3zDlFS9k%3D) 具体介绍可参见 **Gitee开源地址**： **GitHub开源地址** : 在这个项目中你可以学习到 SpringBoot 集成以下框架或组件。 1. Mybatis、Mybatis-plus 集成多数据源 2. Sharding-jdbc 多数据源分库分表 3. redis/redisson 缓存 4. Apollo 分布式配置中心 5. Spring Cloud 微服务全家桶 6. RabbitMq 消息队列 7. H2 内存数据库 8. Swagger + Lombok + MapStruct 同时你也可以学习到以下组件的实现原理 1. 流程引擎的实现原理 2. 扩展点引擎实现原理 3. 分布式重试组件实现原理 4. 通用日志组件实现原理参考： 5. 商品库存实现原理：参考： 6. 分布式锁组件：参考： 7. Redis Lua的使用 8. Spring 上下文工具类参考：