目录

可选属性显式设置为undefined报401无效参数

问题现象

在BLE蓝牙应用开发过程中,调用携带可选参数的接口时,如果将可选属性显式设置为undefined,比如startScan,(在对象字面量中写入manufactureId: undefined),接口会抛出错误码401(Invalid parameter),提示无效参数。

问题原因

bleScanner.startScan等接口的底层由C/C++实现。在应用侧调用这些接口时,参数会通过NAPI传递到系统底层进行解析:

解决方案

为避免跨语言调用时的严格类型校验问题,对于可选参数,建议遵循按需挂载原则(没有有效值就不写键)。

示例代码

以bleScanner.startScan接口为例,示例代码如下:

import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';
import { ble } from '@kit.ConnectivityKit';

let manufactureId: number | undefined = undefined; // 模拟实际业务中可能为空的值
let manufactureData: Uint8Array = new Uint8Array([1, 2, 3, 4]);
let manufactureDataMask: Uint8Array = new Uint8Array([0xFF, 0xFF, 0xFF, 0xFF]);

// 将undefined直接写入对象字面量(会返回401错误码)
// let scanFilter: ble.ScanFilter = {
//     manufactureId: undefined,
//     manufactureData: manufactureData.buffer,
//     manufactureDataMask: manufactureDataMask.buffer
// };

// 推荐:只初始化确定有值的属性
let scanFilter: ble.ScanFilter = {
    manufactureData: manufactureData.buffer,
    manufactureDataMask: manufactureDataMask.buffer
};

// 通过动态判断,仅在值有效时才将其挂载到对象上
if (manufactureId !== undefined) {
    scanFilter.manufactureId = manufactureId;
}

let bleScanner: ble.BleScanner = ble.createBleScanner();

function onReceiveEvent(scanReport: ble.ScanReport) {
    console.info('BLE scan device find result = ' + JSON.stringify(scanReport));
}

let scanOptions: ble.ScanOptions = {
    interval: 500,
    dutyMode: ble.ScanDuty.SCAN_MODE_LOW_POWER,
    matchMode: ble.MatchMode.MATCH_MODE_AGGRESSIVE,
    reportMode: ble.ScanReportMode.FENCE_SENSITIVITY_LOW
};

try {
    bleScanner.on("BLEDeviceFind", onReceiveEvent);
    bleScanner.startScan([scanFilter], scanOptions);
    console.info('startScan success');
} catch (err) {
    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}