Skip to content

C# SDK 安装指南

安装

.NET Framework

.NET Framework 支持以下运行时：

  • Classic Desktop 4.5+
  • Windows 10
  • Windows Phone 不再支持
  • UWP 4.5+
  • .NET Core 2.0+

在 Visual Studio 执行安装 nuget 依赖：

PM> Install-Package LeanCloud

Xamarin

请确保你的项目至少满足如下版本需求：

在 Xamarin Studio 或者 Visual Studio for Mac 上执行如下 nuget 指令：

PM> Install-Package LeanCloud

Mono for Unity

  • Unity 5.3+

不支持 Unity 5.3 以下版本的原因是：Unity 官方在 5.3 之后支持了 UnityWebRequest 类，并且建议开发者都使用此类进行 HTTP 请求的发送，因此我们遵照官方设定，摒弃原来的 WWW，改用新的 UnityWebRequest 来实现底层的 HTTP Client。

请前往 Unity Storage 以及 Unity Realtime 下载最新版本的 zip 包，解压之后导入到你的 Unity 项目中。

Unity Storage 和 Unity Realtime 本质上只相差一个 DLL 文件：LeanCloud.Realtime.dll，因此如果你不需要使用即时通讯模块，可以只下载 Unity Storage。

依赖详解

安装之后，你的项目会依赖如下内容：

名称 模块描述 必选
AssemblyLister.dll LeanCloud 依赖检测模块，它负责检查相关依赖是否正确加载 是
LeanCloud.Core.dll 核心库，里面包含了 AVObject 和 AVUser 等所有内置类型的定义和序列化相关操作的功能 是
LeanCloud.Storage.dll 存储库，里面包含本地缓存以及 HTTP 请求发送的实现 是
LeanCloud.Realtime.dll 即时通讯库，里面包含了即时通讯协议的实现以及相关接口 否
LeanCloud.LiveQuery.dll LiveQuery 库，里面包含实时数据同步的实现和相关接口 否
LeanCloud.Analytics.dll 数据统计库，里面包含了实现数据统计分析的实现和相关接口 否

如果你的项目不需要使用即时通讯，就可以删除对 LeanCloud.Realtime.dll 的依赖，或者在引入的时候在 nuget 里面执行如下指令，则 IDE 只会加载核心和存储模块，并不会导入即时通讯模块：

PM> Install-Package LeanCloud.Storage

另外我们也提供了指定安装即时通讯模块的 nuget 包：

PM> Install-Package LeanCloud.Realtime

如果希望使用实时数据同步功能（LiveQuery），请执行如下 nuget 命令行来自动安装所有必要的依赖（例如即时通讯模块）：

Install-Package LeanCloud.LiveQuery

安装数据统计分析库需要执行如下命令行：

Install-Package LeanCloud.Analytics

配置 SDK

.NET Framework & Xamarin

在应用程序入口函数添加如下代码：

// 如果只使用存储可以使用如下初始化代码 
AVClient.Initialize("此处填写应用的 appId", "此处填写应用的 appKey");

假设还需要使用聊天，请使用如下代码：

var realtime = new AVRealtime("此处填写应用的 appId", "此处填写应用的 appKey");

如果使用了即时通讯初始化的代码，就不需要再次调用 AVClient.Initialize，因为在聊天初始化的时候会调用它。

私有部署

针对私有部署的服务器地址是根据部署之后的域名而对应生成的，因此在初始化 SDK 的时候需要单独配置服务器地址。

AVClient.Configuration 包含了如下属性：

属性名 含义 示例
ApiServer 数据存储服务的私有部署地址 https://abc-api.xyz.com
PushServer 推送服务的私有部署地址 https://abc-push.xyz.com
StatsServer 统计服务的私有部署地址 https://abc-stats.xyz.com
EngineServer 云引擎（云函数）私有部署地址 https://engine-stats.xyz.com

与即时通讯相关的私有部署配置 AVRealtime.Configuration 包含了如下属性：

属性名 含义 示例
RTMRouter 分配最终 WebSocket 地址的云端路由地址 https://abc-rtmrouter.xyz.com
RealtimeServer 最终的 WebSocket 地址 wss://abc-wss.xyz.com

注意：当设置了 RealtimeServer 之后，它拥有最高优先级，SDK 不会再去请求 RTMRouter 来申请动态（负载均衡）的 WebSocket 地址。

私有部署示例

假设购买了数据存储和即时通讯的私有部署，在私有部署的相关配置手册上我们会给出最终生产环境的地址，例如：

在 SDK 初始化时需要进行如下设置：

数据存储服务： 

AVClient.Initialize(new AVClient.Configuration
{
    ApplicationId = "你的 app id",
    ApplicationKey = "你的 app key",
    ApiServer = new Uri("https://abc-api.xyz.com") // 告知 SDK 所有的数据存储服务请求都发往这个地址
});
即时通讯服务：

var realtime = new AVRealtime(new AVRealtime.Configuration
{
    ApplicationId = "你的 app id",
    ApplicationKey = "你的 app key",
    RTMRouter = new Uri("https://abc-rtmrouter.xyz.com") // 告知 SDK 去这个地址请求动态的 WebSocket 地址
});

也存在一种可能性，私有部署中根据用户需求只部署了一台 WebSocket 服务器作为即时通讯服务器。假如配置手册上给出的内容如下：

在配置即时通讯的时候需要做如下修改：

var realtime = new AVRealtime(new AVRealtime.Configuration
{
    ApplicationId = "你的 app id",
    ApplicationKey = "你的 app key",
    RealtimeServer = new Uri("wss://abc-wss.xyz.com") // 告知 SDK 直接连这个地址的 WebSocket 服务，不用再去请求 RTMRouter 了
});

Unity

初始化必须在 Unity Editor 上将 AVInitializeBehaviour 挂载在某一个 GameObject 下，如下图：

AVInitializeBehaviour

假设还需要使用即时通讯，请在任意一个 MonoBehaviour 启动的时候调用如下代码：

var realtime = new AVRealtime("此处填写应用的 appId", "此处填写应用的 appKey");

在 Unity 中使用即时通讯，一定先要先初始化存储模块，然后初始化即时通讯模块，这两步都必须做。