Thingsboard自定义订阅服务使用指南：解决数据订阅中的常见错误

概述

在使用Thingsboard平台开发自定义小部件时，数据订阅服务(subscriptionApi)是一个强大的工具，它允许开发者灵活地获取和处理设备数据。然而，许多开发者在初次使用createSubscription方法时会遇到两个典型的错误："Cannot read properties of undefined (reading 'data')"和"Cannot read properties of null (reading 'aggregation')"。本文将深入分析这些错误的原因，并提供完整的解决方案。

错误现象分析

当开发者尝试使用subscriptionApi.createSubscription方法创建数据订阅时，虽然API调用返回成功，但小部件会抛出以下两类错误：

1. 数据读取错误：表明系统无法读取返回数据的data属性
2. 聚合配置错误：表明系统无法读取聚合(aggregation)配置

这些错误通常源于订阅配置不完整，特别是与时间窗口(timewindow)相关的配置缺失。

根本原因

经过分析，这些错误并非Thingsboard平台的bug，而是由于开发者对createSubscription方法的配置理解不足导致的。关键在于subscriptionOptions中的两个相关配置项：

1. useDashboardTimewindow：决定是否使用仪表板的时间窗口配置
2. timeWindowConfig：自定义时间窗口的详细配置

当useDashboardTimewindow设置为false时，必须提供完整的timeWindowConfig配置，否则系统无法确定如何聚合和获取数据。

解决方案

方案一：使用仪表板时间窗口配置

这是最简单的解决方案，只需将useDashboardTimewindow设置为true：

subscriptionOptions = {
    // 其他配置...
    "useDashboardTimewindow": true,
    // 其他配置...
}

这种方式的优势是：

• 自动继承仪表板的时间窗口设置
• 当仪表板时间窗口变化时，订阅会自动更新
• 无需维护额外的时间窗口配置

方案二：自定义时间窗口配置

如果需要独立于仪表板的时间窗口，可以保留useDashboardTimewindow为false，但必须提供完整的timeWindowConfig：

const timeWindowConfig = {
  "displayValue": "",
  "hideInterval": false,
  "hideLastInterval": false,
  "hideQuickInterval": false,
  "hideAggregation": false,
  "hideAggInterval": false,
  "hideTimezone": false,
  "selectedTab": 0,
  "realtime": {
    "realtimeType": 0,
    "interval": 1000,
    "timewindowMs": 60000,
    "quickInterval": "CURRENT_DAY"
  },
  "history": {
    "historyType": 0,
    "interval": 1000,
    "timewindowMs": 60000,
    "fixedTimewindow": {
      "startTimeMs": 1742402900292,
      "endTimeMs": 1742489300292
    },
    "quickInterval": "CURRENT_DAY"
  },
  "aggregation": {
    "type": "AVG",
    "limit": 25000
  }
};

subscriptionOptions = {
    // 其他配置...
    "useDashboardTimewindow": false,
    "timeWindowConfig": timeWindowConfig,
    // 其他配置...
}

这种方式的优势是：

• 完全控制数据获取的时间范围
• 不受仪表板时间窗口变化的影响
• 可以针对特定需求定制聚合方式

最佳实践建议

1. 明确需求：首先确定是否需要独立的时间窗口配置，大多数情况下使用仪表板配置即可

2. 配置完整性检查：确保所有必需的配置项都已提供，特别是当useDashboardTimewindow为false时

3. 错误处理：在subscribe回调中添加错误处理逻辑，便于调试

4. 性能考虑：自定义时间窗口时，注意数据量大小和聚合配置，避免获取过多数据影响性能

完整示例代码

self.onInit = function() {
    // 方案一：使用仪表板时间窗口
    const option1 = {
        "type": "timeseries",
        "datasources": [...],
        "useDashboardTimewindow": true
    };
    
    // 方案二：自定义时间窗口
    const timeWindowConfig = {...}; // 如上文所示
    const option2 = {
        "type": "timeseries",
        "datasources": [...],
        "useDashboardTimewindow": false,
        "timeWindowConfig": timeWindowConfig
    };
    
    self.ctx.subscriptionApi.createSubscription(option1, true).subscribe(
        (subscription) => {
            console.log("订阅创建成功");   
        },
        (error) => {
            console.error("订阅创建失败:", error);
        }
    );
    self.ctx.detectChanges();
}

通过理解这些配置项的作用和相互关系，开发者可以避免常见的订阅配置错误，更高效地利用Thingsboard平台的数据订阅功能。