Java

提示

在接入前, 请先阅读接入前准备。

Java SDK最低兼容 JDK 8 版本

最新版本为：v3.0.0

更新时间为：2023-11-29

资源下载: 源代码 (opens new window)

注意

当前文档适用于 v3.0.0 及以后的版本，历史版本请参考 Java SDK 接入指南（V2） (opens new window)

一、集成SDK

1. 使用 Maven 集成 SDK，请在pom.xml文件中置入以下依赖信息:

<dependencies>
    // others...
    <dependency>
        <groupId>cn.thinkingdata</groupId>
        <artifactId>thinkingdatasdk</artifactId>
        <version>3.0.0</version>
    </dependency>
</dependencies>

1. 安装Logbus

   我们推荐使用SDK+LogBus的形式，完成服务端数据的采集上报.您可以参考以下文档完成Logbus的安装:LogBus使用指南

二、初始化

以下是SDK初始化的示例代码:

TDAnalytics te = new TDAnalytics(new TDLoggerConsumer("LOG_DIRECTORY"), false);

LOG_DIRECTORY为数据写入的文件夹路径。

三、常用功能

为了保证访客 ID 与账号 ID 能够顺利进行绑定，如果您的游戏中会用到访客 ID 与账号 ID，我们极力建议您同时上传这两个 ID，否则将会出现账号无法匹配的情况，导致用户重复计算，具体的 ID 绑定规则可参考用户识别规则一章。

3.1 发送事件

您可以调用track来上传事件，建议您根据先前梳理的文档来设置事件的属性以及发送信息的条件，以下是发送事件的示例代码:

//设置事件属性
HashMap<String,Object> properties = new HashMap<>();
// 设置用户的ip地址，TE系统会根据IP地址解析用户的地理位置信息
properties.put("#ip", "192.168.1.1");//字符串
properties.put("channel","te");//字符串
properties.put("age",1);//数字
properties.put("isSuccess",true);//布尔
properties.put("birthday",new Date());//时间

HashMap<String,Object>  object = new HashMap<>();
object.put("key", "value");
properties.put("object",object);//对象

HashMap<String,Object> object1 = new HashMap<>();
object1.put("key", "value");

ArrayList<Object> arr = new ArrayList<>();
arr.add(object1);
properties.put("object_arr",arr);//对象组

ArrayList<String> arr1 = new ArrayList<>();
arr1.add("value");
properties.put("arr",arr1);//数组

try {
    te.track("account_id","distinct_id","payment",properties);
} catch (Exception e) {
    System.out.println("except:"+e);
}

• 事件的名称是字符串类型，只能以字母开头，可包含数字，字母和下划线 "_"，长度最大为 50 个字符。
• Key 为该属性的名称，为字符串类型，规定只能以字母开头，包含数字，字母和下划线 "_"，长度最大为 50 个字符，对字母大小写不敏感,TE会统一转化为小写字母
• Value 为该属性的值，支持字符串、数字、布尔、时间、对象、对象组、数组

用户属性的要求与事件属性保持一致

3.2 设置用户属性

对于一般的用户属性，您可以调用 userSet 来进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：

//此时username为TA
Map<String,Object> userProperties = new HashMap<String,Object>();
userProperties.put("user_name", "TA");
try {
   te.userSet("account_id","distinct_id",userProperties);
} catch (Exception e) {
  System.out.println("except:"+e);
}
 
//此时userName为TE
Map<String,Object> newUserProperties = new HashMap<String,Object>();
newUserProperties.put("user_name", "TE");
try {
   te.userSet("account_id","distinct_id",newUserProperties);
} catch (Exception e) {
  System.out.println("except:"+e);
}

四、最佳实践

以下示例代码包含以上所有操作，我们推荐按照如下步骤使用:

//初始化SDK, LOG_DIRECTORY 为写入本地的文件夹地址
TDAnalytics te = new TDAnalytics(new TDLoggerConsumer("LOG_DIRECTORY"), false);

//设置事件属性
HashMap<String,Object> properties = new HashMap<>();
// 设置用户的ip地址，TE系统会根据IP地址解析用户的地理位置信息
properties.put("#ip", "192.168.1.1");//字符串
properties.put("channel","te");//字符串
properties.put("age",1);//数字
properties.put("isSuccess",true);//布尔
properties.put("birthday",new Date());//时间

HashMap<String,Object>  object = new HashMap<>();
object.put("key", "value");
properties.put("object",object);//对象

HashMap<String,Object> object1 = new HashMap<>();
object1.put("key", "value");

ArrayList<Object> arr = new ArrayList<>();
arr.add(object1);
properties.put("object_arr",arr);//对象组

ArrayList<String> arr1 = new ArrayList<>();
arr1.add("value");
properties.put("arr",arr1);//数组

try {
    te.track("account_id","distinct_id","payment",properties);
} catch (Exception e) {
    System.out.println("except:"+e);
}

//设置用户属性
Map<String,Object> userProperties = new HashMap<String,Object>();
userProperties.put("user_name", "TE");
try {
   te.userSet("account_id","distinct_id",userProperties);
} catch (Exception e) {
  System.out.println("except:"+e);
}
//调用flush接口数据会立即写入文件，生产环境注意避免频繁调用flush引发IO或网络开销问题
te.flush();