refactor:【antd】【iot】设备管理跟后端对齐，必要的 ReqVO、RespVO，子设备管理实现

2026-01-04 12:25:25 +08:00
parent f7f01c9280
commit de28c5c4c2
16 changed files with 537 additions and 141 deletions
--- a/apps/web-antd/src/api/iot/device/device/index.ts
+++ b/apps/web-antd/src/api/iot/device/device/index.ts
@@ -3,39 +3,76 @@ import type { PageParam, PageResult } from '@vben/request';
 import { requestClient } from '#/api/request';

 export namespace IotDeviceApi {
-  // TODO @haohao：需要跟后端对齐，必要的 ReqVO、RespVO
-  /** 设备 */
-  export interface Device {
-    id?: number; // 设备 ID，主键，自增
+  /** 设备新增/修改 Request VO */
+  export interface DeviceSaveReqVO {
+    id?: number; // 设备编号
    deviceName: string; // 设备名称
+    nickname?: string; // 备注名称
+    serialNumber?: string; // 设备序列号
+    picUrl?: string; // 设备图片
+    groupIds?: number[]; // 设备分组编号数组
+    productId: number; // 产品编号（必填）
+    gatewayId?: number; // 网关设备 ID
+    config?: string; // 设备配置
+    locationType: number; // 定位类型（必填）
+    latitude?: number; // 设备位置的纬度
+    longitude?: number; // 设备位置的经度
+  }
+
+  /** 设备更新分组 Request VO */
+  export interface DeviceUpdateGroupReqVO {
+    ids: number[]; // 设备编号列表（必填）
+    groupIds: number[]; // 分组编号列表（必填）
+  }
+
+  /** 设备分页 Request VO */
+  export interface DevicePageReqVO extends PageParam {
+    deviceName?: string; // 设备名称
+    nickname?: string; // 备注名称
+    productId?: number; // 产品编号
+    deviceType?: number; // 设备类型
+    status?: number; // 设备状态
+    groupId?: number; // 设备分组编号
+    gatewayId?: number; // 网关设备 ID
+  }
+
+  /** 设备 Response VO */
+  export interface DeviceRespVO {
+    id: number; // 设备编号
+    deviceName: string; // 设备名称
+    nickname?: string; // 设备备注名称
+    serialNumber?: string; // 设备序列号
+    picUrl?: string; // 设备图片
+    groupIds?: number[]; // 设备分组编号数组
    productId: number; // 产品编号
    productKey?: string; // 产品标识
    deviceType?: number; // 设备类型
-    nickname?: string; // 设备备注名称
    gatewayId?: number; // 网关设备 ID
    state?: number; // 设备状态
-    status?: number; // 设备状态（兼容字段）
    onlineTime?: Date; // 最后上线时间
    offlineTime?: Date; // 最后离线时间
    activeTime?: Date; // 设备激活时间
-    createTime?: Date; // 创建时间
-    ip?: string; // 设备的 IP 地址
-    firmwareVersion?: string; // 设备的固件版本
-    deviceSecret?: string; // 设备密钥，用于设备认证，需安全存储
-    mqttClientId?: string; // MQTT 客户端 ID
-    mqttUsername?: string; // MQTT 用户名
-    mqttPassword?: string; // MQTT 密码
-    authType?: string; // 认证类型
-    locationType?: number; // 定位类型
+    deviceSecret?: string; // 设备密钥，用于设备认证
+    authType?: string; // 认证类型（如一机一密、动态注册）
+    config?: string; // 设备配置
+    locationType?: number; // 定位方式
    latitude?: number; // 设备位置的纬度
    longitude?: number; // 设备位置的经度
-    areaId?: number; // 地区编码
-    address?: string; // 设备详细地址
-    serialNumber?: string; // 设备序列号
-    config?: string; // 设备配置
-    groupIds?: number[]; // 添加分组 ID
-    picUrl?: string; // 设备图片
-    location?: string; // 位置信息（格式：经度,纬度）
+    createTime?: Date; // 创建时间
+  }
+
+  /** 设备认证信息 Response VO */
+  export interface DeviceAuthInfoRespVO {
+    clientId: string; // 客户端 ID
+    username: string; // 用户名
+    password: string; // 密码
+  }
+
+  /** 设备导入 Response VO */
+  export interface DeviceImportRespVO {
+    createDeviceNames?: string[]; // 创建成功的设备名称列表
+    updateDeviceNames?: string[]; // 更新成功的设备名称列表
+    failureDeviceNames?: Record<string, string>; // 失败的设备名称及原因
  }

  /** IoT 设备属性详细 VO */
@@ -56,30 +93,17 @@ export namespace IotDeviceApi {
    updateTime: Date; // 更新时间
  }

-  /** 设备认证参数 VO */
-  export interface DeviceAuthInfo {
-    clientId: string; // 客户端 ID
-    username: string; // 用户名
-    password: string; // 密码
-  }
-
  /** 设备发送消息 Request VO */
  export interface DeviceMessageSendReq {
    deviceId: number; // 设备编号
    method: string; // 请求方法
    params?: any; // 请求参数
  }
-
-  /** 设备分组更新请求 */
-  export interface DeviceGroupUpdateReq {
-    ids: number[]; // 设备 ID 列表
-    groupIds: number[]; // 分组 ID 列表
-  }
 }

 /** 查询设备分页 */
-export function getDevicePage(params: PageParam) {
-  return requestClient.get<PageResult<IotDeviceApi.Device>>(
+export function getDevicePage(params: IotDeviceApi.DevicePageReqVO) {
+  return requestClient.get<PageResult<IotDeviceApi.DeviceRespVO>>(
    '/iot/device/page',
    { params },
  );
@@ -87,38 +111,40 @@ export function getDevicePage(params: PageParam) {

 /** 查询设备详情 */
 export function getDevice(id: number) {
-  return requestClient.get<IotDeviceApi.Device>(`/iot/device/get?id=${id}`);
+  return requestClient.get<IotDeviceApi.DeviceRespVO>(
+    `/iot/device/get?id=${id}`,
+  );
 }

 /** 新增设备 */
-export function createDevice(data: IotDeviceApi.Device) {
-  return requestClient.post('/iot/device/create', data);
+export function createDevice(data: IotDeviceApi.DeviceSaveReqVO) {
+  return requestClient.post<number>('/iot/device/create', data);
 }

 /** 修改设备 */
-export function updateDevice(data: IotDeviceApi.Device) {
-  return requestClient.put('/iot/device/update', data);
+export function updateDevice(data: IotDeviceApi.DeviceSaveReqVO) {
+  return requestClient.put<boolean>('/iot/device/update', data);
 }

 /** 修改设备分组 */
-export function updateDeviceGroup(data: IotDeviceApi.DeviceGroupUpdateReq) {
-  return requestClient.put('/iot/device/update-group', data);
+export function updateDeviceGroup(data: IotDeviceApi.DeviceUpdateGroupReqVO) {
+  return requestClient.put<boolean>('/iot/device/update-group', data);
 }

 /** 删除单个设备 */
 export function deleteDevice(id: number) {
-  return requestClient.delete(`/iot/device/delete?id=${id}`);
+  return requestClient.delete<boolean>(`/iot/device/delete?id=${id}`);
 }

 /** 删除多个设备 */
 export function deleteDeviceList(ids: number[]) {
-  return requestClient.delete('/iot/device/delete-list', {
+  return requestClient.delete<boolean>('/iot/device/delete-list', {
    params: { ids: ids.join(',') },
  });
 }

 /** 导出设备 */
-export function exportDeviceExcel(params: any) {
+export function exportDeviceExcel(params: IotDeviceApi.DevicePageReqVO) {
  return requestClient.download('/iot/device/export-excel', { params });
 }

@@ -129,16 +155,22 @@ export function getDeviceCount(productId: number) {

 /** 获取设备的精简信息列表 */
 export function getSimpleDeviceList(deviceType?: number, productId?: number) {
-  return requestClient.get<IotDeviceApi.Device[]>('/iot/device/simple-list', {
-    params: { deviceType, productId },
-  });
+  return requestClient.get<IotDeviceApi.DeviceRespVO[]>(
+    '/iot/device/simple-list',
+    {
+      params: { deviceType, productId },
+    },
+  );
 }

 /** 根据产品编号，获取设备的精简信息列表 */
 export function getDeviceListByProductId(productId: number) {
-  return requestClient.get<IotDeviceApi.Device[]>('/iot/device/simple-list', {
-    params: { productId },
-  });
+  return requestClient.get<IotDeviceApi.DeviceRespVO[]>(
+    '/iot/device/simple-list',
+    {
+      params: { productId },
+    },
+  );
 }

 /** 获取导入模板 */
@@ -148,10 +180,13 @@ export function importDeviceTemplate() {

 /** 导入设备 */
 export function importDevice(file: File, updateSupport: boolean) {
-  return requestClient.upload('/iot/device/import', {
-    file,
-    updateSupport,
-  });
+  return requestClient.upload<IotDeviceApi.DeviceImportRespVO>(
+    '/iot/device/import',
+    {
+      file,
+      updateSupport,
+    },
+  );
 }

 /** 获取设备属性最新数据 */
@@ -172,7 +207,7 @@ export function getHistoryDevicePropertyList(params: any) {

 /** 获取设备认证信息 */
 export function getDeviceAuthInfo(id: number) {
-  return requestClient.get<IotDeviceApi.DeviceAuthInfo>(
+  return requestClient.get<IotDeviceApi.DeviceAuthInfoRespVO>(
    '/iot/device/get-auth-info',
    { params: { id } },
  );