跳到主要内容
版本：v4

好友（不含聊天）开发指南

本文介绍如何在游戏中加入好友系统。

权限说明​

该模块需要如下权限：

权限使用目的权限申请时机
网络权限用于访问网络数据用户首次使用该功能时会申请权限
网络状态权限用于检查网络连接状态（如 Wi-Fi 或移动数据是否可用）用户首次使用该功能时会申请权限
读取外部存储权限用于读取设备上的文件和媒体内容用户首次使用相关功能时会申请权限
写入外部存储权限用于保存文件到设备存储用户首次使用文件保存功能时会申请权限
管理外部存储权限用于管理设备上的文件用户首次使用文件管理功能时会申请权限
前台服务权限用于在应用处于后台时保持某些功能运行应用需要在后台运行服务时
相机权限用于拍摄照片和视频通话用户首次使用相机相关功能时会申请权限
振动权限用于消息通知时的振动提醒应用需要使用振动提醒时

该模块将在应用中添加如下权限：

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.VIBRATE" />

集成前准备​

参考 准备工作 创建应用、开启好友服务。

SDK 获取​

由于 TapSDK V4 依赖于 TapTapCore 核心库 以及 TapTapLogin 登录，所以需要在 TapTapCore 的基础上，另外添加 TapTapRelationLite 、 TapTapLogin 模块：

第一步：添加 SDK 所需的外部依赖​

SDK 内部使用了部分第三方库，开发者接入时需先确保 SDK 外部依赖库已正常接入，具体设置如下：

  1. SDK 使用的 JSON 解析库为 Newtonsoft-json，如果当前工程已接入该依赖库，则不需额外处理，否则需在 Packages/manifest.json 添加如下依赖：
"com.unity.nuget.newtonsoft-json":"3.2.1"
  1. SDK 使用 com.google.external-dependency-manager 管理 Android、iOS 依赖，如果当前工程已接入该依赖库，则不需额外处理，否则需在 Packages/manifest.json 添加如下依赖：
{
   "dependencies": {
      "com.google.external-dependency-manager": "1.2.179"
   },
   "scopedRegistries": [
      {
         "name": "package.openupm.com",
         "url": "https://package.openupm.com",
         "scopes": [
            "com.google.external-dependency-manager"
         ]
      }
  ]
}

第二步：添加 SDK 依赖​

SDK 支持 Unity Package Manager 及本地文件导入两种集成方式，开发者根据需求选择其中一种即可，推荐使用远程依赖。

远程依赖​

SDK 支持通过 NPMJS 及 GitHub 两种方式，开发者选择其中一种即可。

1. NPMJS 接入​

在项目的 Packages/manifest.json 文件中添加以下依赖：

"dependencies":{
  "com.taptap.sdk.core":"4.7.0",
    "com.taptap.sdk.login":"4.7.0",
    "com.taptap.sdk.relationlite":"4.7.0",
}

但需要注意的是，需在 Packages/manifest.json 中 dependencies 同级下声明 scopedRegistries：

"scopedRegistries":[
  {
    "name": "NPMJS",
    "url": "https://registry.npmjs.org/",
    "scopes": ["com.taptap"]
  }
]
2. GitHub 接入​

在项目的 Packages/manifest.json 文件中添加以下依赖：

"dependencies":{
 "com.taptap.sdk.core":"https://github.com/taptap/TapSDKCore-Unity.git#4.7.0",
   "com.taptap.sdk.login":"https://github.com/taptap/TapSDKLogin-Unity.git#4.7.0",
   "com.taptap.sdk.relationlite":"https://github.com/taptap/TapSDKRelationLite-Unity.git#4.7.0", 
}

在 Unity 顶部菜单中选择 Window > Package Manager 可查看已经安装在项目中的包。

本地文件导入​

  1. 在 下载页 下载下列模块对应 unitypackage 文件，并在 Unity 项目中依次通过 Assets > Import Packages > Custom Packages 进行导入，包括：
  • TapSDK_Core.unitypackage TapTapSDK 核心模块，必选。
  • TapSDK_Login.unitypackage TapTapSDK 登录模块，必选。
  • TapSDK_RelationLite.unitypackage TapTapSDK 好友 Lite 模块，必选。
  1. 如果当前项目已集成 Newtonsoft.Json 依赖，则忽略该步骤，否则在 NuGet.org Newtonsoft.Json 页面中通过点击右侧 「Download package」 下载库文件，并将下载的文件后缀从.nupkg 修改为 .zip，同时解压该文件并复制内部的 Newtonsoft.Json.dll 文件拷贝到工程 Assets 的 Plugins 目录下，另外为了避免导出 IL2CPP 平台时删除必要数据，需在 Assets 目录下创建 link.xml 文件（如果已有该文件，则添加如下内容），其内容如下：
