准备工作
接入安全 SDK,开发者需要完成以下步骤:
i. 根据游戏运行平台和支持的 CPU 架构将 SDK 动态库拷贝到指定工程目录。
ii. 根据游戏 ID 和用户登录信息调用 SDK 接口函数。
iii. 验证 SDK 接入是否正确。
安全 SDK 在开发语言为 C/C++ 的 Android 系统下接入需要的相关文件有以下:
tp2.cstp2.jar (Android)libtersafe2.so (Android)
需要申请的权限:
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/><uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /><uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /><uses-permission android:name="android.permission.GET_TASKS" /><uses-permission android:name="android.permission.INTERNET" />
SDK 接口函数:
初始化接口 Tp2SdkInitEx用户登录接口 Tp2UserLogin前后台切换接口 Tp2SetGamestatus
添加 SDK 文件到工程
添加文件
1. 将 sdk\\Android\\c# 目录下的 tp2.cs 放在工程的 Assets 目录下。
2. 将 sdk\\Android\\c# 目录下的 tp2.jar 放在工程的 Assets\\Plugins\\Android 目录下。
3. 多 CPU:
以 Unity5.0 为例,如果游戏支持 Android 多 CPU 架构 (目前只支持 arm-v7a 和 x86),将 sdk\\Android\\c#\\lib 目录下的 armeabi 和 x86 文件夹下的 libtersafe2.so 分别拷贝到以下目录:
Assets/Plugins/Android/libs/armeabi-v7a/Assets/Plugins/Android/libs/x86/
4. 单 CPU 架构:
如果游戏只支持 arm-v7,以 Unity4.5 为例,将 SDK 提供的 tp2.jar 和 armeabi-v7a 目录下的 libtersafe2.so 两个文件放在 / Assets/Plugins/Android / 目录下即可。
工程属性设置
多 CPU 架构支持时选择 [File] -> [Build settings] -> [Player Settings] -> [Other Settings] -> [Device Filter] -> [FAT(ARMv7+x86)]。
![](https://mc.qcloudimg.com/static/img/c94b432701454a02efdc3a2110902fa6/image.png)
SDK 接口调用
初始化函数
函数原型
void Tp2SdkInitEx (int gameId, string appKey);
参数说明
参数 | 是否必须 | 说明 |
gameId | 是 | 由腾讯云官网分配的 game_id |
appKey | 是 | 由腾讯云官网分配 game_key,与 game_id 对应 |
gameId 和 appKey 在腾讯云官网(xxxxxxxxxxxx)注册完新游戏后自动生成。
返回值:0 表示调用成功。
设置用户信息
函数原型
void Tp2UserLogin (int account_type, int world_id , String open_id, String role_id);
参数说明
参数 | 说明 |
account_type | 与运营平台相关的账号类型,参考下文的 TssSdkEntryId 填写 |
world_id | 用户游戏角色的大区信息 |
open_id | 用户唯一身份标识,可自定义字符串(和处罚相关必须填写) |
role_id | 区分用户创建的不同角色的标识 |
account_type 默认 QQ 平台填 1,微信平台填 2,其他平台填 99。国内外主流账号登录平台可参考以下数值填写。
enum TssSdkEntryId{ENTRY_ID_QZONE = 1, // QQENTRY_ID_MM = 2, // 微信ENTRT_ID_FACEBOOK = 3, // facebookENTRY_ID_TWITTER = 4, // twitterENTRY_ID_LINE = 5, // lineENTRY_ID_WHATSAPP = 6, // whatsappENTRY_ID_OTHERS = 99, // 其他平台};
world_id 由游戏自定义,如果游戏没有分区可填 0。
role_id 用于区分同一账号同一分区下的不同角色,如果没有角色区分可填””。
open_id 由所在运营平台分配,用于唯一区分用户。
返回值:0 表示调用成功。
设置游戏状态
函数原型
void Tp2SetGamestatus (Tp2Status status);
参数说明
参数 | 说明 |
status | 前台 Tp2Status. FRONTEND 后台 Tp2Status. BACKEND |
枚举类型
public enum Tp2Status{FRONTEND = 1, // 前台BACKEND = 2 // 后台}
返回值:0 表示调用成功。
调用时机
1. Tp2SdkInitEx 在游戏启动的第一时间调用,参数为游戏 ID 和 appKey 信息。更早时机调用安全接口函数可以更安全的保护游戏进程。
2. Tp2UserLogin 在游戏获取到用户授权的登录信息后调用,如果游戏有设置大区 ID 和角色 ID,则在获取大区 ID 和角色 ID 之后再调用 Tp2UserLogin 函数。在游戏过程中,如果出现断线重连,用户注销重新登录等需要重新获取用户登录信息的情况,也需要再次调用该函数。传递的参数为用户的账号信息,可自定义。
3. Tp2SetGamestatus 在游戏切换前后台调用。当游戏从后台切换到前台运行时调用 Tp2SetGamestatus 接口,设置参数为 Tp2Status. FRONTEND。当游戏切从前台切换到后台时传递参数为 Tp2Status. BACKEND。SDK 部分功能在切换到后台时停止运行,因此该接口将影响 SDK 功能是否正常。
示例代码
void Awake (){Tp2Sdk.Tp2SdkInitEx(8888, "d5ab8dc7ef67ca92e41d730982******");}// 用户登录后调用void Start (){int accountType = (int)Tp2Entry.ENTRY_ID_QZONE ; /* 账号类型 */int worldId = 100; /* 大区 ID*/string openId = "B73B36366565F9E******"; /* 用户 id*/string roleId = "paladin"; /* 角色 ID*/Tp2Sdk.Tp2UerLogin(accountType, worldId, openId, roleId);}// 游戏切换前后台调用void OnApplicationPause (bool pause){if (pause){Tp2Sdk.Tp2SetGamestatus(Tp2Status. BACKEND); // 切换到后台}else{Tp2Sdk.Tp2SetGamestatus(Tp2Status. FRONTEND); // 切换回前台}}
验证 SDK 接入是否正确
1. 将 Android 手机通过 usb 数据线连接 Windows 电脑。连接成功后,使用 Windows 的命令行工具,登录到 Android adb 控制台,如图:
![](https://mc.qcloudimg.com/static/img/091f2d44b4862e843748fdd9655e9914/image.png)
![](https://mc.qcloudimg.com/static/img/091f2d44b4862e843748fdd9655e9914/image.png)
2. 敲入 cd /sdcard 回车,再敲入 mkdir sdk 回车,用于创建 / sdcard/sdk 目录。其中,如果目录已经存在,则系统会提示 mkdir failed for /sdcard/sdk,File exists,继续下一步。、
![](https://mc.qcloudimg.com/static/img/748c74c2ef3f5bec2a650f3d8eb0bdc6/image.png)
![](https://mc.qcloudimg.com/static/img/748c74c2ef3f5bec2a650f3d8eb0bdc6/image.png)
3. cd /sdcard/sdk 进入目录,echo > enable.log 创建 enable.log 空文件。
![](https://mc.qcloudimg.com/static/img/26aa6733a77a4c2625d131cddba47b89/image.png)
有的机型可能无法访问 shell 创建的目录下的文件,这种情况请切换为 root 用户更改 / sdcard/sdk 目录权限或更换手机
![](https://mc.qcloudimg.com/static/img/91cd8bb85e88eede943d47570a792c35/image.png)
![](https://mc.qcloudimg.com/static/img/26aa6733a77a4c2625d131cddba47b89/image.png)
![](https://mc.qcloudimg.com/static/img/91cd8bb85e88eede943d47570a792c35/image.png)
4. 运行游戏并登录用户,查看 / data/data/log 目录会生成日志文件 tp2.log 和 tlog.log,如图:
![](https://mc.qcloudimg.com/static/img/3ce91cbdb15cdb72998fbfcc2bdf074e/image.png)
如果没有生成日志,请检查 / sdcard/sdk 和 enable.log 是否有读写权限。少部分机型无法读写这个目录,可更换机型测试或将 / sdcard/sdk 改为 / data/data/log(需要 root)。
![](https://mc.qcloudimg.com/static/img/3ce91cbdb15cdb72998fbfcc2bdf074e/image.png)
注意:
enable.log 只用于测试使用。
5. 打开 tp2.log 文件,检查日志中是否包含三个接口(native)信息 tp2_sdk_init_ex,tp2_setuserinfo,setgamestatus 以及 jar 包版本号 jar_ver。以上条件必须都满足才能正确运行安全 SDK。setgamestatus:1 表示当前进程运行在前台,setgamestatus:2 表示当前进程运行在后台。
请测试 App 切换前后台,查看接口调用是否正确。除了接口调用,还要检查用户信息 (userinfo) 是否填写正确。
![](https://mc.qcloudimg.com/static/img/75eef4a35cf89e8e1d02be304403377b/image.png)
![](https://mc.qcloudimg.com/static/img/75eef4a35cf89e8e1d02be304403377b/image.png)
6. 打开 tlog.log 可查看安全 SDK 发送的数据,如图:
![](https://mc.qcloudimg.com/static/img/50526870e79bb4d21d5b5bb0c333f86f/image.png)
安全 SDK 除了在初始化时会上报一些进程基本信息,还会根据定期的安全扫描结果来发送数据,例如扫描到 App 证书签名不正确,内存被修改,外挂进程正在运行等信息。tlog.log 记录 SDK 发送的数据(只在测试时生成),一般 1 小时的数据是 20K 左右,可以查看 tlog.log 的大小来统计安全 SDK 发送的数据量。
![](https://mc.qcloudimg.com/static/img/50526870e79bb4d21d5b5bb0c333f86f/image.png)