5

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

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

脱水格式用于 HTTP 请求,并存储在数据库(Firebase Firestore)中,并由前端直接访问以进行读取。

4

1 回答 1

4

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

脱水格式用于 HTTP 请求,并存储在数据库(Firebase Firestore)中,并由前端直接访问以进行读取。

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

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

io-ts您可以将一组 s 定义为codec代表您的域的 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.

于 2019-06-26T12:40:02.960 回答