<linker>
  <assembly fullname="System.Core">
    <type fullname="System.Linq.Expressions.Interpreter.LightLambda" preserve="all" />
  </assembly>
</linker>

SDK 初始化​

详见 TapTapSDK 初始化文档。

TapTapSdkOptions 详细参数见 入门指南#快速开始

using TapSDK.Core;
using TapSDK.RelationLite;

// 核心配置 详细参数见 [TapTapSDK]
TapTapSdkOptions coreOptions = new TapTapSdkOptions();
// 设置屏幕方向：0-竖屏 1-横屏
coreOptions.screenOrientation = 1;
// TapSDK 初始化
TapTapSDK.Init(coreOptions, otherOptions);

注册/注销 统一状态码监听回调​

统一状态回调，不同 code 代表不同的状态。

using TapSDK.RelationLite;

RelationLiteCallback callback = new RelationLiteCallback();
TapTapRelationLite.RegisterRelationLiteCallback(callback);
TapTapRelationLite.UnregisterRelationLiteCallback(callback);

class RelationLiteCallback : ITapTapRelationLiteCallback
{

    public RelationLiteCallback(){}

    public void OnResult(int code)
    {
        // 处理好友 SDK 的状态码
        // 700001：需要登录
        // 700002：需要授权 TapTap 好友关系权限
    }

}

邀请好友上线​

打开邀请好友页面，向选中好友发送邀请上线消息。

using TapSDK.RelationLite;

TapTapRelationLite.InviteGame();

邀请好友组队​

打开邀请好友页面，向选中好友发送邀请组队消息，需要传组队相关参数teamId。

using TapSDK.RelationLite;

string teamId = "";
TapTapRelationLite.InviteTeam(teamId);

获取好友列表​

获取当前用户的好友列表。

using TapSDK.RelationLite;

class RelationLiteRequestCallback : ITapTapRelationLiteRequestCallback
{

