TypeScript - 作为类型保护的属性装饰器

Question

我想知道在TypeScript中是否可以使用属性装饰器作为类型保护，以确保该属性不是null | 未定义。

让我们假设有以下示例。

class MyClass {
   @isRequired()
   public myProperty: string | undefined;
} 

请注意string | undefined 由于严格的编译器设置(strictNullChecks)，必须写入string | undefined 。 因此，仅使用string作为类型是不可能的。 我知道可以像这样使用非空断言： public myProperty:: string 。 但这实际上是装饰者应该注意的。

最后，装饰器基本上检查属性是否设置在特定时间点，如果没有则抛出错误。 这种检查显然不是在构建时进行的，否则就不需要这种方法。 它在不久之后执行 - 例如在 Angular 等框架的lifcylce挂钩中。 我知道类型检查在构造函数本身中是不正确的。 不过我可以接受。 如果检查成功，则属性的类型应缩小为string ，因此您可以安全地使用它，例如this.property.split(" ") 。

我想知道这样的事情在理论上是否可行？ 提前致谢。

Answer 1

不，这目前在 TypeScript 中是不可能的； 装饰器不会改变他们装饰的东西的类型。 在microsoft/TypeScript#4881中有一个长期的建议允许这样做，但该问题对于此类功能的确切工作方式存在重大分歧。

更重要的是，在装饰器提案到达TC39 流程的第 3 阶段以引入 JavaScript 之前，不太可能对装饰器在 TypeScript 中的工作方式进行任何更改。 一般来说，TypeScript 仅在它们是相对稳定的候选对象时才尝试支持潜在的 JavaScript 功能。 装饰器是TypeScript 的早期特性之一，但这么早采用特性有缺点； 在某些时候，装饰者可能会以与 TypeScript 最初预期的方式截然不同的形式进入 JavaScript，然后 TypeScript 将不得不进行重大更改。 现在您必须启用--experimentalDecorators编译器选项才能使用它们。 看起来装饰器已经在第 2 阶段停滞了很长时间（至少……三、四年？）。 所以现在，我不希望有任何改变。

---

那么，如果您需要此功能，您可以做些什么呢？ 好吧，您总是可以退回到非装饰器世界，而是使用 function 修改传递给它们的 class 构造函数。 例如（不确定这是否是一个好的实现）：

function isRequired<
  C extends new (...args: any[]) => any, 
  K extends keyof InstanceType<C>
>(
    ctor: C,
    prop: K
) {
    return class extends ctor {
        constructor(...args: any[]) {
            super(...args);
        }
        init() {
            if (this[prop as keyof this] == null) throw new Error(prop + " is nullish!!");
        }
    } as Pick<C, keyof C> & (new (...args: ConstructorParameters<C>) =>
        ({ [P in keyof InstanceType<C>]:
            P extends K ? NonNullable<InstanceType<C>[P]> : InstanceType<C>[P]
        } & { init(): void })
    );
}

如果您在 class 构造函数和属性名称上调用isRequired() ，则生成的构造函数将在该属性上生成具有不可为空值的实例，至少在您对实例调用init()之后（作为一些生命周期钩子的示例） ):

const MyClass = isRequired(class MyClass {
    public myProperty: string | undefined;
}, "myProperty");
type MyClass = InstanceType<typeof MyClass>;

const myClass = new MyClass();
myClass.myProperty = "okay";
myClass.init();
console.log(myClass.myProperty.toUpperCase()); // OKAY

const badMyClass = new MyClass();
badMyClass.init(); // myProperty is nullish!!
console.log(badMyClass.myProperty.toUpperCase()); // NEVER GET HERE

Playground 代码链接