文档

Java SDK使用说明

更新时间:
一键部署

物联网智能视频服务提供的Java SDK,可帮助开发人员通过Java程序,更便捷地使用物联网智能视频服务提供的各种功能。本文介绍Java SDK的使用方法。

安装SDK

  1. 安装Java开发环境。您可以从Java 官方网站下载,并按说明安装Java开发环境。推荐安装Java 8及以上版本。

  2. 安装LinkVisual Java SDK。

    1. 访问Apache Maven 官网下载Maven软件。

    2. 添加Maven项目依赖。

      1. LinkVisual Java SDK的Maven依赖坐标:

        <!-- https://mvnrepository.com/artifact/com.aliyun/linkvisual20230630 -->
        <dependency>
         	<groupId>com.aliyun</groupId>
         	<artifactId>linkvisual20230630</artifactId>
         	<version>1.0.2</version>
        </dependency>
      2. 阿里云Java SDK公共包Maven依赖坐标:

        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>tea-openapi</artifactId>
            <version>0.2.2</version>
        </dependency>

    3. Java SDK源码的更多信息,请参见alibabacloud-java-sdk

初始化SDK

  1. 创建Config对象config,存放SDK初始化信息(AccessKey IDAccessKey Secret、地域ID等)。

  2. 创建Client对象实例client,通过com.aliyun.linkvisual20230630.Client(config)方法,加载config中的SDK信息,完成SDK客户端初始化。后续调用API的RequestResponse参数从com.aliyun.linkvisual20230630.models中获取。

以华东2(上海)地域接入地址为例,初始代码如下。

说明

实际使用中,需使用您的设备和App所归属的Link Visual(标准版)服务地域。

Config config = new Config();
// 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。
// 此处以把AccessKey 和 AccessKeySecret 保存在环境变量为例说明。您也可以根据业务需要,保存到配置文件里。
// 强烈建议不要把 AccessKey 和 AccessKeySecret 保存到代码里,会存在密钥泄漏风险。
config.accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
config.accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// 您的可用区ID。
config.regionId = "cn-shanghai";
//初始化SDK客户端。
Client client = new com.aliyun.linkvisual20230630.Client(config);

提示:环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET。具体操作,请参见配置环境变量

参数

说明

accessKeyId

您阿里云账号的AccessKey ID

您可在阿里云官网控制台AccessKey管理中创建或查看您的AccessKey。

accessKeySecret

您阿里云账号的AccessKey Secret

regionId

您的物联网智能视频服务的地域ID,用于拼接服务接入地址,格式为:linkvisual.${RegionId}.aliyuncs.com。

目前仅支持华东2(cn-shanghai)。

SDK客户端的HTTP请求配置、代理配置、超时机制、重试机制等配置方式,请参见阿里云V2.0 Java SDK使用指南

发起调用

物联网智能视频服务云端SDK为每个API封装两个类,分别命名为${API名称}+"Request"${API名称}+"Response",分别用于承载API的调用请求和调用结果。

调用步骤

  1. 已完成SDK客户端初始化。具体内容,请参见初始化SDK。

  2. 创建对应API的调用请求,生成${API名称}+"Request"类对象实例request

  3. 通过对象实例request,使用set+${请求参数的名称}方法,设置API所需的请求参数值。

  4. 创建${API名称}+"Response"类的对象实例response承载响应结果:使用Client对象实例client${API名称}(request)方法,获取API对应request的响应结果,包含服务端响应的bodyheaders

  5. 通过对象实例responsebody成员对象,使用get+${返回参数的名称}方法,可获取对应返回参数的值。例如:response.getBody().getSuccess()用于获取是否调用成功的标识,其中Success为API的通用返回参数。通用返回参数还包含RequestIdErrorMessageCode

  6. 使用catch()方法处理异常报错。

物联网智能视频服务云端API,请参见API列表。有关request中请求参数说明,及response中返回参数说明,请参见对应API文档。

本文以调用UploadDeviceNameList接口批量上传设备名称列表为例。请求参数信息,请参见UploadDeviceNameList

完整示例代码

说明

实际场景中,请参照上文的参数说明,替换对应参数值。

import com.aliyun.linkvisual20230630.Client;
import com.aliyun.linkvisual20230630.models.UploadDeviceNameListRequest; 
import com.aliyun.linkvisual20230630.models.UploadDeviceNameListResponse; 
import com.aliyun.tea.TeaException; 
import com.aliyun.teaopenapi.models.Config; 
import java.util.Arrays;

public class LinkvisualApiDemo {
    /**
     * 使用AK&SK初始化Client。
     */
    private static Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
        Config config = new Config();
        config.accessKeyId = accessKeyId;
        config.accessKeySecret = accessKeySecret;
        config.regionId = "cn-shanghai";
        return new Client(config);
    }

    public static void main(String[] args) {
        try {
            // 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。
            // 此处以把AccessKey 和 AccessKeySecret 保存在环境变量为例说明。您也可以根据业务需要,保存到配置文件里。
            // 强烈建议不要把 AccessKey 和 AccessKeySecret 保存到代码里,会存在密钥泄漏风险。
            Client client = createClient(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), 
                                         System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
            UploadDeviceNameListRequest request = new UploadDeviceNameListRequest()
                    .setProjectId("link***test")
                    .setProductKey("k0*****XR")
                    .setDeviceNames(Arrays.asList("device1", "device2"));

            UploadDeviceNameListResponse response = client.uploadDeviceNameList(request);
            System.out.println(response.getBody().getRequestId());
            System.out.println(response.getBody().getSuccess());
            //调用成功。
            if (response.getBody().getSuccess()) {
                //获取量产批次ID。
                System.out.println(response.getBody().getData().getBatchId());
                //处理业务逻辑。
            }
        } catch (TeaException e) {
            //获取调用失败错误码。
            System.out.println(e.getCode());
            //获取调用失败错误描述信息。
            System.out.println(e.getMessage());
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
    }
}

附录:示例代码

阿里云OpenAPI开发者门户提供API在线调试工具。在API调试页面,您可以快速检索和体验调用API。系统会根据您输入的参数同步生成各语言SDK的代码示例。各语言SDK代码示例显示在页面右侧SDK示例页签下供您参考。在调用结果页签下,可查看API调用的真实请求URL和JSON格式的返回结果。

  • 本页导读 (1)
文档反馈