# @eggjs/ajv-plugin 中文文档

规范地址：https://npmcn.com/package/%40eggjs/ajv-plugin/

版本：4\.1\.0
npm 元数据更新时间：2026-10-07T08:25:36.954Z
中文译文更新时间：2026-11-13T12:53:22.693Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40eggjs/ajv-plugin
原文对照：https://npmcn.com/package/%40eggjs/ajv-plugin/?lang=original
项目主页：https://github.com/eggjs/egg/tree/next/tegg/plugin/ajv
源码仓库：https://github.com/eggjs/egg

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.7 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：6 个
- 首次发布：2025-10-23T16:27:50.609Z
- 最新版本发布：2026-10-07T08:25:36.630Z
- 近 30 天下载量：3773（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 33 个）

## 中文简介

ajv 鸡蛋和teg 插件

## 安装

```sh
npm install @eggjs/ajv-plugin
```

也可以使用：`pnpm add @eggjs/ajv-plugin`、`yarn add @eggjs/ajv-plugin`、`bun add @eggjs/ajv-plugin`

## README

# @eggjs/ajv-plugin

[![NPM version](https://img.shields.io/npm/v/@eggjs/ajv-plugin.svg?style=flat-square)](https://npmjs.org/package/@eggjs/ajv-plugin) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/ajv-plugin/badge.svg?style-square)](https://snyk.io/test/npm/@eggjs/ajv-plugin) [![npm download](https://img.shields.io/npm/dm/@eggjs/ajv-plugin.svg?style-square)](https://npmjs.org/package/@eggjs/ajv-plugin) [![Node.js Version](https://img.shields.io/node/v/@eggjs/ajv-plugin.svg?style=flat)](https://nodejs.org/en/download/)

参考 [@eggjs/typebox-validate](https://github.com/eggjs/egg/tree/next/plugins/typebox-validate) 的最佳实践，结合 ajv + typebox，只需要定义一次参数类型和规则，就能同时拥有参数校验和类型定义（完整的 ts 类型提示）。

## egg 模式

### Install

```shell
# tegg 注解
npm i --save @eggjs/tegg
# tegg 插件
npm i --save @eggjs/tegg-plugin
# tegg ajv 插件
npm i --save @eggjs/ajv-plugin
```

### Prepare

```json
// tsconfig.json
{
  "extends": "@eggjs/tsconfig"
}
```

### Config

```js
// config/plugin.js
exports.tegg = {
  package: '@eggjs/tegg-plugin',
  enable: true,
};

exports.teggAjv = {
  package: '@eggjs/ajv-plugin',
  enable: true,
};
```

## standalone 模式

### Install

```shell
# tegg 注解
npm i --save @eggjs/tegg
# tegg ajv 插件
npm i --save @eggjs/ajv-plugin
```

### Prepare

```json
// tsconfig.json
{
  "extends": "@eggjs/tsconfig"
}
```

## Usage

1、定义入参校验 Schema

使用 typebox 定义，会内置到 tegg 导出

```ts
import { Type, TransformEnum } from '@eggjs/tegg/ajv';

const SyncPackageTaskSchema = Type.Object({
  fullname: Type.String({
    transform: [TransformEnum.trim],
    maxLength: 100,
  }),
  tips: Type.String({
    transform: [TransformEnum.trim],
    maxLength: 1024,
  }),
  skipDependencies: Type.Boolean(),
  syncDownloadData: Type.Boolean(),
  // force sync immediately, only allow by admin
  force: Type.Boolean(),
  // sync history version
  forceSyncHistory: Type.Boolean(),
  // source registry
  registryName: Type.Optional(Type.String()),
});
```

2、从校验 Schema 生成静态的入参类型

```ts
import { Static } from '@eggjs/tegg/ajv';

type SyncPackageTaskType = Static<typeof SyncPackageTaskSchema>;
```

3、在 Controller 中使用入参类型和校验 Schema

注入全局单例 ajv，调用 `ajv.validate(XxxSchema, params)` 进行参数校验，参数校验失败会直接抛出 `AjvInvalidParamError` 异常， tegg 会自动返回相应的错误响应给客户端。

```ts
import { Inject, HTTPController, HTTPMethod, HTTPMethodEnum, HTTPBody } from '@eggjs/tegg';
import { Ajv, Type, Static, TransformEnum } from '@eggjs/tegg/ajv';

const SyncPackageTaskSchema = Type.Object({
  fullname: Type.String({
    transform: [TransformEnum.trim],
    maxLength: 100,
  }),
  tips: Type.String({
    transform: [TransformEnum.trim],
    maxLength: 1024,
  }),
  skipDependencies: Type.Boolean(),
  syncDownloadData: Type.Boolean(),
  // force sync immediately, only allow by admin
  force: Type.Boolean(),
  // sync history version
  forceSyncHistory: Type.Boolean(),
  // source registry
  registryName: Type.Optional(Type.String()),
});

type SyncPackageTaskType = Static<typeof SyncPackageTaskSchema>;

@HTTPController()
export class HelloController {
  private readonly ajv: Ajv;

  @HTTPMethod({
    method: HTTPMethodEnum.POST,
    path: '/sync',
  })
  async sync(@HTTPBody() task: SyncPackageTaskType) {
    this.ajv.validate(SyncPackageTaskSchema, task);
    return {
      task,
    };
  }
}
```

## 常见问题

### @eggjs/ajv-plugin 是什么？

ajv 鸡蛋和teg 插件

### 如何安装 @eggjs/ajv-plugin？

在项目目录运行 npm install @eggjs/ajv-plugin，或使用 pnpm add / yarn add / bun add。

### @eggjs/ajv-plugin 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @eggjs/ajv-plugin 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @eggjs/ajv-plugin 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.18\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @eggjs/ajv-plugin 可以商用吗？

@eggjs/ajv-plugin 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @eggjs/ajv-plugin 的下载量有多少？

根据 npm 官方下载统计，@eggjs/ajv-plugin 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,773 次，日均约 126 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @eggjs/ajv-plugin 还在维护吗？

最新版本 4\.1\.0 发布于 2026/10/07（1 个月前）；至今共发布 39 个版本，其中过去 12 个月发布了 33 个；首次发布于 2025/10/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。