xmpp_client_core

项目背景与战略目标

xmpp_client_core 是一个为 OpenHarmony 平台提供的 XMPP（Extensible Messaging and Presence Protocol）客户端核心库，用于构建具备完整实体（entity）属性管理能力的即时通信客户端基础设施。该项目在后端架构中承担协议状态机管理、XML 流解析、会话生命周期控制、认证协商等关键职责，是构建聊天机器人、IoT 设备协同、企业通信网关等后端服务的基础组件。依托仓颉编程语言（Cangjie Language）1.0.0+ 的内存安全特性（彻底消除缓冲区溢出、空指针解引用等 CVE 类漏洞）、轻量级线程模型（高效支持万级并发连接）、强类型系统（确保协议状态转换正确性）以及 CJNative 高性能 FFI 能力（无缝对接底层网络与加密库），本项目旨在打造一个高性能、高可靠、可扩展的 XMPP 客户端核心引擎，填补仓颉生态在标准通信协议栈领域的空白。

核心功能需求与技术规格

2.1 功能模块分解

2.2 非功能性需求规范

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

• 安全要求：所有网络输入经强类型校验；凭据、会话令牌生命周期由仓颉所有权自动管理，杜绝泄露。

• 可靠性：支持自动重连、流错误恢复；异常路径全覆盖，无 panic 导致进程崩溃。

• 可维护性：模块高度解耦（stream、auth、session 分离）；接口符合仓颉惯用法（idiomatic Cangjie）。

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

interface XmppClient {
    // 连接到 XMPP 服务（xmpp:// 或 xmpps://）
    async fn connect(self, service: Uri) -> Result<(), XmppError>;

    // 发送 Stanza（message/presence/iq）
    async fn send(&self, stanza: Stanza) -> Result<(), XmppError>;

    // 监听传入节
    fn onStanza(self, handler: fn(Stanza) -> ()) -> Self;

    // 获取当前连接参数（用于调试或日志）
    fn socketParameters(&self) -> SocketParams;
}

enum XmppError {
    ConnectionFailed(IoError),
    AuthenticationFailed(AuthError),
    StreamError(StreamError),
    InvalidStanza(String),
}

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

项目交付物与实施路线图

3.1 阶段性交付物清单

• 第一阶段：核心协议状态机 + XML 流解析 + 单元测试（覆盖率≥95%） + 接口文档

• 第二阶段：SASL 认证集成 + 多连接并发支持 + 与 cj-xmpp-tls 对接

• 第三阶段：性能调优报告 + 生产部署指南 + 发布至 cjpm 仓库

3.2 项目实施路线图

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

4.1 仓颉语言专项质量规范

• 编码规范：100% 通过 cjfmt 格式校验；禁止使用 Any 或动态反射。

• 类型安全：所有协议字段使用精确类型（如 Jid 而非 String）；泛型用于事件处理器。

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

4.2 测试与验证标准

• 单元测试：覆盖所有状态转换路径和错误分支，行覆盖率 ≥95%。

• 互操作测试：使用标准 XMPP 测试套件（如 Compliance Tester）验证 RFC 合规性。

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

4.3 文档与可维护性

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

• 记录状态机设计、Stanza 内存模型等关键决策（ADR）。

• 提供清晰的 CONTRIBUTING.md 和 .cjpmrc 配置。

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. 满足基础的网络安全红线及隐私要求，符合安全编码规范。

过程质量要求