    public RelationLiteRequestCallback(){}

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 好友列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：好友列表请求结果
    }

    public void OnFollowingListResult(string nextPageToken, List<RelationLiteUserItem> followingList)
    {
        // 关注列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：关注列表请求结果
    }

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 粉丝列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：粉丝列表请求结果
    }

    public void OnSyncRelationshipSuccess(string openId, string unionId)
    {
        // 同步好友关系成功
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnSyncRelationshipFail(string errorMessage, string openId, string unionId)
    {
        // 同步好友关系失败
        // errorMessage：错误信息
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnRequestError(string errorMessage)
    {
        // 接口请求错误
        // errorMessage：错误信息
    }

    // 如非第一页 使用接口返回的nextPageToken
    string nextPageToken = "";
    RelationLiteRequestCallback callback = new RelationLiteRequestCallback();
    TapTapRelationLite.GetFriendsList(nextPageToken, callback);
}

获取关注列表​

获取当前用户的关注列表。

using TapSDK.RelationLite;

class RelationLiteRequestCallback : ITapTapRelationLiteRequestCallback
{

    public RelationLiteRequestCallback(){}

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 好友列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：好友列表请求结果
    }

    public void OnFollowingListResult(string nextPageToken, List<RelationLiteUserItem> followingList)
    {
        // 关注列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：关注列表请求结果
    }

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 粉丝列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：粉丝列表请求结果
    }

    public void OnSyncRelationshipSuccess(string openId, string unionId)
    {
        // 同步好友关系成功
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnSyncRelationshipFail(string errorMessage, string openId, string unionId)
    {
        // 同步好友关系失败
        // errorMessage：错误信息
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnRequestError(string errorMessage)
    {
        // 接口请求错误
        // errorMessage：错误信息
    }

    // 如非第一页 使用接口返回的nextPageToken
    string nextPageToken = "";
    RelationLiteRequestCallback callback = new RelationLiteRequestCallback();
    TapTapRelationLite.GetFollowingList(nextPageToken, callback);
}

获取粉丝列表​

获取当前用户的粉丝列表。

using TapSDK.RelationLite;

class RelationLiteRequestCallback : ITapTapRelationLiteRequestCallback
{

    public RelationLiteRequestCallback(){}

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 好友列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：好友列表请求结果
    }

    public void OnFollowingListResult(string nextPageToken, List<RelationLiteUserItem> followingList)
    {
        // 关注列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：关注列表请求结果
    }

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 粉丝列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：粉丝列表请求结果
    }

    public void OnSyncRelationshipSuccess(string openId, string unionId)
    {
        // 同步好友关系成功
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnSyncRelationshipFail(string errorMessage, string openId, string unionId)
    {
        // 同步好友关系失败
        // errorMessage：错误信息
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnRequestError(string errorMessage)
    {
        // 接口请求错误
        // errorMessage：错误信息
    }

    // 如非第一页 使用接口返回的nextPageToken
    string nextPageToken = "";
    RelationLiteRequestCallback callback = new RelationLiteRequestCallback();
    TapTapRelationLite.GetFansList(nextPageToken, callback);
}

同步好友关系（openId）​

使用好友 openId 将好友关系同步至 TapTap。

using TapSDK.RelationLite;

class RelationLiteRequestCallback : ITapTapRelationLiteRequestCallback
{

    public RelationLiteRequestCallback(){}

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 好友列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：好友列表请求结果
    }

    public void OnFollowingListResult(string nextPageToken, List<RelationLiteUserItem> followingList)
    {
        // 关注列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：关注列表请求结果
    }

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 粉丝列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：粉丝列表请求结果
    }

    public void OnSyncRelationshipSuccess(string openId, string unionId)
    {
        // 同步好友关系成功
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnSyncRelationshipFail(string errorMessage, string openId, string unionId)
    {
        // 同步好友关系失败
        // errorMessage：错误信息
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnRequestError(string errorMessage)
    {
        // 接口请求错误
        // errorMessage：错误信息
    }

    // 0-新增好友 1-删除好友
    int action = 1;
    // 当前用户昵称
    string nickname = "";
    // 好友用户昵称
    string friendNickname = "";
    // 好友openId
    string friendOpenId = "";

    RelationLiteRequestCallback callback = new RelationLiteRequestCallback();
    TapTapRelationLite.SyncRelationshipWithOpenId(action, nickname, friendNickname, friendOpenId, callback);
}

同步好友关系（unionId）​

使用好友 unionId 将好友关系同步至 TapTap。

using TapSDK.RelationLite;

class RelationLiteRequestCallback : ITapTapRelationLiteRequestCallback
{

    public RelationLiteRequestCallback(){}

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 好友列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：好友列表请求结果
    }

    public void OnFollowingListResult(string nextPageToken, List<RelationLiteUserItem> followingList)
    {
        // 关注列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：关注列表请求结果
    }

    public void OnFriendsListResult(string nextPageToken, List<RelationLiteUserItem> friendsList)
    {
        // 粉丝列表
        // nextPageToken： 下一页请求token，分页请求需传入
        // friendsList：粉丝列表请求结果
    }

    public void OnSyncRelationshipSuccess(string openId, string unionId)
    {
        // 同步好友关系成功
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnSyncRelationshipFail(string errorMessage, string openId, string unionId)
    {
        // 同步好友关系失败
        // errorMessage：错误信息
        // openId： 好友openId
        // unionId：好友unionId
    }

    public void OnRequestError(string errorMessage)
    {
        // 接口请求错误
        // errorMessage：错误信息
    }

    // 0-新增好友 1-删除好友
    int action = 1;
    // 当前用户昵称
    string nickname = "";
    // 好友用户昵称
    string friendNickname = "";
    // 好友unionId
    string friendUnionId = "";

    RelationLiteRequestCallback callback = new RelationLiteRequestCallback();
    TapTapRelationLite.SyncRelationshipWithUnionId(action, nickname, friendNickname, friendUnionId, callback);
}

展示 TapTap 用户名片​

展示指定用户的名片弹窗，可用于关注/取关用户。

using TapSDK.RelationLite;

string openId = "";
string unionId = "";
TapTapRelationLite.ShowTapUserProfile(openId, unionId);

国际化​

TapTapRelationLite 支持设置语言：目前只支持简体中文