egg-core

egg 核心概念

代码组织与依赖注入

Step 1: 代码写在 module 中

什么是模块？

模块是 EGG 中基础的代码组织单元。只有模块内的代码会被框架扫描和加载。模块之间相互独立，但可以通过 @Inject 装饰器访问其他模块的对象。

定义 module

在目录中添加包含 eggModule.name 字段的 package.json 文件来声明该目录为模块：

{
  "name": "foo",
  "eggModule": {
    "name": "foo"
  }
}

重要提示：模块名称不能包含 - 或其他特殊字符；使用驼峰命名规则。

正确示例

app/
└── userModule/           ✅ 驼峰命名
    ├── package.json
    │   └── { "eggModule": { "name": "userModule" } }
    └── service.ts        ✅ 会被框架加载

错误示例

app/
├── user-module/          ❌ 名称包含 `-`
│   └── package.json
│       └── { "eggModule": { "name": "user-module" } }
│
└── common/               ❌ 缺少 package.json（不是 module）
    └── utils.ts          ❌ 不会被框架加载

模块配置

在模块根目录创建 module.yml 用于模块特定配置：

foo: bar

通过 @Inject() 注入配置，使用 moduleConfig：

import { SingletonProto, Inject } from 'egg';

interface ModuleConfig {
  foo: string;
}

@SingletonProto()
export class ConfigService {
  @Inject()
  private readonly moduleConfig: ModuleConfig;

  async hello(): Promise<string> {
    return `hello ${this.moduleConfig.foo}`;
  }
}

模块组织最佳实践

• 新应用：按功能在 app/ 目录中组织
• 存量应用：保留老的 egg 代码在 app/controller/app/service，将新增的 module 代码放在 app/module/
• 可以在 dependencies 中导入 npm 包作为额外模块

导入路径

所有装饰器和类型统一从 egg 导入，不要从 @eggjs/tegg 导入：

// ✅ 正确
import { SingletonProto, ContextProto, Inject, AccessLevel } from 'egg';

// ❌ 错误 — 不要从 @eggjs/tegg 导入
import { SingletonProto } from '@eggjs/tegg';

---

Step 2: 用 Proto 实现 Service

SingletonProto

应用启动时立即创建，整个应用生命周期内只有一个实例，性能更好，应该作为默认选择。

import { SingletonProto } from 'egg';

@SingletonProto()
export class HelloService {
  async hello(): Promise<string> {
    return 'hello';
  }
}

ContextProto

请求到达时按需创建，每个请求一个实例，请求结束自动销毁。仅在需要隔离不同请求的上下文信息时使用。

import { ContextProto } from 'egg';

@ContextProto()
export class RequestContext {
  userId: string;
}

重要提示：大多数服务应该使用 SingletonProto 以获得更好的性能。只有当请求上下文必须在服务之间共享以确保请求之间隔离时，才使用 ContextProto。

AccessLevel

proto 对象默认 accessLevel 为 AccessLevel.PRIVATE，仅在当前 module 内使用。可以设置为 AccessLevel.PUBLIC，进行跨模块访问。

import { AccessLevel, ContextProto, SingletonProto } from 'egg';

@SingletonProto({ accessLevel: AccessLevel.PUBLIC })
export class SharedService {}

@ContextProto({ accessLevel: AccessLevel.PUBLIC })
export class SharedContextService {}

Step 3: 通过 Inject 使用 Service

基本用法

使用 @Inject() 注入其他 Proto 或 Egg 对象：

import { Inject, Logger, SingletonProto } from 'egg';
import { FooService } from './FooService.ts';

@SingletonProto()
export class HelloService {
  @Inject()
  fooService: FooService; // 注入另一个 Proto

  @Inject()
  logger: Logger; // 注入 Egg 对象

  async hello(): Promise<string> {
    this.logger.info(`[HelloService] ${this.fooService.hello()}`);
  }
}

动态注入

当同一个抽象有多种实现，需要在运行时动态选择时，通过 EggObjectFactory 按类型获取实现，无需 if/else。详见 references/dynamic-inject.md。

重要约束

• 不能有循环依赖：Proto 或模块之间都不能有循环依赖
• 不能有同名对象：一个模块不能有相同名称和初始化类型的 Proto
• 按需注入：不要直接注入 app 或 ctx，按需注入特定对象

快速决策指南

异步任务

需要在请求之外执行任务？
│
├─ 请求返回后执行，依赖当前请求上下文
│  └─ → BackgroundTaskHelper（references/background-task.md）
│
├─ 请求返回后执行，不依赖当前请求上下文，需要解耦
│  └─ → EventBus（references/eventbus.md）
│
└─ 定时或周期执行
   └─ → Schedule（参考 egg-controller skill）

AOP 切面编程

AOP 用于将日志、鉴权、缓存、事务等横切关注点从业务代码中分离。AOP 装饰器从 egg/aop 导入（不是 egg）。

需要在方法执行前后添加通用逻辑？
│
├─ 针对特定方法 → @Pointcut（在目标方法上声明）
│
└─ 批量切入多个类/方法 → @Crosscut（在 Advice 类上声明匹配规则）

详细用法（Advice 生命周期、AdviceContext、Pointcut/Crosscut 选型、参数透传、执行顺序）请参阅 references/aop.md。

常见问题排查

参考资料

• 详细的 module 文档，请参阅：references/module.md
• Inject 装饰器使用，请参阅：references/inject.md
• SingletonProto 和 ContextProto 详情，请参阅：references/proto.md
• 动态注入（Qualifier 动态注入），请参阅：references/dynamic-inject.md
• 请求后异步任务（BackgroundTaskHelper），请参阅：references/background-task.md
• 事件总线（EventBus），请参阅：references/eventbus.md
• AOP 切面编程（Advice、Pointcut、Crosscut），请参阅：references/aop.md

单元测试（egg-unittest skill）：Service 测试、BackgroundTask 测试、EventBus 测试