打字稿中具有数据水合/脱水的类

Question

我想在React + TS前端和node + TS后端之间共享TS类或接口。问题是TS类型在编译时被剥夺了，因此当我要将类实例转换为JSON时无法使用它们。

我想知道是否有任何解决方案可以在静态文件中描述对象，生成TS类以及将该文件用于数据水合和脱水。一些属性是moment.js对象和Decimal.js对象。我正在寻找一种可以基于静态描述符进行转换的解决方案，而无需为每个属性手动编写转换。

脱水格式用于HTTP请求中，另外还存储在DB（Firebase Firestore）中，并且可由前端直接访问以进行读取。

Answer 1

我会使用很棒的io-ts库来解决这个问题。

脱水格式用于 HTTP 请求，并且存储在 DB（Firebase Firestore）中并由前端直接访问以进行读取。

一般来说，我会假设不同层有不同的序列化格式。如果在您的具体情况下可以进行这种简化，那么

我想知道是否有任何解决方案可以在静态文件中描述我的对象

您可以io-ts定义一组codecs 作为代表您的域的 TypeScript 值。编解码器既是验证器又是（反）序列化器，因此您可以很好地将类实例序列化为 JSON 字符串，反之亦然（前提是 JSON 已成功验证，然后使用适当的反序列化值实例化类） 。

执行此类工作的简化且非常自定义的编解码器如下：

// class definition:

class MyModel {
  constructor(readonly value: number) {}

  getValue() {
    return this.value;
  }
}

// codec definition:

import * as t from 'io-ts';
import { JSONFromString } from 'io-ts-types/lib/JSON/JSONFromString';

const MyModelFromString = new t.Type<MyModel, string, unknown>(
  'MyModel',
  (value): value is MyModel => value instanceof MyModel,
  str =>
    t.string
      .decode(str)
      .chain(JSONFromString.decode)
      .chain(json => t.type({ value: t.number }).decode(json))
      .map(({ value }) => new MyModel(value)),
  instance => JSON.stringify({ value: instance.value })
);

// usage:

MyModelFromString.decode('{ "value": 1 }').fold(
  errors => {
    console.error(errors);
  },
  inst => {
    // inst has type `MyModel` here
    console.log(inst.getValue());
  }
);

MyModelFromString.encode(new MyModel(2)); // '{ "value": 2 }'

除此之外，您通常还需要序列化某种类型的标签，这样您只需查看普通的序列化 JSON 字符串即可决定要尝试实例化哪个类。

您可能还想看看io-ts-types其中已经包含许多可以重用的现成编解码器，例如DateFromISOString.