# @eggjs/aop-plugin 中文文档

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

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

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

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

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

- 包体积（解压后）：9.6 kB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：7 个
- peer 依赖：egg 4\.2\.0，@eggjs/tegg-plugin 4\.1\.0
- 首次发布：2025-10-23T16:37:12.150Z
- 最新版本发布：2026-10-07T08:26:48.452Z
- 近 30 天下载量：3781（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 33 个）

## 中文简介

teg aop 插件

## 安装

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

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

## README

# @eggjs/aop-plugin

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

## Usage

```js
// plugin.js
export.teggAop = {
  enable: true,
  package: '@eggjs/aop-plugin',
};
```

## Advice

使用 `@Advice` 注解来申明一个实现，可以用来监听、拦截方法执行。

**注意：Advice 也是一种 Prototype，可以通过 initType 来指定不同的生命周期，默认为 Singleton。**

如需在调用过程中保存状态，可以将状态通过 `AdviceContext` 的 get/set 来保存。

```ts
import { Advice, IAdvice } from '@eggjs/tegg/aop';

const FOO_STATE_SYMBOL = Symbol('AdviceExample#state');

@Advice()
export class AdviceExample implements IAdvice {
  // Advice 中可以正常的注入其他的对象
  @Inject()
  private readonly callTrace: CallTrace;

  // 在函数执行前执行
  async beforeCall(ctx: AdviceContext): Promise<void> {
    // ...
    ctx.set(FOO_STATE_SYMBOL, 23333);
  }

  // 在函数成功后执行
  async afterReturn(ctx: AdviceContext, result: any): Promise<void> {
    // 将会打印 23333
    console.log(ctx.get(FOO_STATE_SYMBOL));
  }

  // 在函数成功后执行
  async afterThrow(ctx: AdviceContext, error: Error): Promise<void> {
    // ...
  }

  // 在函数退出时执行
  async afterFinally(ctx: AdviceContext): Promise<void> {}

  // 类似 koa 中间件的模式
  // block = next
  async around(ctx: AdviceContext, next: () => Promise<any>): Promise<any> {}
}
```

## Pointcut

使用 `@Pointcut` 在某个类特定的方法上申明一个 `Advice`

```ts
import { Pointcut } from '@eggjs/tegg/aop';
import { ContextProto } from '@eggjs/tegg';

@ContextProto()
export class Hello {
  // 创建 Hello.hello 的切面 AdviceExample，并传递 adviceParams 给 AdviceExample
  // AdviceExample 的切面函数可以通过 ctx.adviceParams 拿到注解传入的参数
  @Pointcut(AdviceExample, { adviceParams: { foo: 'bar' } })
  async hello(name: string) {
    return `hello ${name}`;
  }
}
```

## Crosscut

使用 `@Crosscut` 来声明一个通用的 `Advice`，有三种模式

-   指定类和方法
-   通过正则指定类和方法
-   通过回调来指定类和方法

**注意：egg 中的对象无法被 Crosscut 指定到。**

```ts
import { Crosscut, Advice, IAdvice } from '@eggjs/tegg/aop';

// 通过类型来指定
// 创建 CrosscutClassAdviceExample.hello 的切面 CrosscutExample，并传递 adviceParams 给 CrosscutExample
// CrosscutExample 的切面函数可以通过 ctx.adviceParams 拿到注解传入的参数
@Crosscut(
  {
    type: PointcutType.CLASS,
    clazz: CrosscutExample,
    methodName: 'hello',
  },
  { adviceParams: { foo: 'bar' } },
)
@Advice()
export class CrosscutClassAdviceExample implements IAdvice {}

// 通过正则来指定
@Crosscut({
  type: PointcutType.NAME,
  className: /crosscut.*/i,
  methodName: /hello/,
})
@Advice()
export class CrosscutNameAdviceExample implements IAdvice {}

// 通过回调来指定
@Crosscut({
  type: PointcutType.CUSTOM,
  callback: (clazz: EggProtoImplClass, method: PropertyKey) => {
    return clazz === CrosscutExample && method === 'hello';
  },
})
@Advice()
export class CrosscutCustomAdviceExample implements IAdvice {}
```

## 常见问题

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

teg aop 插件

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

在项目目录运行 npm install @eggjs/aop-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：egg（4\.2\.0）、@eggjs/tegg-plugin（4\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

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

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

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

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