将WebSocket消息封装为Typescript

问题描述

我正在尝试将websocket消息封装为定义良好的Type。
我有主要的IIncommingMessage，它是所有传入消息的基本接口，例如：

export interface IIncommingMessage {
  className : IClassName;
  methodName : IMethodName;
}

此websocket可以调用以下各种类型的类：

export type IClassName = IClassA | IClassB | IClassC

以及相关类中的各种方法

export type IMethodName = IfooinClassA | IbarinClassA | IbazinClassB | IquxinClassB | IquuxinClassB | IcorgeinClassC

看起来像这样

ClassA:
  foo()
  bar()

ClassB:
  baz()
  qux()
  quux()

ClassC:
  corge

这个想法是，如果有一个websocket消息到达。会变成

{
  className : "ClassB"
  methodName : "qux"
}

所以这应该调用函数qux（）的ClassB。

1. 我采用的方法看起来很糟糕。想知道是否有更好的方法将网络套接字消息紧密耦合到定义良好的类型

2. 也很好奇我将如何在TypeScript中进行此调用-它是protoype.call（'className.method'）吗？

解决方法

关于第一个具有明确定义的类型的部分，这就是我要实现的方式。

class ClassA {
    foo() { }
    bar() { }
}

class ClassB {
    baz() { }
    qux() { }
    quux() { }
}

class ClassC {
    corge() { }
    notAMethod = 1;
}

// This will be a like a dictionary mapping name to class
// Will also be used in the second part.
const Classes = {
    ClassA,ClassB,ClassC,};

// This will be 'ClassA'|'ClassB'|'ClassC'
type IClassName = keyof typeof Classes;
type IClassOf<T extends IClassName> = InstanceType<typeof Classes[T]>;
type MethodFilter<T extends IClassName> = { [MN in keyof IClassOf<T>]: IClassOf<T>[MN] extends () => void ? MN : never }
type MethodName<T extends IClassName> = MethodFilter<T>[keyof MethodFilter<T>];

interface IGenericIncomingMessage<T extends IClassName> {
    className: T;
    methodName: MethodName<T>;
}

type IIncomingMessage = IGenericIncomingMessage<'ClassA'> | IGenericIncomingMessage<'ClassB'> | IGenericIncomingMessage<'ClassC'>;

let msg0: IIncomingMessage = {
    className: 'ClassA',methodName: 'foo',// valid
}

let msg1: IIncomingMessage = {
    className: 'ClassC',methodName: 'corge',// valid
}

let msg2: IIncomingMessage = { // compiler error. Type ... is not assignable to type 'IIncomingMessage'.
    className: 'ClassA',}

let msg3: IIncomingMessage = {
    className: 'ClassD',// compiler error. ClassD Name is not not in 'ClassA' | 'ClassB' | 'ClassC'
    methodName: 'corge',}

let msg4: IIncomingMessage = {
    className: 'ClassC',methodName: 'notAMethod',// compiler error. Type '"notAMethod"' is not assignable to type '"foo" | "bar" | "baz" | "qux" | "quux" | "corge"'.
}

因此，关于第二部分，我使用前面定义的Classes字典按名称查找类，创建该类的新实例。这意味着具有有效类名但不在词典中的恶意消息将不起作用。

// I omit error handling here.
function invokeFunction<T extends IClassName>(message: IGenericIncomingMessage<T>): void {
    // Look for the class instance in dictionary and create an instance
    const instance = new Classes[message.className]() as IClassOf<T>;
    // Find the method by name. The cast to any is to silence a compiler error;
    // You may need to perform additional login to validate that the method is allowed.
    const fn = instance[message.methodName] as unknown as () => void;
    fn.apply(instance);
}