Skip to main content

Java SDK 介绍

Java SDK 是 AIRIOT 物联网平台提供的 Java 语言的二次开发工具包, 可使用 Java SDK 调用平台开放的接口和实现对平台功能的扩展。

接下来会分别介绍如何使用 Java SDK 开发自定义数据接入驱动、开发自定义流程插件、算法集成和通过平台接口客户端实现系统集成。

内容说明​

内容用途
自定义数据接入驱动实现从设备或其它平台系统采集数据功能
自定义流程插件扩展流程引擎中的节点
算法集成扩展或集成已有算法到平台
平台接口客户端调用平台对外提供的数据接口
日志收集使用 SDK 中的日志组件输出的日志, 可以被平台收集并在平台的 系统日志 模块中查看

SDK 内容列表​

包名描述
sdk-dependencies统一依赖管理
sdk-driver-starter提供自定义数据接入驱动开发的相关内容. 包括驱动的接口定义, 以及与平台交互功能
sdk-flow-plugin-starter提供自定义流程引擎插件开发的相关内容. 包括与流程引擎交互的具体实现和数据交互格式的定义等
sdk-algorithm-starter提供算法接入的相关内容. 可以扩展平台算法或将已经算法集成到平台
sdk-client-api平台接口客户端定义. 包括: 空间管理、项目中的用户、部门、工作表、数据接口等内容的操作接口
sdk-client-http-starter平台接口客户端 http 实现
sdk-logger-starter平台系统日志组件库. 该组件库中提供了平台定义的日志输出格式, 由该组件库输出的日志可以被平台收集和并在 系统日志 模块中查看
info

sdk-client-api 包无须手动导入, 在引入平台客户端实现包(例如: sdk-client-http-starter) 时会自动导入.

使用方式​

您可以通过 Maven 或 Gradle 管理配置 SDK 的版本，Maven 的配置示例如下:

<dependencies>
    <dependency>
        <groupId>io.github.air-iot</groupId>
        <artifactId>sdk-driver-starter</artifactId>
        <version>4.x.x</version>
    </dependency>
</dependencies>

在同时使用 SDK 中的多个模块时, 可以使用 sdk-dependencies 统一管理版本, 方式如下:

<dependencies>
    <!-- 数据接入驱动开发 SDK -->
    <dependency>
        <groupId>io.github.air-iot</groupId>
        <artifactId>sdk-driver-starter</artifactId>
    </dependency>
    <!-- 流程插件开发 SDK -->
    <dependency>
        <groupId>io.github.air-iot</groupId>
        <artifactId>sdk-flow-plugin-starter</artifactId>
    </dependency>
    <!-- 流程扩展节点开发 SDK -->
    <dependency>
        <groupId>io.github.air-iot</groupId>
        <artifactId>sdk-flow-extension-starter</artifactId>
    </dependency>
    <!-- 算法集成 SDK -->
    <dependency>
        <groupId>io.github.air-iot</groupId>
        <artifactId>sdk-algorithm-starter</artifactId>
    </dependency>
    <!-- 平台接口 http 客户端 -->
    <dependency>
        <groupId>io.github.air-iot</groupId>
        <artifactId>sdk-client-http-starter</artifactId>
    </dependency>
    <!-- 系统日志组件库 -->
    <dependency>
        <groupId>io.github.air-iot</groupId>
        <artifactId>sdk-logger-starter</artifactId>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <!-- 统一依赖版本管理 -->
        <dependency>
            <groupId>io.github.air-iot</groupId>
            <artifactId>sdk-dependencies</artifactId>
            <version>4.x.x</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
info

注: SNAPSHOT 版本的 SDK 为开发版本, 可能会带有一些不稳定的新功能, 请谨慎使用.

为了确保依赖版本的一致性, 建议使用 sdk-dependencies 统一管理版本.

版本说明​

SDK 版本Java 版本SpringBoot 版本
4.1.x1.8+2.7.8