Egg.js 参数验证插件 egg-validate 使用指南

Egg.js 参数验证插件 egg-validate 使用指南

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

---

项目目录结构及介绍

Egg.js 的 egg-validate 插件是为了简化 API 参数验证而设计的。虽然具体的仓库链接未直接提供，但我们可以根据 Egg.js 项目的常规结构和上述引用内容推测其基本组织方式。

常规目录结构示例：

• src

  • app
    • controller - 控制器文件存放处，这是验证逻辑经常被调用的地方。
    • service - 服务层，虽然不直接关联egg-validate，但间接可能处理验证后的数据。
  • config
    • config.default.js 或 config.*.js - 包含插件启用状态及其配置选项。
  • lib - 自定义扩展或插件可能存放于此，包括自定义验证规则。
  • plugin.js - 插件启用配置文件，指定要加载的插件。

• test - 测试用例存放目录，用于验证插件功能正确性。

• node_modules - 依赖库存放处，包括egg-validate在安装后的位置。

• package.json - 项目元数据文件，包含脚本命令、依赖项等。

项目的启动文件介绍

Egg.js 应用通常没有单一的“启动文件”，而是通过npm start或yarn start命令依据package.json中的scripts执行。不过，核心的启动逻辑由bin/egg-scripts.js管理，并通过Egg的核心框架自动处理。在实际开发过程中，开发者主要关注配置文件和入口文件(app.js或app.ts)的设置。

项目的配置文件介绍

主配置文件 (config/config.default.js)

exports.validate = {
  // 是否开启转换类型，默认情况下可能会将某些类型的输入转换成期望类型
  convert: false,
  // 是否对根对象进行验证，默认通常是 false
  validateRoot: false,
};

这些配置允许开发者控制验证行为，比如是否对非预期类型的输入尝试转换为期望类型，以及验证操作是否应用于整个上下文对象。

插件启用配置 (config/plugin.js)

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

这一部分确保在启动Egg应用时加载并启用egg-validate插件。开发者可以根据需要调整启用状态。

自定义验证规则

若需添加自定义验证规则，则一般在项目的某个地方（如自定义lib目录或直接在配置阶段），利用Egg的生命周期方法或直接在配置中加入，如下所示：

// 在合适的地方引入插件并添加规则
const rules = {
  jsonString: (rule, value) => {
    try {
      JSON.parse(value);
      return;
    } catch (err) {
      return '必须是JSON字符串';
    }
  },
};

app.validator.addRule(rules.jsonString);

请注意，具体细节可能会随着插件版本更新而变化，建议参考最新的官方文档或仓库README来获取最新信息。

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