Release 3.6.2

Author: weiqiangliu

README.md

@@ -6,7 +6,7 @@
 
 # SDK 简介
 
-SensorsAnalytics SDK 是国内第一家开源商用版用户行为采集 SDK，目前支持代码埋点、全埋点、App 点击图、可视化全埋点等。目前已累计有 1500 多家付费客户，2500+ 的 App 集成使用，作为 App 数据采集利器，致力于帮助客户挖掘更多的商业价值，为其精准运营和业务支撑提供了可靠的数据来源。其采集全面而灵活、性能良好，并一直保持稳定的迭代，经受住了时间和客户的考验。
+神策数据官方 Java 埋点 SDK，是一款轻量级用于 Java 端的数据采集埋点 SDK
 
 # 使用说明
 

SensorsAnalyticsSDK/pom.xml

@@ -15,7 +15,7 @@
     <groupId>com.sensorsdata.analytics.javasdk</groupId>
     <name>SensorsAnalyticsSDK</name>
     <artifactId>SensorsAnalyticsSDK</artifactId>
-    <version>3.6.1</version>
+    <version>3.6.2</version>
     <description>The official Java SDK of Sensors Analytics</description>
     <url>http://sensorsdata.cn</url>
 

SensorsAnalyticsSDK/src/main/java/com/sensorsdata/analytics/javasdk/ISensorsAnalytics.java

