17370845950

typing.TypeGuard 如何在类型缩小中安全使用自定义守卫
TypeGuard不触发类型缩小的根本原因是未被TS识别为类型守卫,须显式标注x is T或asserts x is T,且逻辑纯净、无污染。

为什么 TypeGuard 守卫有时不触发类型缩小?

根本原因通常是守卫函数没有被 TypeScript 编译器识别为类型守卫——常见于函数未用 assertsis 形式声明返回类型,或守卫逻辑未覆盖所有分支。比如写成 function isString(x: unknown): boolean,哪怕内部判断再严谨,TS 也不会据此缩小类型。

必须显式标注返回类型为 result is string(类型谓词)或 TypeGuard,且函数体不能有提前返回 false 后的“污染”逻辑(如后续又赋值、修改参数)。

TypeGuardasserts 的选择差异

二者都支持类型缩小,但语义和使用场景不同:

  • is 谓词(如 x is string)用于条件分支:if (isString(val)) { /* val 是 string */ }
  • asserts x is string 用于断言失败即抛错:assertString(val); /* val 是 string,否则运行时报错 */,适合校验入口参数
  • TypeGuard 是泛型工具类型,仅用于类型层面声明,不能单独“启用”缩小;它等价于 (x: any) => x is T,必须配合具体函数实现

误用 TypeGuard 直接作为返回类型而不带谓词(如 (): TypeGuard)会导致类型信息丢失——编译器无法推导守卫目标。

自定义守卫中容易踩的坑

以下写法看似合理,实则破坏类型安全:

  • 守卫函数内修改入参(如 x.foo = 'bar'),导致 TS 推断出宽泛类型(如 any 或联合类型)
  • typeof x === 'object' && x !== null 判断对象,但未进一步检查必要属性,守卫后仍不能访问 x.id(需用 inhasOwnProperty 显式确认)
  • 泛型守卫未约束输入类型,例如 function isValid(x: T): x is T & { id: number } —— 这里 T 太宽,TS 无法在调用时推导出补全字段,应改为 function isValid(x: unknown): x is { id: number } & Record
  • 在守卫中使用非纯函数(如读取全局变量、调用异步操作),导致类型守卫行为不可预测

一个安全可用的泛型对象守卫示例

下面这个守卫能正确缩小到含 idname 的对象,并兼容 undefined / null 输入:

function hasIdAndName(x: unknown): x is { id: number; nam

e: string } { return ( typeof x === 'object' && x !== null && 'id' in x && 'name' in x && typeof x.id === 'number' && typeof x.name === 'string' ); }

// 使用 declare const data: unknown; if (hasIdAndName(data)) { data.id.toFixed(); // ✅ 类型缩小生效 data.name.toUpperCase(); // ✅ }

关键点:守卫逻辑必须「只读判定」、字段检查用 in(而非可选链)、每个类型检查都显式写出,避免依赖隐式转换。泛型不是必须的——多数情况下,明确输入为 unknown 比泛型更利于类型推导。