class-validator源码地址

通过自定义一个全局的validation pipe,联合class-validator来做参数校验。

nest官网对class-validator一笔带过。本篇整顿一些罕用的办法。

dto

须要自行理解dto

罕用的

  • IsDefined

字符串类型的判断

IsNumberString

字符串"1",能够符合条件。数字1却不行。

留神,谬误的message要这么传入

@IsNumberString({},{message: '....'})

IsBooleanString

有了上边的教训,"true",'false'能够通过判断

IsDateString

合乎日期类型的字符串

字符串类型

Contains

传入的字符串蕴含制订的字符串么

@Contains('test'),蕴含test通过。不蕴含,抛出异样。

message为第二个入参数。

NotContains

与上相同

IsUppercase

是否都是大写

IsLowercase

小写

IsMobilePhone

是否是手机号

你须要这样应用 @IsMobilePhone('zh-cn'),看懂了吗,须要传一个locate。

@Length(min: number, max?: number)

测验字符串长度的。留神一下跟int的不同

MaxLength &&& MinLength

这个很简略,间接

@MaxLength(12)

Matches

应用时,第一个参数是一个正则,合乎该正则通过。

@Matches(/foo/i)

IsJson

输出的字符串是个JSON格局的

相干的装璜器办法太多了,以上是字符串罕用的。有须要的能够去文档中查找。类库也反对自定义对应的装璜器。

Number相干

IsDivisibleBy

IsDivisibleBy(5),被校验的参数能被5 整除。

IsPositive & IsNegative

@IsPositive()负数

@IsNegative()正数

Max & Min

数字最大最小值。

对于字符串判断MaxLength,MinLength,Number应用的是Max和Min

日期

MaxDate

最大日期

MinDate

最小日期

留神,入参应该是日期类型才能够判断。如果入参是字符串类型,能够是用IsDateString来判断

类型判断的装璜器

IsString

string类型

IsDate

必须是Date类型了

IsNumber

Number类型就能够

IsInt

整数通过

IsArray

必须是数组

IsEnum(entity: object)

IsObject

判断是否是一个对象

IsNotEmptyObject()

不是空对象

罕用校验器

IsDefined

不能等于null或者undefined

空字符串能够的

IsOptional 罕用

可选的。如果输出的等于null或者undefined,疏忽其它的校验装璜器

Equals

等于某个确定的值

@Equals(5)

NotEquals

不等于某个值

IsEmpty

查看这个值等于'',null,undefined

IsNotEmpty

不能是空的,也就是不能是'',undefined,null

IsIn

查看值是否是数组中的某个值

@IsIn(['1','2'])

输出的值必须是1,2中的一个值。

IsNotIn

校验的值不能是给定的数组中的元素

@IsIn(['1','2'])

再去校验1或者2就通不过了。

更多,浏览这里

错误信息

除了内定的错误信息,能够本人设置message属性。

export class Post {  @MinLength(10, {    message: 'Title is too short',  })  @MaxLength(50, {    message: 'Title is too long',  })  title: string;}

@IsEmpty这种,message设置到第一个参数

@IsEmpty({message: '....'})

对于谬误音讯的返回写法,类库提供了一些占位,具体能够参考这里

校验信息

补充: 校验数组

如果须要校验数组中的每一项。须要传入一个 each: true

比方冀望输出的一个数组,每一个元素应该是一个小于10的number,

@IsNumber({},{each: true,})@Max(20,{each: true})

不难受的一点就是每个装璜器都要传入each: true

自定义验证装璜器

理论工作是防止不了自定义验证办法的。

显然在以后的环境中,最好的形式就是定义一个 验证装璜器。

这里贴下主页的源码,理论应用就是照葫芦画瓢就能够了。

import { registerDecorator, ValidationOptions, ValidationArguments } from 'class-validator';export function IsLongerThan(property: string, validationOptions?: ValidationOptions) {  return function (object: Object, propertyName: string) {    registerDecorator({      name: 'isLongerThan',      target: object.constructor,      propertyName: propertyName,      constraints: [property],      options: validationOptions,      validator: {        validate(value: any, args: ValidationArguments) {          const [relatedPropertyName] = args.constraints;          const relatedValue = (args.object as any)[relatedPropertyName];          return typeof value === 'string' && typeof relatedValue === 'string' && value.length > relatedValue.length; // you can return a Promise<boolean> here as well, if you want to make async validation        },      },    });  };}

更具体的浏览这里