@@ -62,6 +62,13 @@ public interface ISensorsAnalytics {
      */
     void clearSuperProperties();
 
+    /**
+     * 全局接口；是否开启 $lib_detail 收集调用者信息，默认开启；在完成初始化之后，调用一次进行关闭
+     *
+     * @param enableCollectLibDetail -true:开启收集调用者信息；false 关闭收集信息，置为常量
+     */
+    void setGlobalEnableCollectMethodStack(boolean enableCollectLibDetail);
+
     /**
      * 记录事件
      *

SensorsAnalyticsSDK/src/main/java/com/sensorsdata/analytics/javasdk/SensorsAnalytics.java

@@ -77,6 +77,11 @@ void clearSuperProper() {
         log.info("Call clearSuperProperties method.");
     }
 
+    @Override
+    public void setGlobalEnableCollectMethodStack(boolean enableCollectLibDetail) {
+        worker.setEnableCollectMethodStack(enableCollectLibDetail);
+    }
+
     public SensorsAnalytics(final Consumer consumer) {
         clearSuperProper();
         worker = new SensorsAnalyticsWorker(consumer);

SensorsAnalyticsSDK/src/main/java/com/sensorsdata/analytics/javasdk/SensorsAnalyticsWorker.java

@@ -1,5 +1,12 @@
 package com.sensorsdata.analytics.javasdk;
 
+import static com.sensorsdata.analytics.javasdk.SensorsConst.DEFAULT_LIB_DETAIL;
+import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB;
+import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB_DETAIL_SYSTEM_ATTR;
+import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB_METHOD_SYSTEM_ATTR;
+import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB_SYSTEM_ATTR;
+import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB_VERSION_SYSTEM_ATTR;
+import static com.sensorsdata.analytics.javasdk.SensorsConst.SDK_VERSION;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.TRACK_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.TRACK_SIGN_UP_ACTION_TYPE;
 
@@ -8,6 +15,7 @@
 import lombok.NonNull;
 import lombok.extern.slf4j.Slf4j;
 
+import java.util.HashMap;
 import java.util.Map;
 
 @Slf4j
@@ -17,6 +25,8 @@ class SensorsAnalyticsWorker {
 
   private boolean timeFree = false;
 
+  private boolean enableCollectMethodStack = true;
+
   public SensorsAnalyticsWorker(Consumer consumer) {
     this.consumer = consumer;
     Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
@@ -30,6 +40,7 @@ public void run() {
 
   void doAddData(@NonNull SensorsData sensorsData) {
     Map<String, Object> data = SensorsData.generateData(sensorsData);
+    data.put("lib", generateLibInfo());
     if (timeFree && (TRACK_ACTION_TYPE.equals(sensorsData.getType()))
         || TRACK_SIGN_UP_ACTION_TYPE.equals(sensorsData.getType())) {
       data.put("time_free", true);
@@ -48,6 +59,7 @@ void shutdown() {
 
   public void doSchemaData(@NonNull SensorsSchemaData schemaData) {
     Map<String, Object> sensorsData = schemaData.generateData();
+    sensorsData.put("lib", generateLibInfo());
     if (timeFree && (TRACK_ACTION_TYPE.equals(schemaData.getType()))
         || TRACK_SIGN_UP_ACTION_TYPE.equals(schemaData.getType())) {
       sensorsData.put("time_free", true);
@@ -58,4 +70,27 @@ public void doSchemaData(@NonNull SensorsSchemaData schemaData) {
   public void setEnableTimeFree(boolean enableTimeFree) {
     this.timeFree = enableTimeFree;
   }
+
+  public void setEnableCollectMethodStack(boolean enableCollectMethodStack) {
+    this.enableCollectMethodStack = enableCollectMethodStack;
+  }
+
+  public Map<String, String> generateLibInfo() {
+    Map<String, String> libProperties = new HashMap<>();
+    libProperties.put(LIB_SYSTEM_ATTR, LIB);
+    libProperties.put(LIB_VERSION_SYSTEM_ATTR, SDK_VERSION);
+    libProperties.put(LIB_METHOD_SYSTEM_ATTR, "code");
+    if (enableCollectMethodStack) {
+      StackTraceElement[] trace = (new Exception()).getStackTrace();
+      if (trace.length > 3) {
+        StackTraceElement traceElement = trace[3];
+        libProperties.put(LIB_DETAIL_SYSTEM_ATTR,
+            String.format("%s##%s##%s##%s", traceElement.getClassName(), traceElement.getMethodName(),
+                traceElement.getFileName(), traceElement.getLineNumber()));
+      }
+    } else {
+      libProperties.put(LIB_DETAIL_SYSTEM_ATTR, DEFAULT_LIB_DETAIL);
+    }
+    return libProperties;
+  }
 }

SensorsAnalyticsSDK/src/main/java/com/sensorsdata/analytics/javasdk/SensorsConst.java

@@ -15,7 +15,7 @@ private SensorsConst() {
     /**
      * 当前JDK版本号，注意要和pom文件里面的version保持一致
      */
-    public static final String SDK_VERSION = "3.6.1";
+    public static final String SDK_VERSION = "3.6.2";
     /**
      * 当前语言类型
      */
@@ -82,4 +82,5 @@ private SensorsConst() {
     public static final String SIGN_UP_SYSTEM_ATTR = "$SignUp";
     public static final String TIME_FREE_ATTR = "$time_free";
 
+    public static final String DEFAULT_LIB_DETAIL="JavaSDK##generateLibInfo";
 }

SensorsAnalyticsSDK/src/main/java/com/sensorsdata/analytics/javasdk/SensorsData.java

@@ -8,7 +8,6 @@
 import com.sensorsdata.analytics.javasdk.bean.IDMUserRecord;
 import com.sensorsdata.analytics.javasdk.bean.ItemRecord;
 import com.sensorsdata.analytics.javasdk.bean.UserRecord;
-import com.sensorsdata.analytics.javasdk.util.SensorsAnalyticsUtil;
 
 import lombok.Getter;
 import lombok.Setter;
@@ -147,7 +146,6 @@ protected SensorsData(String distinctId, String originalId, Map<String, String>
     this.identities = identities;
     this.type = type;
     this.event = event;
-    this.lib = SensorsAnalyticsUtil.generateLibInfo();
     this.time = properties.containsKey(SensorsConst.TIME_SYSTEM_ATTR) ?
         (Date) properties.remove(SensorsConst.TIME_SYSTEM_ATTR) : new Date();
     this.properties = properties;
@@ -182,9 +180,6 @@ protected static Map<String, Object> generateData(SensorsData sensorsData) {
     if (sensorsData.getEvent() != null) {
       eventMap.put("event", sensorsData.getEvent());
     }
-    if (sensorsData.getLib() != null) {
-      eventMap.put("lib", sensorsData.getLib());
-    }
     // fix 【SDK-4709】time 类型保持为时间戳类型
     eventMap.put("time", sensorsData.getTime().getTime());
     if (sensorsData.getProject() != null) {

SensorsAnalyticsSDK/src/main/java/com/sensorsdata/analytics/javasdk/util/SensorsAnalyticsUtil.java

@@ -3,18 +3,12 @@
 import static com.sensorsdata.analytics.javasdk.SensorsConst.BIND_ID_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.ITEM_DELETE_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.ITEM_SET_ACTION_TYPE;
-import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB;
-import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB_DETAIL_SYSTEM_ATTR;
-import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB_METHOD_SYSTEM_ATTR;
-import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB_SYSTEM_ATTR;
-import static com.sensorsdata.analytics.javasdk.SensorsConst.LIB_VERSION_SYSTEM_ATTR;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.PROFILE_APPEND_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.PROFILE_DELETE_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.PROFILE_INCREMENT_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.PROFILE_SET_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.PROFILE_SET_ONCE_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.PROFILE_UNSET_ACTION_TYPE;
-import static com.sensorsdata.analytics.javasdk.SensorsConst.SDK_VERSION;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.TRACK_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.TRACK_SIGN_UP_ACTION_TYPE;
 import static com.sensorsdata.analytics.javasdk.SensorsConst.UNBIND_ID_ACTION_TYPE;
@@ -321,26 +315,9 @@ public static void assertFailedData(FailedData failedData) throws InvalidArgumen
       if (!dataMap.containsKey("time")) {
         dataMap.put("time", System.currentTimeMillis());
       }
-      //重置 lib,后台获取该数据时能根据 $lib_method 区分通过重发送接口上报到服务端
-      dataMap.put("lib", generateLibInfo());
     }
   }
 
-  public static Map<String, String> generateLibInfo() {
-    Map<String, String> libProperties = new HashMap<>();
-    libProperties.put(LIB_SYSTEM_ATTR, LIB);
-    libProperties.put(LIB_VERSION_SYSTEM_ATTR, SDK_VERSION);
-    libProperties.put(LIB_METHOD_SYSTEM_ATTR, "code");
-    StackTraceElement[] trace = (new Exception()).getStackTrace();
-    if (trace.length > 3) {
-      StackTraceElement traceElement = trace[3];
-      libProperties.put(LIB_DETAIL_SYSTEM_ATTR,
-          String.format("%s##%s##%s##%s", traceElement.getClassName(), traceElement.getMethodName(),
-              traceElement.getFileName(), traceElement.getLineNumber()));
-    }
-    return libProperties;
-  }
-
   public static List<Map<String, Object>> deepCopy(List<Map<String, Object>> source) {
     if (source == null) {
       return null;