# MoviePilot v3 架构设计
> 本文面向开发人员,以图文结合的方式说明 MoviePilot v3 的整体架构:分层结构、各核心包的职责、
> 模块间调用关系、典型业务流程与启动生命周期。
>
> 规范性约束以 [`docs/rules/05-architecture.md`](rules/05-architecture.md) 与
> [`docs/rules/04-design-patterns.md`](rules/04-design-patterns.md) 为准,本文与其保持一致;
> 如出现差异,以规则文档为准。
>
> *Last Updated: 2026-08-21*
---
## 一、系统概述
MoviePilot 是一个聚焦影视自动化核心流程的系统,实现**订阅、搜索、下载、文件整理、元数据刮削、
媒体库刷新与消息通知**的全流程自动化。后端基于 FastAPI,前端基于 Vue 3(独立仓库),
同时对外提供 REST API、MCP 工具调用端点(`/api/v1/mcp`)与 OpenAI / Anthropic 兼容协议端点,
内置 AI Agent 支持自然语言操控系统。
```mermaid
flowchart LR
subgraph 外部["外部入口"]
Web["Vue 3 前端"]
Msg["消息渠道
Telegram / WeChat / Slack ..."]
ExtAgent["外部智能体
MCP / Skills"]
end
subgraph 后端["MoviePilot 后端(FastAPI)"]
API["REST API / MCP / 兼容协议"]
Core["核心引擎
Chain / Application / Module / Plugin / Agent"]
Persist["持久化端口 / Oper"]
end
subgraph 外部服务["外部生态"]
Site["PT 站点 / 索引器"]
DL["下载器
qBittorrent / Transmission ..."]
MS["媒体服务器
Emby / Plex / Jellyfin ..."]
Meta["元数据源
TMDB / Douban / Bangumi ..."]
LLM["LLM 提供商"]
end
DB[("PostgreSQL / SQLite
+ Alembic 迁移")]
Web -->|HTTP| API
Msg -->|Webhook / 轮询| Core
ExtAgent -->|JSON-RPC| API
API --> Core
Core -->|通过应用端口 / Oper| Persist
Persist --> DB
Core <--> Site
Core <--> DL
Core <--> MS
Core <--> Meta
Core <--> LLM
```
---
## 二、整体分层架构
MoviePilot v3 采用严格的单向依赖分层。历史包 `app/core`、`app/helper`、`app/utils`
已不再存在物理目录,仅作为旧插件的**虚拟兼容导入根**保留。
```mermaid
flowchart TB
subgraph 入口层["入口层 Entrypoints"]
ApiPkg["app/api
REST / MCP 端点"]
AgentPkg["app/agent
AI Agent 运行时"]
Monitor["app/monitor
目录监控"]
Workflow["app/workflow
工作流"]
Scheduler["app/scheduler
定时任务"]
CLI["app/cli
命令行"]
PluginPkg["插件运行时目录
app/plugins/*(副本/覆盖层)"]
end
subgraph 编排层["编排层"]
Chain["app/chain
Chain 用例编排"]
App["app/application
聚焦应用服务"]
end
subgraph 能力层["能力层"]
Modules["app/modules
可插拔后端模块"]
Db["app/db
模型 + Oper 数据访问"]
Schemas["app/schemas
传输模型与枚举"]
end
subgraph 契约层["契约层"]
Domain["app/domain
纯业务语义"]
Runtime["app/runtime
进程级运行时契约"]
end
subgraph 底层["底层机制"]
Foundation["app/foundation
无状态原语"]
Adapters["app/adapters
技术 I/O 适配"]
end
subgraph 组合根["组合根 / 边界"]
Startup["app/startup
Composition Root"]
Sdk["app/sdk
插件稳定导入面"]
Compat["app/runtime/compat
旧导入路径与符号映射"]
end
ApiPkg --> Chain
AgentPkg --> App
Monitor --> Chain
Workflow --> Chain
Scheduler --> Chain
CLI --> Chain
PluginPkg --> Sdk
Chain -->|run_module 分发| Modules
Chain --> App
Chain -->|经应用端口 / Oper 适配| Db
App --> Modules
App -->|应用端口 / Oper 适配| Db
Modules --> Domain
App --> Domain
App --> Runtime
Chain --> Runtime
Domain --> Schemas
Domain --> Foundation
Runtime --> Foundation
Adapters --> Domain
Adapters --> Foundation
App -->|允许的技术适配依赖;优先由 startup 装配| Adapters
Startup -.注入/装配.-> Runtime
Startup -.注入/装配.-> App
Startup -.注入/装配.-> Modules
Sdk -.门面转发.-> App
Compat -.惰性映射.-> Sdk
Compat -.精确别名.-> App
Compat -.精确别名.-> Db
Compat -.精确别名.-> Foundation
Compat -.精确别名.-> Adapters
```
图中的 `Chain → Db`、`Application → Db` 表示通过应用端口、Oper 或组合根注入的实现完成持久化,
不是允许在用例代码中直接创建数据库引擎或拼接 SQL。`compat` 也不是只面向 SDK 的转发层,
它按 `app/runtime/compat/manifest.py` 的白名单把已经删除的旧模块/符号精确映射到各自的 canonical
归属。`app/application/subscribe.py` 与 `app/application/plugins.py` 都是 V3 重构过程中新增、
未形成插件 ABI 的宿主内部聚合文件,主题实现收口后直接删除,不在 manifest 中制造新的兼容债务。
**依赖方向的核心约束**(由 `tests/test_architecture_dependencies.py` 强制检查):
| 方向 | 状态 |
|---|---|
| 入口层 → Chain / Application / Oper | 允许(按工作流复杂度选择) |
| Chain → Module | 仅允许通过 `run_module` 方法名分发,禁止直接 import 模块内部 |
| Chain → Agent 实现 | 禁止;只能经 `app/application/agent.py` 门面 |
| Application → Domain / Runtime / Adapter / Oper | 允许 |
| Module → Module / Chain | 禁止(跨模块编排一律进 Chain) |
| Adapter → Application / runtime.extensions / sdk / compat | 禁止 |
| Domain → Runtime / Adapter / Application / DB | 禁止 |
| Foundation → 任何其他 app 包 | 禁止 |
| 规范实现包 → sdk / compat | 禁止 |
| 任何形成模块级循环依赖的 import | 禁止(延迟导入也不被接受) |
---
## 三、核心包职责速查
| 包 | 职责 | 代表性文件 |
|---|---|---|
| `app/foundation/` | 无状态、无配置、无 I/O 的底层原语:反射/动态导入、加密、DOM、单例、文本、URL、版本比较 | `reflection.py`、`crypto.py`、`singleton.py` |
| `app/domain/` | 纯 MoviePilot 业务语义:媒体上下文、识别解析、站点状态解释、磁力语义、NFO 刮削 | `context.py`、`metainfo.py`、`meta/`、`scraper.py` |
| `app/runtime/` | 进程级运行机制:配置、进程拓扑、事件、完整日志、缓存契约与内存后端、并发、调度、限流、本地化、GC、重启状态 | `config.py`、`topology.py`、`events.py`、`log.py`、`cache.py` |
| `app/runtime/extensions/` | 模块 / 插件 / 配置化服务 / 托管资源的发现、注册与生命周期适配;旧管理器文件保留稳定 ABI 门面,具体实现拆在主题子包 | `module_manager.py`、`plugin_manager.py`、`plugin/` |
| `app/runtime/compat/` | 仅标准库的精确旧模块、包与符号导入路由;不是业务实现,也不是通用 re-export 层 | `manifest.py`、`imports.py` |
| `app/adapters/network/` | 通用 HTTP、浏览器、DNS、Cloudflare、IP 传输机制 | `http.py`、`browser.py` |
| `app/adapters/cache/` | Redis 与文件缓存的具体实现 | `backends.py`、`redis.py` |
| `app/adapters/system/` | OS/文件/进程/stdio/显示/包安装/Rust 加速适配 | `host.py`、`resource.py`、`fsproxy.py` |
| `app/adapters/external/` | 命名外部生态:插件市场、CookieCloud、OCR、IP 归属、MP Server、微信加密 | `market.py`、`server.py`、`wechat_crypt.py` |
| `app/application/` | 读取配置/持久化状态的聚焦应用服务:识别、过滤、通知、RSS、站点、下载器、媒体服务器、存储、整理规则等;同一主题拆成子包 | `recognition.py`、`rules.py`、`rss.py`、`site/`、`subscription/`、`plugin/` |
| `app/application/subscription/` | 订阅新增、查询、变更、删除、媒体身份与搜索契约 | `write.py`、`contract.py`、`mutation.py`、`delete.py`、`identity.py`、`search.py` |
| `app/application/plugin/` | 插件市场、安装、运行时端口、文件夹操作和动态路由用例;具体 FastAPI 路由适配器在 adapters 层 | `catalog.py`、`install.py`、`runtime.py`、`folders.py`、`routes.py` |
| `app/application/messaging/` | 渠道回环入口、消息渲染/路由、命令交互会话、插件按钮回调、Agent 消息桥接 | `ingress.py`、`message.py`、`router.py`、`agent.py` |
| `app/application/security/` | 认证、授权、Cookie、Passkey、OTP/二次认证、SSRF 与 URL/路径安全 | `auth.py`、`url.py`、`twofactor.py` |
| `app/chain/` | 跨入口复用的用例编排:订阅、搜索、下载、整理、媒体、消息等 Chain | `subscribe.py`、`search.py`、`transfer.py` |
| `app/modules/` | 可插拔后端:下载器、媒体服务器、元数据源、消息渠道、索引器、存储 | `qbittorrent/`、`emby/`、`telegram/`、`themoviedb/` |
| `app/db/` | SQLAlchemy 模型(`models/`)与一一对应的数据访问类(`oper/`) | `models/subscribe.py` ↔ `oper/subscribe.py` |
| `app/schemas/` | Pydantic 传输模型、枚举(`ModuleType`、`EventType`、`SystemConfigKey` 等) | `types.py`、`context.py` |
| `app/api/` | FastAPI 主端点、鉴权依赖、统一 `Response` 响应封装;动态插件端点不走此统一包装 | `apiv1.py`、`endpoints/`、`response.py` |
| `app/adapters/web/plugin/` | FastAPI 动态插件路由的技术适配:注册/移除、认证依赖、OpenAPI 重建;保留插件原生响应结构 | `routes.py` |
| `app/agent/` | AI Agent:编排器、运行时、工具、中间件、LLM、记忆、技能、策略 | `orchestrator.py`、`runtime_loader.py`、`tools/` |
| `app/startup/` | 组合根:装配注入、初始化/关停排序、重启策略 | `lifecycle.py`、`modules_initializer.py` |
| `app/sdk/` | 面向新插件的稳定导入面(网络、缓存、日志、浏览器等);`_legacy/` 只承载旧插件行为适配薄门面 | `network.py`、`browser.py`、`cache.py`、`_legacy/` |
| `app/monitor/` | 源目录监控 → 触发整理 | `watcher.py`、`dispatcher.py` |
| `app/workflow/` | 工作流引擎 | — |
| `app/plugins/` | 插件运行时副本/覆盖目录,由插件管理器加载;不是官方插件源码或宿主架构实现,架构审计以插件仓库与宿主边界为准 | — |
---
## 四、启动与生命周期
`app/startup/` 是全应用唯一的组合根:负责向低层注入依赖、编排初始化/关停顺序、决定重启策略。
低层模块不允许反向 import `startup`。
```mermaid
sequenceDiagram
participant Main as app/main.py
participant Factory as app/factory.py
participant Life as startup/lifecycle.py
participant Init as 各 initializer
participant FastAPI as FastAPI 主循环
Main->>Factory: 导入并创建 FastAPI 实例
Factory->>Factory: create_app():异常处理器 / CORS / 本地化中间件
Factory->>Init: register_api_app(app) 注入插件路由服务
Factory-->>Life: lifespan 绑定到 app
Main->>FastAPI: Server.run() 触发 lifespan 启动
Life->>Life: configure_cache_dependencies()
(必须先于业务模块导入)
Life->>Init: prepare_database() + revision/head 校验
Life->>Init: configure_default_user_agent(注入 UA)
Life->>Init: configure_domain_dependencies(领域层依赖注入)
Life->>Init: get_engine() / get_global_async_engine() 预热 + fail-fast
Life->>Init: check_connection_budget() 连接预算核算
Life->>Init: init_routers(app) 注册 API 路由
Life->>Init: init_modules() 发现并初始化模块,返回 HostRuntime
Life->>FastAPI: app.state.host_runtime = HostRuntime
Life->>Init: init_plugins() / init_scheduler() / init_monitor()
Life->>Init: init_command() / init_workflow()
Life->>Init: replay_pending_transfers()(后台回放未整理文件)
Life->>Life: 发布 database_ready + lifecycle_ready
Life->>FastAPI: yield,交还控制权
Note over Life,FastAPI: 运行期……
FastAPI->>Life: 收到停止信号
Life->>Init: 逆序关停:工作流→命令→监控→定时器→插件→模块
Life->>Life: 关闭共享异步 HTTP 连接池
Life->>Life: LoggerManager.shutdown()(最后关日志)
```
关键设计点:
- **缓存装配先于业务导入**:缓存装饰器会在业务模块 import 时创建后端,
因此 `configure_cache_dependencies()` 在 `lifecycle.py` 顶部即执行。
- **Uvicorn 入口分流**:生产单 worker 使用带协作停止语义的 `MoviePilotServer`;开发 reload
和安全模式多 worker 使用 `app.factory:create_app` import string/factory,由 supervisor
创建应用实例。`app.factory:app` 继续保留给既有 ASGI supervisor 和测试使用。
- **数据库准备唯一入口**:建表、迁移、迁移前备份和 Alembic head 校验统一由 lifespan
最早的“数据库准备”组件执行,`app.main` 不再主动迁移。主程序、外部 supervisor、factory
和 TestClient 因而共享同一 fail-fast 语义。
- **引擎预热 fail-fast**:同步/异步数据库引擎在单线程期完成首次创建,
避免调度器放出大量线程后再创建引擎导致连接锁竞争。
- **类型化请求装配**:`startup/composition/context.py` 的 frozen slots `HostRuntime` 是 lifespan 内唯一宿主
上下文,`api/context.py` 从 `app.state` 收窄到具体领域能力。认证、消息、历史、媒体服务器、站点、
订阅、工作流和请求事务均使用命名 runtime 字段,不再通过字符串仓储键定位;API、Scheduler、Chain
从 `HostRuntime.configuration` 获取 frozen 配置快照。系统设置管理 API 通过
`HostRuntime.settings` 的窄服务读写可变部署设置,业务域不接触 Settings 实例;生产与测试组合根统一
复用 `startup/composition/configuration.py` 的映射。`ApiDataPorts` 仅保留旧导入 ABI,不参与正式请求链路。
- **安全模式**:`MOVIEPILOT_SAFE_MODE` 会跳过插件、定时器、监控器、命令与工作流,用于故障自救。
- **进程拓扑**:全功能 V3 强制 `API_WORKERS=1`,避免每个 worker 重复启动插件和后台控制面;安全模式可临时使用多 worker 诊断,但不是正式扩容方案。
- **健康语义**:`/health/live` 只确认进程和事件循环可响应;`/health/ready` 仅在数据库
到达当前 head 且生命周期完成后返回 200,启动失败或关停阶段返回 503。两者不公开路径、
revision、插件和异常详情,深入诊断继续使用 Doctor。
- **关停隔离**:每个关停步骤由 `run_shutdown_step` 独立捕获异常,保证后续资源仍有机会释放。
---
## 五、核心设计模式
### 5.1 Module 模式:可插拔后端
`app/modules/` 下每个目录是一个可插拔后端(下载器、媒体服务器、消息渠道、元数据源、索引器、
存储等),均继承 `_ModuleBase` 并实现统一契约:
```mermaid
flowchart LR
subgraph 契约["_ModuleBase 契约"]
A["get_name / get_type / get_subtype"]
B["init_setting():返回控制开关的配置项"]
C["init_module():初始化"]
D["test():连通性测试"]
E["stop():停止"]
end
MM["ModuleManager
(发现 + 注册 + 生命周期)"]
MM -->|扫描 app/modules/* 一级子包| M1["qbittorrent"]
MM --> M2["transmission"]
MM --> M3["emby / plex / jellyfin"]
MM --> M4["telegram / wechat / slack ..."]
MM --> M5["themoviedb / douban / bangumi ..."]
MM --> M6["indexer / subtitle / filter ..."]
```
- 模块由 `runtime/extensions/module_manager.py` 发现并管理生命周期;
`app/modules/_base/` 承载各模块族的共享模板基类(下载器、媒体服务器、消息渠道)。
- 模块开关由 `init_setting()` 声明的配置项决定(如 `DOWNLOADER = "qbittorrent"`)。
- **模块之间、模块到 Chain 的直接依赖被禁止**,跨模块编排一律由 Chain 完成。
- 渠道/存储的管理操作遵循统一契约:`channel_manage(channel, action, **params)` /
`storage_manage(storage, action, **params)`,结果统一为 `{"success", "message", "data"}` 形态,
Chain 与端点只做透传。
### 5.2 Chain 模式:用例编排
`app/chain/` 承载被 API、CLI、Agent、调度器、Webhook 等多入口共享的业务用例。
所有 Chain 继承 `ChainBase`,Chain 访问模块**只能通过方法名分发**:
```mermaid
flowchart TB
Entry["API / CLI / Agent / 调度器 / Webhook"]
C["SearchChain / SubscribeChain /
DownloadChain / TransferChain ..."]
Base["ChainBase
run_module / async_run_module"]
MM["ModuleManager 分发"]
P["插件模块(同名方法优先)"]
M1["模块 A"]
M2["模块 B"]
Entry --> C --> Base
Base -->|先查询插件实现| P
Base --> MM
MM --> M1
MM --> M2
```
- `run_module("method_name", **kwargs)` 会遍历所有实现了该方法的模块并聚合结果;
插件若实现了同名方法可获得优先响应。
- `runtime/extensions/module/contracts.py` 为宿主已观察到的方法提供显式参数与返回合同;兼容期只诊断
旧插件签名差异,不改变插件优先级、短路和自由返回语义。
- `app/chain/` 中下划线前缀文件(`_recognition.py`、`_messaging.py`、`_interaction.py`、
`_music.py`、`_transfer.py`)是 `ChainBase` 的功能域 Mixin,不是独立 Chain。
- 需要斜杠命令交互的 Chain 继承 `InteractionChainMixin`,只实现 `_interaction_handler`。
### 5.3 Event 模式:跨切面事件
`EventManager`(`app/runtime/events.py`)提供进程级事件总线,用于解耦跨切面反应
(整理完成后刷新媒体库、配置变更后重载模块、消息分发等):
宿主内建 `EventType` / `ChainEventType` 均在事件注册表中绑定 typed payload。开放插件事件允许
额外字段,校验只生成诊断;分发给既有插件的仍是原始 dict/model 对象,不改变事件 ABI。
```mermaid
sequenceDiagram
participant T as TransferChain
participant EM as EventManager
participant MS as MediaServerChain
participant N as NotificationChain
participant PL as 插件(注册了同一事件)
T->>EM: send_event(EventType.TransferComplete, data)
EM->>MS: on_transfer_complete(event)
EM->>N: on_transfer_complete(event)
EM->>PL: on_transfer_complete(event)
Note over EM: 处理器通过 @eventmanager.register(EventType.X) 注册
事件类型集中在 schemas.types.EventType
```
### 5.4 Oper 模式:数据访问层
数据库读写一律通过 `app/db/oper/` 下的 Oper 类,禁止在 Chain / Module / 端点中直接写
SQLAlchemy 查询。`models/` 与 `oper/` 按文件一一镜像(站点族聚合于 `oper/site.py` 等少数例外)。
```mermaid
flowchart LR
Entry["API / Scheduler / Agent
逻辑操作入口"]
Command["Application Command
事务所有者"]
UoW["app/db/uow.py
commit / rollback"]
Oper["app/db/oper/*.py
SubscribeOper / TransferHistoryOper ..."]
Models["app/db/models/*.py
SQLAlchemy 模型"]
Engine["app/db/engine.py
同步 + 异步引擎"]
DB[("PostgreSQL / SQLite")]
Entry --> Command --> Oper --> Models --> Engine --> DB
Entry --> UoW --> Engine
Command -.提交或回滚.-> UoW
Command -.commit 后副作用.-> Effects["Event / Scheduler / Report"]
Models -.before_insert/before_update.-> Norm["_identity.py
media_source/media_id 归一化"]
```
- Oper 只接收和返回持久化值;`MediaInfo` / `MetaBase` 与数据库行之间的转换属于业务逻辑,
归 `app/application/`(见 `application/subscription/write.py`、`application/history.py`)。
订阅新增、查询、变更、删除、身份和搜索契约已经统一收口在 `application/subscription/`,
不再保留主题包之外的第二个写入入口。
- 规范写入口中的 Oper 只 stage mutation,不创建独立 Session、不提交;Application Command
通过请求或任务入口注入的 UnitOfWork 统一 `commit/rollback`,事件、刷新和上报只在 commit
成功后执行。订阅新增 Port 位于 `application/subscription/write.py`,由
`db/adapters/subscription.py` 创建独占 Session,`startup/composition/subscription.py` 只装配回调,
`application/subscription/write.py` 决定事务与 post-commit 边界,`SubscribeOper.stage_add()`
只查重、`add` 和 `flush`。旧 SDK 显式构造的无会话 Oper 暂留兼容自动短会话,不得被新代码复用。
`transaction-debt-baseline.json` 要求 Model 上的查询/写装饰器持续保持为 0。Model 与 Base
已不再导入数据库装饰器,所有 `db` 参数都要求显式 Session;这些方法只查询或 stage,不能
创建、提交、回滚或关闭事务。无会话入口只存在于 Oper,由 `_execute_*` 经组合根事务执行器
承接;内置插件必须调用 Oper,不得直接导入宿主 Model。AST 门禁同时约束装饰器、可选 Session
和插件到 Model 的依赖,保证提交权不会被底层抢走。
- 站点、历史、工作流、Agent 会话删除和插件数据重置已经形成同构事务切片;对应 Application
Command/Service 持有 UoW,Oper 的 `stage_*` 方法只修改当前会话。插件数据重置从
`startup/initializers/plugins.py` 注入事务能力,插件直接使用 `PluginDataOper` 的旧 ABI 仅作兼容。
- 每次表结构变更必须新增 `database/versions/` 下的 Alembic 迁移。
- 运行期业务配置使用 `SystemConfigKey` 枚举 + `SystemConfigOper`,禁止裸字符串键;
用户级配置使用 `UserConfigOper`。
### 5.5 其他横切模式
| 模式 | 说明 |
|---|---|
| **Config Reload** | 继承 `ConfigReloadMixin` 并声明 `CONFIG_WATCH`,配置变更时自动重建长生命周期对象(如下载器客户端重连) |
| **Singleton** | `EventManager`、`ModuleManager`、`PluginManager` 等全局共享管理器继承 `foundation/singleton.py` 的 `Singleton` |
| **Managed Resource** | 可选进程级技术资源(浏览器、虚拟显示等)以 data-only `capability.toml` 声明,`runtime/extensions` 解释生命周期,`startup` 构建 Runtime,消费者经 `runtime/managed_resources.py` 显式获取;插件使用浏览器走 `app.sdk.browser` |
| **Observability** | `runtime/observability` 定义低基数指标和默认 no-op 端口,Startup 可选装配 OTel;HTTP、DB、Event、Module、Scheduler、插件生命周期和 Agent 只提交白名单标签 |
---
## 六、典型业务调用流程
### 6.1 搜索 → 过滤 → 下载
```mermaid
sequenceDiagram
participant E as 入口(API / 消息命令 / Agent / 订阅)
participant SC as SearchChain
participant MC as MediaChain
participant TC as TorrentsChain(索引)
participant FC as 过滤(application/filter + rules)
participant DC as DownloadChain
participant MOD as run_module 分发
E->>SC: search(title)
SC->>MC: 识别与媒体信息补全(TMDB/Douban 模块)
SC->>TC: 检索站点资源(indexer 模块 / 站点插件)
TC->>MOD: search_torrents(...)
SC->>FC: 按规则组过滤与排序
SC->>DC: download(torrent)
DC->>MOD: download_torrent(...)(下载器模块)
DC-->>E: 返回下载结果 / 发送通知事件
```
### 6.2 订阅全流程
```mermaid
flowchart TB
A["用户创建订阅
API / 消息 / Agent"] --> B["SubscribeChain
写入订阅(application/subscription/write.py)"]
B --> C{"调度器周期触发
SubscribeChain.process"}
C --> D["搜索缺失集数
(复用搜索流程)"]
D --> E{"命中资源?"}
E -->|是| F["DownloadChain 下载"]
F --> G["TransferChain 整理入库"]
G --> H["刷新媒体库 + 发送通知"]
H --> I{"订阅是否完结?"}
I -->|否| C
I -->|是| J["标记完成 / 发送完成通知"]
```
### 6.3 文件整理(Transfer)与监控
```mermaid
sequenceDiagram
participant W as app/monitor 目录监控
participant T as TransferChain
participant R as 识别(domain/metainfo + application/recognition)
participant FS as adapters/system(文件操作)
participant SC as ScrapingChain(刮削)
participant EM as EventManager
W->>T: 发现新文件,触发整理
T->>R: 解析名称/路径得到 MetaBase
T->>R: 匹配媒体(MediaChain)
T->>FS: 按目录配置转移/重命名
T->>SC: 生成 NFO / 图片刮削(domain/scraper)
T->>EM: send_event(TransferComplete)
Note over EM: 媒体服务器刷新、通知、
插件等订阅方各自响应
```
启动时 `replay_pending_transfers()` 会在后台线程回放上次未整理完的文件,保证崩溃恢复。
### 6.4 消息命令交互
```mermaid
flowchart LR
CH["消息渠道模块
telegram / wechat / slack ..."] --> MP["MessageProcessingMixin
(ChainBase)"]
MP --> RT["application/messaging/router.py
统一优先级与回调分发"]
RT --> CMD["Command 命令注册表
(application/commands.py 门面)"]
RT --> IT["InteractionChainMixin
斜杠命令 / 按钮回调"]
RT --> PLG["插件输入接管
(messaging/plugin.py)"]
RT --> AG["Agent 会话
(messaging/agent.py → application/agent.py)"]
CMD --> Chain["对应业务 Chain"]
IT --> Chain
```
- `app/application/messaging/` 负责渠道回环入口(`ingress.py`)、消息渲染、模板、队列(`message.py`)、交互会话与视图;
业务工作流仍由对应 Chain 执行(如媒体交互的业务部分在 `MediaInteractionChain`)。
- 该包不作为推荐给插件直接使用的公开 SDK。
---
## 七、AI Agent 子系统
Agent 采用**门面 + 惰性物化**设计,避免 `application → agent` 形成静态依赖边:
```mermaid
flowchart TB
Entry["消息渠道 / API / MCP"] --> Facade["app/application/agent.py
编排门面(get_agent_manager 等)"]
Reg["app/startup/initializers/agent.py
导入期注册轻量 Provider"]
Facade -.能力启用或首次使用时物化.-> RT["app/agent/runtime_loader.py
能力发现与服务物化"]
RT --> ORC["app/agent/orchestrator.py
会话编排"]
ORC --> Tools["app/agent/tools
系统工具(经 application 门面)"]
ORC --> LLM["app/agent/llm
LLM 提供商管理"]
ORC --> MW["middleware / policy / memory / skills"]
style Facade fill:#eef
```
约束要点:
- Chain 访问 Agent 运行时只能经 `app/application/agent.py`;
`app/chain/agent.py` 的 `AgentChain` 是链层入口,Agent 实现保持在 `app/agent/`。
- Agent 工具不直接 import API / 调度器 / 命令:插件动态路由与文件夹操作使用
`application/plugin/routes.py`、`application/plugin/folders.py`,调度和命令分别使用
`application/scheduling.py`、`application/commands.py`。FastAPI 具体实现位于
`adapters/web/plugin/`,入口层不承载路由实现。
- 对外暴露 MCP 端点 `/api/v1/mcp` 与 OpenAI / Anthropic 兼容端点,
错误响应在 `app/factory.py` 中按协议原生格式单独处理(不走统一 `Response` 包装)。
---
## 八、插件系统与 SDK / 兼容边界
```mermaid
flowchart TB
subgraph 插件侧
P["app/plugins/*
(运行时副本/覆盖层)"]
end
subgraph 宿主边界
SDK["app/sdk
新插件稳定导入面
network / cache / logging / browser ..."]
Compat["app/runtime/compat
manifest 精确模块/符号映射
app.core / app.helper / app.utils / app.log 及已删除旧路径"]
PM["PluginManager
发现 / 生命周期 / 事件桥接"]
end
subgraph 规范实现
Canonical["foundation / domain / runtime /
application / adapters / chain ..."]
end
P -->|新插件推荐| SDK
P -->|旧插件(DEBUG 下告警)| Compat
SDK -->|门面转发| Canonical
Compat -.惰性解析.-> SDK
Compat -.惰性解析.-> Canonical
PM -->|run_plugin 方法分发 / 事件广播| P
Canonical -.-|禁止 import| Compat
Canonical -.-|禁止 import| SDK
```
- `app/plugins/` 是运行时插件副本,不是官方插件仓库的源码副本;它不纳入宿主架构拆分的源代码审计。
宿主代码只使用 canonical 路径;只有运行时插件与兼容性测试可用旧路径。
- `compat` 只存字符串映射并惰性解析,不得在模块导入期急切 import canonical 实现;
canonical 包也不得为兼容而反向 import `compat` / `sdk`。
- 插件 API 的动态注册/移除及端口协议统一位于 `app/application/plugin/routes.py`,
FastAPI 技术实现位于
`app/adapters/web/plugin/routes.py`;FastAPI 实例由组合根(`app/factory.py`)在创建后注入,
端点层禁止直接依赖 `factory`。
- 动态插件路由使用原生 `APIRoute`,插件自行决定返回结构;主程序的统一 `Response` 封装只适用于
`app/api/` 的宿主端点。插件若已经自行返回 `Response`、字典、列表或其它可序列化值,宿主不再二次包裹。
- `app/runtime/extensions/plugin_manager.py` 是保留插件 ABI 的管理器门面,发现、加载、生命周期、
目录、同步等实现拆在 `app/runtime/extensions/plugin/`;这个“门面 + 实现包”是有意的兼容边界,
不应为了目录整齐而让外部插件改用内部实现文件。
- 插件可参与 `run_module` 方法分发(同名方法优先响应)并注册事件处理器。
---
## 九、运行时基础设施
### 9.1 runtime 与 adapters 的分工
```mermaid
flowchart LR
subgraph runtime["app/runtime(契约 + 内存行为)"]
RC["config.py
Settings / 部署配置"]
RE["events.py
事件总线"]
RL["log.py
日志运行时(依赖叶子)"]
RCA["cache.py
缓存协议 / 内存后端 / 装饰器"]
MR["managed_resources.py
托管资源门面"]
end
subgraph adapters["app/adapters(具体 I/O)"]
AC["cache/backends.py
Redis / 文件缓存"]
AN["network/http.py
同步 + 异步 HTTP 客户端"]
AB["network/browser.py
浏览器会话"]
AS["system/*
OS / 文件 / 进程 / Rust"]
AE["external/*
市场 / OCR / MP Server"]
end
Startup["app/startup
启动期注册具体缓存工厂"]
Startup --> RCA
Startup --> AC
Caller["上层调用方"] -->|装饰器/协议| RCA
RCA -.可切换后端.-> AC
Caller --> AN
Caller --> AB
```
- **所有第三方 HTTP 请求必须走 `RequestUtils`**(`app/adapters/network/http.py`);
插件使用 `app.sdk.network`。
- `app/runtime/log.py` 是依赖叶子(无任何 `app.*` 导入);`foundation` 不输出运行日志,
由上层所有者决定是否记录。
- 缓存契约与内存后端在 `runtime/cache.py`,Redis/文件实现在 `adapters/cache/backends.py`,
由 startup 在被装饰的业务模块导入前完成工厂注册。
### 9.2 数据与配置总览
| 类别 | 载体 | 说明 |
|---|---|---|
| 持久化业务数据 | `app/db/models` + Alembic | 每次 schema 变更必须配套迁移 |
| 运行期业务配置 | `SystemConfigKey` + `SystemConfigOper` | 用户可编辑、跨重启持久 |
| 用户级配置 | `UserConfigOper` | 按 `user_id` 隔离 |
| 部署配置 | `runtime/config.py` 的 `Settings` | 环境变量 / `app.env` |
| 缓存 | `runtime/cache.py` 装饰器 | Redis 或文件后端可切换 |
| 站点资源 | `app/application/site/sites.*` | 生成的站点目录、认证与索引能力数据包 |
---
## 十、架构治理
架构边界不是文档约定,而是**由测试强制执行的门禁**:
- `tests/test_architecture_dependencies.py` 构建完整 Python 模块图,拒绝:
物理遗留源码、禁止的上向依赖、SDK/compat 反向引用、包含迁移模块的强连通分量、
模块间/模块到 Chain 的 import、入口层对 `app.modules` 内部的 import、
Chain 直接 import 模块内部(必须走 `run_module` 分发)、`app/chain` 内的下载器 SDK 依赖。
- 任何所有权迁移必须同步更新:canonical 导入、`app/runtime/compat/manifest.py`、
SDK 导出(若公开)、`docs/rules/05-architecture.md` 与上述架构测试。
- 延迟导入不被接受为隐藏循环依赖的手段。
### 10.1 2026-08-18 收口状态与后续边界
本总览与本轮架构治理的关系如下:
- 已完成的宿主边界:旧 `app.core` / `app.helper` / `app.utils` / `app.log` 根路径通过
`app/runtime/compat/manifest.py` 精确映射;订阅、历史、用户认证等旧 Oper 入口通过
`app/sdk/_legacy/` 薄门面保留行为兼容。兼容清单是导入路由,不负责合并模块,也不负责把任意
新实现重新导出到旧模块。
- 已完成的插件边界:插件 API 的动态路由由 application 端口 + web adapter 组成,使用原生
`APIRoute` 保留插件响应;插件管理器保留 `plugin_manager.py` 的稳定 ABI,内部实现拆在
`runtime/extensions/plugin/`;`app/plugins/` 仅作为运行时插件副本/覆盖层处理。
- 已完成的主题收口:订阅写入归入 `app/application/subscription/write.py`;插件动态路由与
文件夹操作归入 `app/application/plugin/routes.py`、`folders.py`。原
`app/application/subscribe.py`、`app/application/plugins.py` 未形成插件 ABI,已经直接删除,
宿主调用统一改为 canonical 路径。
- 判断是否需要新增 manifest 映射的标准:只有当旧物理模块被删除、改名或公开符号迁移时才登记;
物理文件仍是稳定入口的,不应为了目录规整新增“自己映射自己”的别名,也不应在 canonical 包中
保留多余导出。
详细的迁移批次、风险、验证命令和插件兼容矩阵见
[`docs/refactor/backend-architecture-governance.md`](refactor/backend-architecture-governance.md) 与
[`docs/refactor/backend-module-refactor-compatibility.md`](refactor/backend-module-refactor-compatibility.md)。
第一阶段分层收口后的进程拓扑、事务所有权、类型化运行时契约、后台可靠性和可观测性路线见
[`docs/refactor/backend-architecture-next-stage.md`](refactor/backend-architecture-next-stage.md)。
---
## 附录:相关文档索引
| 文档 | 内容 |
|---|---|
| [`docs/rules/01-project-overview.md`](rules/01-project-overview.md) | 系统目标与业务范围 |
| [`docs/rules/02-tech-stack.md`](rules/02-tech-stack.md) | 技术栈与第三方集成 |
| [`docs/rules/04-design-patterns.md`](rules/04-design-patterns.md) | Module / Chain / Event / Oper 等模式细则 |
| [`docs/rules/05-architecture.md`](rules/05-architecture.md) | 层边界、依赖方向与关键文件位置(权威) |
| [`docs/rules/09-external-response.md`](rules/09-external-response.md) | 外部 HTTP 约定与统一响应格式 |
| [`docs/rules/10-data-and-persistent.md`](rules/10-data-and-persistent.md) | 数据模型、迁移与缓存规范 |
| [`docs/subscribe-lifecycle.md`](subscribe-lifecycle.md) | 订阅生命周期详解 |
| [`docs/mcp-api.md`](mcp-api.md) | MCP 工具端点说明 |
| [`docs/refactor/backend-architecture-governance.md`](refactor/backend-architecture-governance.md) | 分阶段架构治理、边界门禁与迁移验收 |
| [`docs/refactor/backend-module-refactor-compatibility.md`](refactor/backend-module-refactor-compatibility.md) | 模块迁移与插件兼容层实施矩阵 |
| [`docs/refactor/backend-architecture-next-stage.md`](refactor/backend-architecture-next-stage.md) | 对标优秀 Python 后端后的二阶段任务、验收与回滚方案 |