"用户互动策略平台" / 帮助文档 / 系统配置 / 数据采集 / java数据采集
3.1.9 JAVA SDK使用简介(maven方式)
第一步 在项目中引用 touty-java-sdk
<dependency>
<groupId>io.touty.sdk</groupId>
<artifactId>ty-java-sdk</artifactId>
<version>1.0.0</version>
<dependency>
第二步 其他依赖引用 (依您的项目 部分情况可跳过)
touty-java-sdk 基于以下原因,需要您在项目中引用以下依赖,如果依赖已经存在于您的项目中,可跳过相关依赖的引用,版本仅做参考,可根据您的实际项目需要版本来确定
httpClient客户端,touty-java-sdk 需要将您需要追踪的数据通过HTTP方式传送给服务器 org.apache.httpcomponents httpclient 4.5.2
fastJson, touty-java-sdk 传输数据采用json格式,因此采用了fastJson将您的数据便捷的转化成json格式 com.alibaba fastjson 1.2.58
slf4j, touty-java-sdk 的相关日志采用 【slf4j + 您的日志具体实现】的方式来输出
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.25</version> </dependency>
由于 slf4j 只是日志的接口层, 因此需要您在项目中加入 具体的日志实现比如log4j的相关jar包 比如 log4j-1.2.x.jar 同时,你还需要 引入 slf4j 和 日志实现比如log4j 的桥接包 比如 slf4j-log4j12-1.x.x.jar
第三步 创建 ToutyTraker 对象
ToutyTraker 提供了两个初始化的方法
1. ToutyTraker.getInstance\(String appKey\) ,这是您默认应该使用的方法
2. ToutyTraker.getInstance\(String appKey,String serverUrl\)
其中:
appKey 是您从 Touty平台获取的,Touty平台通过appKey来匹配您的数据,将其传入您的平台上的创建的项目中 serverUrl 是数据提交的服务器地址,默认是Touty平台的数据入口地址https://hook.touty.io/sa
注意!!!
由于ToutyTraker采用全局单例的方式,因为无论您采用哪种方式初始化 ToutyTraker,后续再调用 ToutyTraker 的其他 getInstance方法 都不会再重新创建,也不会更新 appKey 和 serverUrl,因此请确保您在第一次创建 ToutyTraker 时传递了您想要传入的参数
第四步 调用 ToutyTraker 的 trace 方法,来追踪 您希望传递给Touty平台的用户事件
trace 方法所需参数:
- clientId 必需字段 您系统中的用户ID或者用户识别号
- eventType 必需字段 该用户事件的事件类型,可以是任何您定义的事件类型,比如 点击(click),订单(order) 等等
- targetId 必需字段 事件所对应的目标ID, 比如点击时,对应的是点击按钮的Id, 订单时对应的是 订单ID ..
- targetName 必需字段 targetId 的描述,方便您能直观的明白 此次用户事件的具体对象
- props 非必需字段 用于存储您想传递的其他任何信息 props 类型为 Map<String,Object> ,其中object 应当是诸如 字符串,数值,布尔,列表,Map, 或者pojo等简单类型