补全下 tracer 组件的注释

YunaiV
1 parent 22a09d07
Showing 4 changed files with 28 additions and 24 deletions
pom.xml
src/main/java/cn/iocoder/dashboard/framework/tracer/config/BizTracerAutoConfiguration.java → src/main/java/cn/iocoder/dashboard/framework/tracer/config/TracerAutoConfiguration.java
src/main/java/cn/iocoder/dashboard/framework/tracer/annotation/BizTracing.java → src/main/java/cn/iocoder/dashboard/framework/tracer/core/annotation/BizTracing.java
src/main/java/cn/iocoder/dashboard/framework/tracer/annotation/BizTracingAop.java → src/main/java/cn/iocoder/dashboard/framework/tracer/core/annotation/BizTracingAop.java
@@ -38,7 +38,7 @@
         <lock4j.version>2.2.0</lock4j.version>
         <resilience4j.version>1.7.0</resilience4j.version>
         <!-- 监控相关 -->
-        <skywalking.version>8.4.0</skywalking.version>
+        <skywalking.version>8.5.0</skywalking.version>
         <logback.encoder.version>6.1</logback.encoder.version>
         <spring-boot-admin.version>2.3.1</spring-boot-admin.version>
         <!-- 工具类相关 -->
 package cn.iocoder.dashboard.framework.tracer.config;
-import cn.iocoder.dashboard.framework.tracer.annotation.BizTracingAop;
+import cn.iocoder.dashboard.framework.tracer.core.annotation.BizTracingAop;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@@ -9,7 +9,7 @@ import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 /**
- * BizTracer Bean 配置类
+ * Tracer 配置类
  *
  * @author mashu
  */
@@ -17,8 +17,7 @@ import org.springframework.context.annotation.Configuration;
 @ConditionalOnClass({BizTracingAop.class})
 @EnableConfigurationProperties(BizTracerProperties.class)
 @ConditionalOnProperty(prefix = "yudao.tracer", value = "enable", matchIfMissing = true)
-public class BizTracerAutoConfiguration {
-
+public class TracerAutoConfiguration {
     @Bean
     @ConditionalOnMissingBean
@@ -27,7 +26,8 @@ public class BizTracerAutoConfiguration {
     }
     @Bean
-    public BizTracingAop enableBizTracingAop() {
+    @ConditionalOnMissingBean
+    public BizTracingAop bizTracingAop() {
         return new BizTracingAop();
     }
-package cn.iocoder.dashboard.framework.tracer.annotation;
+package cn.iocoder.dashboard.framework.tracer.core.annotation;
 import java.lang.annotation.*;
-@Target({ElementType.METHOD})
-@Retention(RetentionPolicy.RUNTIME)
-@Inherited
-
 /**
- * 打印业务流水号/业务类型注解
+ * 打印业务编号 / 业务类型注解
  *
  * @author 麻薯
  */
+@Target({ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
 public @interface BizTracing {
     /**
-     * 交易流水tag名
+     * 业务编号 tag 名
      */
-    String BIZ_ID_TAG = "bizId";
+    String ID_TAG = "biz.id";
     /**
-     * 交易类型tag名
+     * 业务类型 tag 名
      */
-    String BIZ_TYPE_TAG = "bizType";
+    String TYPE_TAG = "biz.type";
-    String bizId();
+    /**
+     * @return 业务编号
+     */
+    String id();
-    String bizType();
+    /**
+     * @return 业务类型
+     */
+    String type();
 }
-package cn.iocoder.dashboard.framework.tracer.annotation;
+package cn.iocoder.dashboard.framework.tracer.core.annotation;
 import cn.hutool.core.util.StrUtil;
 import cn.iocoder.dashboard.util.sping.SpElUtil;
@@ -7,7 +7,6 @@ import org.apache.skywalking.apm.toolkit.trace.ActiveSpan;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
-import org.springframework.context.annotation.Configuration;
 /**
  * 业务链路AOP切面
@@ -20,14 +19,14 @@ public class BizTracingAop {
     @Around(value = "@annotation(bizTracing)")
     public void tagBizInfo(ProceedingJoinPoint joinPoint, BizTracing bizTracing) {
-        String bizId = (String) SpElUtil.analysisSpEl(bizTracing.bizId(), joinPoint);
-        String bizType = (String) SpElUtil.analysisSpEl(bizTracing.bizType(), joinPoint);
+        String bizId = (String) SpElUtil.analysisSpEl(bizTracing.id(), joinPoint);
+        String bizType = (String) SpElUtil.analysisSpEl(bizTracing.type(), joinPoint);
         if (StrUtil.isBlankIfStr(bizId)) {
             log.error("empty biz: bizId[{}], bizType[{}].", bizId, bizType);
             return;
         }
         log.info("accept biz: bizId[{}], bizType[{}].", bizId, bizType);
-        ActiveSpan.tag(BizTracing.BIZ_ID_TAG, bizId);
-        ActiveSpan.tag(BizTracing.BIZ_TYPE_TAG, bizType);
+        ActiveSpan.tag(BizTracing.ID_TAG, bizId);
+        ActiveSpan.tag(BizTracing.TYPE_TAG, bizType);
     }
 }