项目安装和配置指南：class-validator

范圣茂

于 2024-10-18 10:56:44 发布

阅读量627

点赞数 18

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_01251/article/details/143039233

项目安装和配置指南：class-validator

class-validator Decorator-based property validation for classes. 项目地址: https://gitcode.com/gh_mirrors/cl/class-validator

1. 项目的基础介绍和主要的编程语言

class-validator 是一个基于装饰器的属性验证库，主要用于在 TypeScript 或 JavaScript 中对类进行验证。它允许开发者使用装饰器来定义验证规则，并通过简单的 API 来执行这些验证。该项目的主要编程语言是 TypeScript，但也支持在纯 JavaScript 环境中使用。

2. 项目使用的关键技术和框架

class-validator 主要依赖于以下技术和框架：

TypeScript：项目的主要编程语言，提供了类型检查和装饰器支持。
validator.js：一个流行的 JavaScript 验证库，class-validator 内部使用它来执行具体的验证逻辑。
Node.js：项目运行在 Node.js 环境中，支持在浏览器和 Node.js 平台上使用。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始安装和配置 class-validator 之前，请确保你已经完成了以下准备工作：

安装 Node.js：确保你的系统上已经安装了 Node.js。你可以通过访问 Node.js 官网下载并安装最新版本的 Node.js。
安装 npm：npm 是 Node.js 的包管理工具，通常会随 Node.js 一起安装。你可以通过运行 npm -v 来检查 npm 是否已经安装。
创建项目目录：在你的开发环境中创建一个新的项目目录，并在该目录下初始化一个新的 npm 项目。

mkdir my-project
cd my-project
npm init -y

安装步骤

安装 class-validator：使用 npm 安装 class-validator 包。

npm install class-validator --save

安装 TypeScript（可选）：如果你使用 TypeScript 进行开发，建议安装 TypeScript 编译器。

npm install typescript --save-dev

配置 TypeScript（可选）：如果你使用 TypeScript，你需要在项目根目录下创建一个 tsconfig.json 文件，并进行基本的配置。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules"]
}

创建验证类：在你的项目中创建一个 TypeScript 类，并使用 class-validator 提供的装饰器来定义验证规则。

import { validate, validateOrReject, Contains, IsInt, Length, IsEmail, IsFQDN, IsDate, Min, Max } from 'class-validator';

export class Post {
  @Length(10, 20)
  title: string;

  @Contains('hello')
  text: string;

  @IsInt()
  @Min(0)
  @Max(10)
  rating: number;

  @IsEmail()
  email: string;

  @IsFQDN()
  site: string;

  @IsDate()
  createDate: Date;
}

let post = new Post();
post.title = 'Hello'; // 应该不通过
post.text = 'this is a great post about hell world'; // 应该不通过
post.rating = 11; // 应该不通过
post.email = 'google.com'; // 应该不通过
post.site = 'googlecom'; // 应该不通过

validate(post).then(errors => {
  if (errors.length > 0) {
    console.log('验证失败，错误信息: ', errors);
  } else {
    console.log('验证成功');
  }
});