开发指南总览

欢迎来到 Yumeri 开发者文档。Yumeri 是一个基于 Node.js 的新一代模块化 Web 应用构建平台，强调插件化、可扩展和可维护的工程实践。

本文档按照内容职责来组织，分成四类核心主题：

总览

这一部分用于理解框架定位、设计目标和整体开发路径。

• 环境搭建：项目初始化和框架安装。
• 插件基础：插件的基本构成和加载方式。
• 配置构型：Schema、配置注入和默认值处理。

快速开始

这里适合第一次接触 Yumeri 的开发者，重点是建立最小开发闭环。

1. 环境搭建：准备运行环境。
2. 插件基础：编写第一个插件。
3. 配置构型：为插件提供结构化配置。
4. 装饰器 API：了解声明式开发方式。

路由与请求

这一层面向“请求处理”和“交互入口”相关能力。

• 路由系统：路径匹配、参数、HTTP 方法和 WebSocket 路由。
• 中间件：在请求进入处理器前后插入逻辑。
• 事件监听：插件之间的事件驱动通信。
• 钩子系统：在扩展点上注册对外能力。

扩展机制

这一部分关注插件能力的组织和扩展方式：

• 组件提供：共享实例与基础设施依赖。
• 服务提供：带上下文的可复用业务能力。
• 运行时与生命周期：从插件加载到卸载的完整运行机制。
• Context 运行时入口：插件运行时的主入口。
• 组件与依赖注入：共享能力与依赖解析。
• 生命周期与清理：插件如何安全地卸载与释放资源。
• 定时器与副作用管理：防止定时器、监听器和异步任务泄漏。

核心理念

• 模块化 (Modular)：一切皆插件，功能高度解耦。
• 双 API 支持：自由选择函数式 API 或装饰器 API。
• 类型安全：深度集成 TypeScript，提供更可靠的 IDE 补全。
• 资源治理：通过 Context、Hook、affect、定时器与清理机制保障稳定运行。

推荐阅读顺序

如果你刚接手项目，建议按下面顺序阅读：

1. 环境搭建
2. 插件基础
3. 配置构型
4. 路由系统
5. 组件提供
6. 服务提供
7. 运行时与生命周期