fast-class-validator v1.0.0

fast-class-validator

在ES6和Typescript的时代，我们可以用class和decorator做很多事情。fast-class-validator可以让plain object转换成某个class的实例,并可以通过注解来校验property的规则。

目录

• What is fast-class-transform
• Installation
• Methods
  • json2class
• Annotations
• working with nested object
• type conversion
  • support type
• Annotations list

what is fast-class-transform

在 Javascript 中有两种对象类型:

• plain(literal) objects
• class(constructor) objects

plain objects 是 Object 的实例，有时候我们也管他叫字面量类型。但有时候我们需要将 plain object 作为某个 ES6 的 class 的实例并且期望对某些class property 制定某些规则，那么fast-class-validator 将会非常适合你。 例如:

// es6 class
class Data {
  @IsNegative(-1)
  prop: number;

  @Contains('hello')
  prop1: string;
}
// literal object
const tmp = {
  prop: '-20',
  prop1: 'hello world',
};

// result instanceof Data
const result = json2class(Data, tmp);

Installation

环境支持：

• nodejs >= 12
• typescript>=3

npm i fast-class-validator -S

配置 tsconfig.json:

 "experimentalDecorators": true,
 "emitDecoratorMetadata": true,

methods

json2class

json2class 方法将转换一个 plain object 到一个具体 class 实例

import { json2class } from 'fast-class-validator';

class Hotel {
  id: string;

  name: string;

  address: string;

  latitude: string;

  longitude: string;
}

// hotel is instance of Hotel
const hotel = json2class(Hotel, hotelJson);

Annotations

通过json2class将会把一个plain object转换成某个具体class的实例，但仍然会存在一个问题Hotel中定义的property有可能与hotelJson对象属性不同，那么这就会带来一个严重问题，运行时与编码时所对应的数据不一致。 fast-class-validator可以解决这种问题。

通过Schema注解解决plain object中属性类型不匹配的问题

class Hotel {
  @Schema()
  id: string;

  @Schema()
  name: string;

  @Schema()
  address: string;

  @Schema()
  latitude: string;

  @Schema()
  longitude: string;
}

const hotelJson = {
  id: 1,
};
const hotel = json2class(Hotel, hotelJson); //{id:'1'}

Schema 注解并不强制要求 plain object 完全与定义的 class object一致（属性的类型和属性个数），Schema只起到类型转换的作用。如果我们想要class object 必须满足某种规则如下:

// 通过给 Hotel中的property增加规则注解，来让plain object的属性满足对应的规则。

class Hotel {
  @IsUUID()
  id: string;

  @IsString()
  name: string;

  @Schema()
  address: string;

  @IsLatitude()
  latitude: string;

  @IsLongitude()
  longitude: string;
}

const hotelJson = {
  id: 1,
};
const hotel = json2class(Hotel, hotelJson); //PlainToClassError

working with nested object

有时候我们可能需要转换复杂的数据结构（对象的多级嵌套），但是由于目前typescript还不能很好提供reflect能力，所以暂时只支持class

class Room {
  @Required()
  type: string;
}

class Hotel {
  @IsUUID()
  id: string;

  // 通过Schema收集refer的元信息
  @Schema()
  refer: Room;
}

type conversion

类型转换，并不是所有的 plain object 都能转换对应的 class object，只有typescript 与 javascript 的交集类型才能满足类型转换

interface ITmp {
  prop5: string;
}
class Hotel {
  @Schema()
  prop1: unknown;

  @Schema()
  prop2: any;

  @Schema()
  prop3: string | number;

  @Schema()
  prop4: ITmp;
}
//ts独有的类型都无法进行转换到对应的类型，fast-class-validator将输出plain object 的数据
const tmp = {
  prop1: '输出原始类型',
  prop2: { prop2: '校验通过' },
  prop3: ['1', '2'],
  prop4: '字符串',
};
const result = json2class(Hotel, tmp);
/**
 * result 为
 * {
  prop1: '输出原始类型',
  prop2: { prop2: '校验通过' },
  prop3: ['1', '2'],
  prop4: '字符串',
}
 * /

support-type

fast-class-validator 支持的类型转换如下

• class object
• Object
• Array
• Map
• Set
• string
• number
• boolean
• Date
• Promise

Annotations list

common

type check

string

number

Array

Object

Date