Egg-Validate 使用教程

Egg-Validate 使用教程

egg-validatevalidate plugin for egg项目地址:https://gitcode.com/gh_mirrors/eg/egg-validate

项目介绍

Egg-Validate 是一个基于 Egg.js 框架的参数校验插件。它基于 parameter 库，提供了强大的参数校验功能，可以帮助开发者轻松地对请求参数进行校验，确保数据的正确性和安全性。

项目快速启动

安装

首先，你需要安装 Egg-Validate 插件：

npm install --save egg-validate

启用插件

在 config/plugin.js 文件中启用插件：

exports.validate = {
  enable: true,
  package: 'egg-validate',
};

配置插件

在 config/config.default.js 文件中进行配置：

exports.validate = {
  // 配置项
};

使用示例

在控制器中使用参数校验：

const Controller = require('egg').Controller;

class HomeController extends Controller {
  async index() {
    const { ctx } = this;
    // 校验请求体中的参数
    ctx.validate({
      userName: 'string',
      age: 'number',
    });
  }
}

module.exports = HomeController;

应用案例和最佳实践

应用案例

假设我们有一个用户注册接口，需要校验用户名和密码：

class UserController extends Controller {
  async register() {
    const { ctx } = this;
    ctx.validate({
      userName: { type: 'string', required: true },
      password: { type: 'string', required: true, min: 6 },
    });
    // 处理注册逻辑
  }
}

最佳实践

1. 自定义校验规则： 你可以通过扩展规则来满足特定的校验需求：

   app.validator.addRule('jsonString', (rule, value) => {
     try {
       JSON.parse(value);
     } catch (err) {
       return 'must be json string';
     }
   });
   

2. 错误处理： 使用 try-catch 捕获校验错误并返回自定义错误信息：

   class HomeController extends Controller {
     async index() {
       const { ctx } = this;
       try {
         ctx.validate({
           id: 'id',
         });
       } catch (err) {
         ctx.body = {
           code: 422,
           message: '参数校验失败',
           errors: err.errors,
         };
         return;
       }
       // 继续处理业务逻辑
     }
   }
   

典型生态项目

Egg-Validate 作为 Egg.js 生态系统的一部分，与其他 Egg.js 插件和工具配合使用，可以构建出功能强大的 Web 应用。以下是一些典型的生态项目：

1. Egg-Sequelize：用于数据库操作的 ORM 插件。
2. Egg-JWT：用于处理 JSON Web Token 的插件。
3. Egg-Swagger：用于生成 API 文档的插件。

通过这些插件的组合使用，可以构建出高效、安全的 Web 应用。

egg-validatevalidate plugin for egg项目地址:https://gitcode.com/gh_mirrors/eg/egg-validate