HarmonyOS 组件参数类型校验怎么做才对？TypeUtil 全面实战

背景

近期发现一款很有意思的HarmonyOS 三方库, 地址 @pura/harmony-utils(V1.4.0) , 作者是"桃花镇童长老", 我这里也是直接通过该作者公布的源码进行案例编写进行,写了到目前写了一部分demo ,感觉确实很有帮助,这里呢也是开始写一个系列的演示demo 供大家参考。如有帮助可以在OpenHarmony中进行下载安装进行使用哦

案例demo导航展示

↓↓↓↓↓↓接下来言归正传 ↓↓↓↓
写通用组件的时候，最头疼的问题之一是：参数可能传各种类型，如何在运行时做精确判断？

ArkTS 的类型系统在编译时很严格，但运行时的类型判断还是需要TypeUtil来帮忙。

方法总览

综合 TypeUtil 所有方法

先快速回顾 TypeUtil Demo 里覆盖的所有方法：

基础类型：

TypeUtil.isBoolean(true)// → trueTypeUtil.isBoolean("true")// → falseTypeUtil.isNumber(42)// → trueTypeUtil.isNumber("42")// → falseTypeUtil.isString("hello")// → trueTypeUtil.isString(123)// → falseTypeUtil.isObject({a:1})// → trueTypeUtil.isArray([1,2,3])// → trueTypeUtil.isArray({})// → falseTypeUtil.isFunction(()=>{})// → true

HarmonyOS Resource 类型：

TypeUtil.isResource($r('app.string.app_name'))// → trueTypeUtil.isResource("plain string")// → falseTypeUtil.isResourceStr("text")// → trueTypeUtil.isResourceStr($r('app.string.app_name'))// → true

容器类型：

TypeUtil.isMap(newMap())// → trueTypeUtil.isMap({})// → falseTypeUtil.isWeakMap(newWeakMap())// → trueTypeUtil.isSet(newSet([1,2]))// → trueTypeUtil.isWeakSet(newWeakSet())// → true

特殊对象：

TypeUtil.isDate(newDate())// → trueTypeUtil.isDate("2024-01-01")// → falseTypeUtil.isRegExp(/abc/g)// → trueTypeUtil.isDataView(newDataView(buf))// → trueTypeUtil.isArrayBuffer(newArrayBuffer(4))// → trueTypeUtil.isUint8Array(newUint8Array())// → trueTypeUtil.isTypedArray(newFloat32Array())// → true

异步与错误：

TypeUtil.isPromise(Promise.resolve())// → trueTypeUtil.isAsyncFunction(async()=>{})// → trueTypeUtil.isAsyncFunction(()=>{})// → falseTypeUtil.isNativeError(newError('err'))// → trueTypeUtil.isNativeError("string")// → false

场景一：处理 ResourceStr 类型参数

HarmonyOS 开发中经常遇到ResourceStr = string | Resource类型的参数，需要分别处理：

// 判断是 Resource 对象this.Btn('isResource($r("app.string.app_name")) → true','#7B68EE',()=>{constres=$r('app.string.app_name');this.addLog(`isResource($r("app.string.app_name")) →${TypeUtil.isResource(res)}`);})this.Btn('isResource("plain string") → false','#7B68EE',()=>{this.addLog(`isResource("plain string") →${TypeUtil.isResource("plain string")}`);})// ResourceStr 接受两种this.Btn('isResourceStr("text") → true','#6C5CE7',()=>{this.addLog(`isResourceStr("text") →${TypeUtil.isResourceStr("text")}`);})this.Btn('isResourceStr($r("app.string.app_name")) → true','#6C5CE7',()=>{constres=$r('app.string.app_name');this.addLog(`isResourceStr($r(...)) →${TypeUtil.isResourceStr(res)}`);})

场景二：正确处理 catch 块的错误

this.Btn('isNativeError(new Error("err")) → true','#C0392B',()=>{this.addLog(`isNativeError(new Error()) →${TypeUtil.isNativeError(newError('err'))}`);})this.Btn('isNativeError("string") → false','#C0392B',()=>{this.addLog(`isNativeError("string") →${TypeUtil.isNativeError("string")}`);})

实际业务里的健壮错误处理：

functionhandleError(e:unknown):string{if(TypeUtil.isNativeError(e)){// 标准 Error 对象，访问 message 和 stackreturn(easError).message;}elseif(TypeUtil.isString(e)){// 字符串类型的错误returneasstring;}else{// 其他类型returnJSON.stringify(e);}}

场景三：判断函数是否异步

this.Btn('isAsyncFunction(async ()=>{}) → true','#6C3483',()=>{constfn=async()=>{};this.addLog(`isAsyncFunction(async ()=>{}) →${TypeUtil.isAsyncFunction(fn)}`);})this.Btn('isAsyncFunction(()=>{}) → false','#6C3483',()=>{constfn=()=>{};this.addLog(`isAsyncFunction(()=>{}) →${TypeUtil.isAsyncFunction(fn)}`);})

场景四：处理二进制数据

this.Btn('isArrayBuffer(new ArrayBuffer(4)) → true','#2C3E50',()=>{this.addLog(`isArrayBuffer(new ArrayBuffer(4)) →${TypeUtil.isArrayBuffer(newArrayBuffer(4))}`);})this.Btn('isUint8Array(new Uint8Array()) → true','#34495E',()=>{this.addLog(`isUint8Array(new Uint8Array()) →${TypeUtil.isUint8Array(newUint8Array())}`);})this.Btn('isTypedArray(new Float32Array()) → true','#626567',()=>{this.addLog(`isTypedArray(new Float32Array()) →${TypeUtil.isTypedArray(newFloat32Array())}`);})

一张图总结 TypeUtil 的使用决策树

需要判断类型？ ├── 是基础类型（boolean/number/string/object/array/function）？ │ → 用 isBoolean/isNumber/isString/isObject/isArray/isFunction ├── 是 HarmonyOS Resource 类型？ │ → 用 isResource 或 isResourceStr ├── 是容器类型（Map/Set/WeakMap/WeakSet）？ │ → 用对应的 isMap/isSet/isWeakMap/isWeakSet ├── 是特殊对象（Date/RegExp/DataView）？ │ → 用 isDate/isRegExp/isDataView ├── 是二进制数据（ArrayBuffer/TypedArray）？ │ → 用 isArrayBuffer/isUint8Array/isTypedArray 等 ├── 是异步相关（Promise/async函数）？ │ → 用 isPromise/isAsyncFunction └── 是错误对象？ → 用 isNativeError

写在最后

TypeUtil 覆盖了 HarmonyOS ArkTS 开发中几乎所有需要精确类型检测的场景。

从简单的isString、isArray，到 HarmonyOS 特有的isResource，再到isPromise、isNativeError——基本上你能想到的类型判断需求都有对应方法。

建议在项目的工具库里引入 TypeUtil，把它当成typeof的升级替代品来使用。