xmpp_component_core

项目背景与战略目标

xmpp_component_core 是一个为 OpenHarmony 平台提供的 XMPP（Extensible Messaging and Presence Protocol）组件核心库，用于构建符合 XEP-0114 标准的服务器端扩展服务（如网关、机器人、通知服务等）的基础通信能力。该项目属于后端网络通信基础设施的关键底层组件，负责管理与主 XMPP 服务器的连接生命周期、执行组件级身份验证、处理 XML 流及基本 Stanza 收发。依托仓颉编程语言（Cangjie Language）1.0.0+ 的内存安全特性（彻底消除因 XML 解析或字符串拼接导致的缓冲区溢出、空指针等 CVE 风险）、轻量级线程模型（高效支撑高并发组件连接）、强类型系统（确保协议状态机与 Stanza 结构正确性）以及 CJNative 高性能 FFI 能力（无缝集成底层 TLS 与网络 I/O），本项目旨在打造一个精简、可靠、高性能的 XMPP 组件运行时内核，为上层业务逻辑提供坚实、安全的通信基座，服务于物联网协同、企业 IM 扩展、智能客服等仓颉后端场景。

核心功能需求与技术规格

2.1 功能模块分解

2.2 非功能性需求规范

• 性能指标：单连接 P99 消息收发延迟 < 2ms，吞吐量 ≥10,000 stanzas/秒（对比 TypeScript 实现提升 ≥35%）。

• 安全要求：组件密钥等敏感数据受仓颉所有权严格管控；所有 XML 输入经强类型校验，杜绝注入风险。

• 可靠性：连接异常自动重试；资源（socket、buffer）确定性释放，无泄漏。

• 可维护性：核心逻辑高度内聚，无业务耦合；接口简洁，符合仓颉惯用法。

2.3 核心接口设计示例 (伪代码)

interface ComponentCore {
    // 初始化组件（指定 JID 和密钥）
    fn new(jid: Jid, secret: String) -> Self;

    // 连接到 XMPP 服务器
    async fn connect(self, server: Uri) -> Result<(), ComponentError>;

    // 监听连接成功事件
    fn onConnect(self, handler: fn()) -> Self;

    // 监听任意 Stanza 事件
    fn onStanza(self, handler: fn(Stanza)) -> Self;

    // 发送 Stanza
    async fn send(&self, stanza: Stanza) -> Result<(), ComponentError>;
}

enum ComponentError {
    ConnectionFailed(IoError),
    AuthenticationFailed,
    StreamClosed,
    InvalidStanza(String),
}

struct Stanza {
    kind: StanzaKind,
    from: Option<Jid>,
    to: Option<Jid>,
    id: Option<String>,
    payload: XmlElement,
}

项目交付物与实施路线图

3.1 阶段性交付物清单

• 第一阶段：连接管理 + 认证逻辑 + XML 流处理 + 单元测试（覆盖率≥95%） + 接口文档

• 第二阶段：Stanza 收发引擎 + 事件系统 + 与 cj-xmpp-tls 集成测试

• 第三阶段：性能调优报告 + 自动重连机制 + cjpm 发布包

3.2 项目实施路线图

技术实现规范与质量认证体系

4.1 仓颉语言专项质量规范

• 编码规范：100% 通过 cjfmt 格式校验；禁止裸指针和 unsafe 代码（除非经安全评审）。

• 类型安全：所有协议实体使用精确类型（Jid、StanzaKind）；泛型用于事件处理器。

• 错误处理：所有公共方法返回 Result<T, E>；错误类型枚举覆盖全链路异常。

4.2 测试与验证标准

• 单元测试：覆盖认证失败、流错误、连接中断等边界场景，行覆盖率 ≥95%。

• 互操作测试：与主流 XMPP 服务器完成组件注册与基础通信流程。

• 安全扫描：通过 cjpm lint --deny-unsafe 和内存安全静态分析工具。

4.3 文档与可维护性

• 所有 public 接口包含 Doc Comments，说明线程安全性和资源生命周期。

• 记录流状态机设计、密钥处理策略等关键决策（ADR）。

• 提供 .cjpmrc 与 CONTRIBUTING.md，明确构建与提交规范。

4.4 持续集成质量门禁

# PR 自动化流水线
cjpm fmt --check
cjpm build --release
cjpm lint --deny-warnings --deny-unsafe
cjpm test --all-features --coverage
cjpm bench

技术栈与开发环境

• 核心语言：仓颉编程语言（Cangjie Language）1.0.0+

• 构建与包管理：CJPM (Cangjie Package Manager)

• 依赖组件：cj-xmpp-tls（安全传输）、cj-xml（流解析）

• 测试框架：@cangjie/test + 自定义 XMPP 服务器 mock

• 环境要求：仓颉 1.0.0+ 标准工具链；CI 使用 cangjie-lang/cj-builder:1.0 官方 Docker 镜像

交付件

验收标准

1.功能

1. 三方库必须有明确的功能；

2. 如果参考对标库移值开发，功能与参考三方库保持一致。

2.资料

1. Readme：包含简介，软件架构，目录结构，下载安装（编译构建），接口说明，使用示例，约束限制，开源协议，参与贡献等内容；

2. Changelog，三方库版本需包含基本的修改说明。

3.标准遵从性（可选），三方库实现需满足对应协议或行业标准，举例

1. appquth：支持对OAuth 的PKCE扩展；

2. icu4j：支持unicode标准库，通用字符集ISO/IEC 10646。

4.性能目标

1. 性能敏感三方库接口运行性能持平对标三方库

5.开源协议遵从，必须包含License文件

1. 放置合适的开源License协议，建议Apache License Version 2.0；

2. 引用或参考开源三方库，需遵从开源协议。

6.网络安全要求

1. 满足基础的网络安全红线及隐私要求，符合安全编码规范。

过程质量要求