编辑文档更新于 2019-01-24

Java SDK 安装指南

获取 SDK

获取 SDK 有多种方式，较为推荐的方式是通过包依赖管理工具下载最新版本。

包依赖管理工具安装

通过 maven 配置相关依赖

    <dependencies>
        <dependency>
            <groupId>cn.leancloud</groupId>
            <artifactId>java-sdk</artifactId>
            <version>0.1.6</version>
        </dependency>
    </dependencies>

或者通过 gradle 配置相关依赖

dependencies {
  compile("cn.leancloud:java-sdk:0.1.6")
}

手动安装

下载 SDK

初始化

首先进入控制台 > 设置 > 应用 Key 来获取 App ID 以及 App Key。

然后导入 leancloud，并在 main 函数中调用 AVOSCloud.initialize 方法进行初始化：

public static void main(String[] args){
    // 参数依次为 AppId、AppKey、MasterKey
    AVOSCloud.initialize("{{appid}}","{{appkey}}","{{masterkey}}");
}

开启调试日志

在应用开发阶段，你可以选择开启 SDK 的调试日志（debug log）来方便追踪问题。调试日志开启后，SDK 会把网络请求、错误消息等信息输出到 IDE 的日志窗口，或是浏览器 Console 或是 LeanCloud 控制台的云引擎日志中。

// 放在 SDK 初始化语句 AVOSCloud.initialize() 后面，只需要调用一次即可
AVOSCloud.setDebugLogEnabled(true);

在应用发布之前，请关闭调试日志，以免暴露敏感数据。

启用指定节点

SDK 的初始化方法默认使用中国大陆节点，如需切换到其他可用节点，请参考如下用法：


public static void main(String[] args){
        // 启用北美节点
        AVOSCloud.useAVCloudUS();
        // 初始化参数依次为 AppId, AppKey, MasterKey
        AVOSCloud.initialize("{{appid}}","{{appkey}}","{{masterkey}}");
}

全球节点

中国大陆节点 leancloud.cn（SDK 初始化方法默认使用该节点）
北美节点 us.leancloud.cn（服务北美市场）

各个节点彼此独立，开发者账号无法跨节点来创建应用或调用 API。

验证

首先，确认本地网络环境是可以访问 LeanCloud 服务器的，可以执行以下命令行：

ping "{{domain}}"

如果当前网路正常将会得到如下响应：

PING api-ucloud.leancloud.cn (123.59.41.31): 56 data bytes
64 bytes from 123.59.41.31: icmp_seq=0 ttl=51 time=9.032 ms
64 bytes from 123.59.41.31: icmp_seq=1 ttl=51 time=7.290 ms
64 bytes from 123.59.41.31: icmp_seq=2 ttl=51 time=8.131 ms
64 bytes from 123.59.41.31: icmp_seq=3 ttl=51 time=9.689 ms
64 bytes from 123.59.41.31: icmp_seq=4 ttl=51 time=6.559 ms
64 bytes from 123.59.41.31: icmp_seq=5 ttl=51 time=8.665 ms
64 bytes from 123.59.41.31: icmp_seq=6 ttl=51 time=8.041 ms
64 bytes from 123.59.41.31: icmp_seq=7 ttl=51 time=8.203 ms
64 bytes from 123.59.41.31: icmp_seq=8 ttl=51 time=6.288 ms
64 bytes from 123.59.41.31: icmp_seq=9 ttl=51 time=7.938 ms

--- api-ucloud.leancloud.cn ping statistics ---
10 packets transmitted, 10 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 6.288/7.984/9.689/0.997 ms

然后在项目中编写如下测试代码：

     AVObject testObject = new AVObject("TestObject");
     testObject.put("words","Hello World!");
     testObject.save();

然后打开控制台 > 存储 > 数据 > TestObject，如果看到如下内容，说明 SDK 已经正确地执行了上述代码，安装完毕。

testobject_saved

如果控制台没有发现对应的数据，请参考问题排查。

问题排查

SDK 安装指南基于当前最新版本的 SDK 编写，所以排查问题前，请先检查下安装的 SDK 是不是最新版本。

401 Unauthorized

如果 SDK 抛出 401 异常或者查看本地网络访问日志存在：

{
  "code": 401,
  "error": "Unauthorized."
}

则可认定为 App ID 或者 App Key 输入有误，或者是不匹配，很多开发者同时注册了多个应用，导致拷贝粘贴的时候，用 A 应用的 App ID 匹配 B 应用的 App Key，这样就会出现服务端鉴权失败的错误。

客户端无法访问网络

客户端尤其是手机端，应用在访问网络的时候需要申请一定的权限。