Files
MoonBridge/docs/architecture.md
T

8.1 KiB
Raw Blame History

架构与边界

本文记录当前源码已经实现的边界。构建与运行限制见运维与验证;项目现有概览见 README。

模块

  • proxy-plugin-api 定义插件外部接口:生命周期、玩家/服务器只读视图、后端注册、访问检查、初始选服、命令和转服。核心实现位于 proxy-core;可选发现器位于 plugins/。
  • ProxyMain 读取严格 YAML 配置,先注册静态后端,再加载配置启用的插件,连接插件选服回调,最后启动 Netty 监听器。插件以 META-INF/services/dev.strataproxy.api.Plugin 声明,通过独立类加载器加载。
  • 核心支持 Minecraft 1.7.10(协议 5)登录和转发。OFFLINE 信任客户端提交的名字;ONLINE_BUNGEE 在代理执行加密与会话验证,并将身份转发给受信任的旧版 Bungee 后端。

入口可从 ProxyMain、ProxySessionListener 和 PluginHost 追踪。

会话与连接生命周期

ProxySessionListener 负责接入限额、监听器生命周期和 UUID 到当前会话的索引;每个 Session 持有该连接的前端/后端通道和协议状态。玩家身份由 UUID 与连接代次组成。插件查询使用不可变 PlayerView;异步工作返回时会核对当前连接身份,避免旧连接结果作用于重连后的同 UUID 玩家。在线列表来自活动会话,不另存一份可竞争的玩家状态。

连接首先经过可选的 IP 检查,再解析 Handshake/Login Start。在线模式完成加密与会话验证,离线模式生成离线身份;随后经过可选玩家访问检查、异步初始选服,再连接后端并写入 Login Start。后端 Login Success 校验通过后发布在线玩家视图、向客户端提交登录成功并进入双向转发。此时初次 PLAY/Forge 握手可能尚未完成;转服还要等待该握手就绪。身份冲突、协议错误、登录阶段失败和断线会关闭本次连接并释放索引与资源。登录失败原因可以编码成客户端断开消息;网络关闭或帧处理错误则清理连接。

flowchart LR
    A[TCP 建连] --> B{连接检查}
    B -->|允许| C[协议与身份验证]
    B -->|拒绝或失败| X[关闭连接]
    C --> D{玩家访问检查}
    D -->|允许| E[初始选服]
    D -->|拒绝或失败| Y[登录断开消息]
    E --> F[后端登录]
    F --> G[PLAY / Forge 握手与转发]

普通转发沿用协议 5 帧边界,不重新编码普通帧。前后端通道绑定同一 Netty EventLoop,会话控制状态在该循环串行变更。Keep Alive ID 由代理转换并跟踪未完成请求;必要的玩家实体 ID 数据包在转服后改写。通道不可写时通过暂停对端读取施加背压。实现见 Session、RawRelay 与 KeepAliveBridge。

后端目录与发现所有权

静态配置和插件注册共用核心后端目录。插件通过 Servers.find/all 取得 ServerView 快照;ServerView 仅含名称、地址、标签和插件元数据,不含负载、玩家数或容量。插件以 Servers.register 获得所有权句柄,可更新或注销自己的条目;不能替换静态配置或其他插件拥有的同名项。重新注册同名项会生成新一代句柄,使旧句柄失效。选服拿到的是当时的后端快照,目录之后更新不改变已经开始的连接。

默认初始选服遍历当前目录并选择注册顺序中的第一个后端;有玩法选服逻辑时由插件的初始选服回调负责决定。DNS 与 Agent 发现均为可选插件,只调用通用注册 API:核心不包含 DNS/Agent 协议,也不推断后端健康或空岛可用性。DNS 插件独立查询 A/AAAA 并协调自身注册;Agent 插件通过带签名的注册端点协调租约。启用插件关闭时,宿主撤销该插件名下的注册和命令。

转服、并发与错误边界

转服先在旧后端保持服务的同时连接并登录候选后端。普通后端在 Join Game 后可进入切换;Forge 候选后端要等待客户端 Forge 握手链路切换及 Join Game,再进行世界切换。交接期间客户端与旧后端帧分别进入有上限的缓冲区;切换前失败时尽可能恢复旧链路并回放暂存帧,成功时改用候选链路并清理旧链路。候选连接失败不会立即破坏旧链路;Forge 客户端切换包写出后若目标拒绝或超时,旧链路无法安全恢复,代理会关闭会话。NETWORK_READY 只表示协议握手和代理发出的世界切换已完成,不表示目标服插件或玩法世界已准备好。接口定义见 Players、状态见 TransferStatus。

主要并发和失败界限:

  • 玩家会话的可变控制状态限制在前端 EventLoop;登录验证、后端地址解析及插件回调不在该状态路径中同步等待。
  • 插件初始选服和命令分别使用固定线程数、有界队列的工作池。排队饱和会拒绝当前操作;选服失败或超时只结束该次登录请求,不会自动卸载插件。命令异常会记录并返回通用失败文本。
  • 玩家断线会取消未决选服请求并移除尚未运行的工作;已开始的插件异步任务只能尽力取消。宿主关闭会结束未决请求,逆序调用插件关闭钩子,并在统一期限后继续回收类加载器和注册。
  • 转服缓冲有帧数和字节上限;超过上限、协议帧损坏或关键通道写失败会结束该会话。连接到达 maxConnections 时,新连接被直接关闭,该数包括尚未登录的连接。

日志统一通过 SLF4J 输出,发行包使用 Logback。访问策略不依赖额外的核心负载观测或健康状态模型。

登录访问策略扩展

玩家名/UUID 和来源 IP 的允许/拒绝判断及其封禁数据库属于 Ban 插件策略,不应放进后端目录或发现插件。插件可选实现类型化的 connectionCheck() 与 loginCheck():前者在协议解析前收到 TCP 对端地址,拒绝时直接关闭连接;后者在模式相关身份建立后、初始选服前收到 LoginRequest(含 authenticated 标志),拒绝原因作为 Minecraft Login Disconnect 文本返回。多个插件按加载顺序依次检查,全部允许才继续;异常、空结果、超时和队列过载均按拒绝处理。检查在有界工作池中运行,整个检查阶段共用一个期限;没有注册检查时不派发工作。检查只发生在连接接入和登录阶段,不进入 PLAY 包热路径。API 示例与配置细节见插件接入说明。

相关源码