跳到主要内容

服务开放

概述​

Beaver IoT 平台提供了一些通用的服务接口，用于集成开发者实现集成的业务逻辑。包括集成服务、设备服务、实体服务、实体值服务等。

DeviceServiceProvider 接口文档​

Beaver IoT 平台提供了DeviceServiceProvider接口，提供常用的设备操作方法。

save ​

保存设备(包括保存设备下的实体)

方法签名​

void save(Device device);

deleteById​

根据设备id删除设备

方法签名​

void deleteById(Long id);

findById​

根据设备ID查找设备

方法签名​

Device findById(Long id);

findByKey​

根据设备key查找设备

方法签名​

Device findByKey(String deviceKey);

findByIdentifier​

根据设备标识查找设备

方法签名​

Device findByIdentifier(String identifier, String integrationId);

findAll​

根据集成ID查找所有设备

方法签名​

    List<Device> findAll(String integrationId);

findByIdentifier​

根据设备标识、集成ID查找设备

方法签名​

   Device findByIdentifier(String identifier, String integrationId);

findAll​

根据集成ID查找设备列表

方法签名​

   List<Device> findAll(String integrationId);

EntityServiceProvider 接口文档​

Beaver IoT 平台提供了EntityServiceProvider接口，提供常用的entity操作方法。

findByTargetId ​

根据目标类型和目标ID获取实体列表

目标

目标包括设备AttachTargetType.DEVICE和集成AttachTargetType.INTEGRATION

方法签名​

    List<Entity> findByTargetId(AttachTargetType targetType, String targetId);

findByTargetIds​

根据目标类型和目标ID集合获取实体列表

方法签名​

    List<Entity> findByTargetIds(AttachTargetType targetType, List<String> targetIds);

save ​

保存实体

方法签名​

    void save(Entity entity);

batchSave​

批量保存实体

方法签名​

    void batchSave(List<Entity> entityList);

deleteByTargetId​

根据目标的ID删除实体

方法签名​

    void deleteByTargetId(String targetId);

findByKey​

根据实体key查找实体

方法签名​

    Entity findByKey(String entityKey);

findByKeys​

根据实体key集合查找实体

方法签名​

    Map<String, Entity> findByKeys(String... entityKeys);

findById​

根据实体id查找实体

方法签名​

    Entity findById(Long entityId);

findByIds​

根据实体id集合查找实体

方法签名​

List<Entity> findByIds(List<Long> ids);

EntityValueServiceProvider 接口文档​

Beaver IoT 平台提供了EntityValueServiceProvider接口，提供常用的entity最新值和历史值的操作方法。

saveValuesAndPublishSync​

保存实体值并且同步发布事件

方法签名​

使用默认事件类型

EventResponse saveValuesAndPublishSync(ExchangePayload exchangePayload);

可自定义事件类型

EventResponse saveValuesAndPublishSync(ExchangePayload exchangePayload, String eventType);

saveValuesAndPublishAsync​

保存实体值并且异步发布事件

方法签名​

使用默认事件类型

EventResponse saveValuesAndPublishAsync(ExchangePayload exchangePayload);

可自定义事件类型

EventResponse saveValuesAndPublishAsync(ExchangePayload exchangePayload, String eventType);

saveValues​

保存实体最新值

方法签名​

    void saveValues(Map<String, Object> values, long timestamp);

saveValues​

保存实体最新值（上报时间为当前时间）

方法签名​

    void saveValues(Map<String, Object> values);

saveHistoryRecord​

保存实体历史值

方法签名​

    void saveHistoryRecord(Map<String, Object> recordValues, long timestamp);

saveHistoryRecord​

保存实体历史值（上报时间为当前时间）

方法签名​

    void saveHistoryRecord(Map<String, Object> recordValues);

findValueByKey​

根据实体key查找当前值

方法签名​

    Object findValueByKey(String key);

findValuesByKeys​

根据实体key集合查找当前值

方法签名​

    Map<String, Object> findValuesByKeys(List<String> keys);

findValuesByKeys​

根据实体ke查找父实体下子实体的当前值

方法签名​

    @NonNull <T extends ExchangePayload> T findValuesByKey(String key, Class<T> entitiesClazz);

IntegrationServiceProvider 接口文档​

IntegrationServiceProvider 接口定义了与集成配置相关的操作方法。

save​

保存集成（包括保存集成下的实体）

方法签名​

void save(Integration integrationConfig);

batchSave​

批量保存集成

方法签名​

void batchSave(Collection<Integration> integrationConfig);

getIntegration​

根据集成id获取集成实例（包含未启用）

方法签名​

Integration getIntegration(String integrationId);

getActiveIntegration​

根据集成id获取启用的集成实例

方法签名​

Integration getActiveIntegration(String integrationId);

findIntegrations​

查找所有集成列表

方法签名​

Collection<Integration> findIntegrations();

代码示例​

findActiveIntegrations​

查找所有启用的集成列表

方法签名​

List<Integration> findActiveIntegrations();

代码示例​

findIntegrationsWithPredicate​

根据条件查找集成列表

方法签名​

List<Integration> findIntegrations(Predicate<Integration> predicate);

代码示例​

查找所有能够添加设备的集成

List<Integration> integrations = integrationServiceProvider.findIntegrations(f -> StringUtils.hasText(f.getEntityKeyAddDevice()));