xmpp_resource_binding

项目背景与战略目标

xmpp_resource_binding 是一个为 OpenHarmony 平台提供的 XMPP（Extensible Messaging and Presence Protocol）客户端资源绑定库，用于在用户成功认证后，向服务器注册唯一资源标识符（Resource），从而实现多设备在线状态区分、消息精准路由及会话管理。该项目属于后端网络通信协议栈的关键环节，是构建高可用即时通信客户端或网关的必要组件。依托仓颉编程语言（Cangjie Language）1.0.0+ 的内存安全特性（彻底杜绝因字符串拼接或 XML 构造引发的缓冲区溢出、空指针等 CVE 风险）、强类型系统（确保 JID 与资源标识符结构正确）、轻量级异步模型（高效集成至现有连接流）以及 CJNative 高性能 FFI 能力（无缝对接底层 IQ 消息通道），本项目旨在打造一个精简、可靠、符合 RFC 6120 与 XEP-0078/0233 标准的资源绑定模块，为仓颉生态提供标准化的 XMPP 会话初始化能力，支撑多端协同、物联网设备身份标识等后端场景。

核心功能需求与技术规格

2.1 功能模块分解

2.2 非功能性需求规范

• 性能指标：单次绑定 P99 延迟 < 100ms（局域网），吞吐量 ≥5,000 绑定/秒。

• 安全要求：资源名生成使用加密安全随机数；所有 XML 构造经强类型校验，杜绝注入。

• 可靠性：绑定失败路径全覆盖；异常不导致连接崩溃，可重试或降级。

• 可维护性：模块解耦，仅依赖 iqCaller 与 streamFeatures；接口简洁，无副作用。

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

interface ResourceBinder {
    // 执行资源绑定（可选指定 resource）
    async fn bind(self, resource: Option<String>) -> Result<Jid, BindingError>;
}

// 主导出函数：集成到中间件链
fn resourceBinding(
    ctx: &StreamContext,
    iq_caller: &IqCaller,
    resource: Option<String>
) -> Result<(), BindingError>;

enum BindingError {
    StreamNotReady,
    IqTimeout,
    ResourceConflict(String),
    InvalidResponse(String),
    ServerRefused,
}

struct Jid {
    local: Option<String>,
    domain: String,
    resource: Option<String>,
}

项目交付物与实施路线图

3.1 阶段性交付物清单

• 第一阶段：核心绑定逻辑 + 单元测试（覆盖率≥95%） + 接口文档

• 第二阶段：流特征自动集成 + 与 cj-xmpp-client_core 对接测试

• 第三阶段：冲突重试策略 + 性能调优报告 + cjpm 发布包

3.2 项目实施路线图

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

4.1 仓颉语言专项质量规范

• 编码规范：100% 通过 cjfmt 格式校验；禁止动态字符串拼接构造 XML。

• 类型安全：JID 字段不可变；资源名输入经合法性校验。

• 错误处理：所有公共操作返回 Result<T, E>；错误类型枚举覆盖所有 RFC 场景。

4.2 测试与验证标准

• 单元测试：覆盖资源冲突、空响应、无效 JID 等边界情况，行覆盖率 ≥95%。

• 互操作测试：与 ejabberd、Prosody、Openfire 验证绑定流程合规性。

• 安全扫描：通过 cjpm lint --deny-unsafe 和输入验证静态分析。

4.3 文档与可维护性

• 所有 public 接口包含 Doc Comments，说明资源命名规则与错误语义。

• 记录资源生成策略、冲突处理逻辑等关键决策（ADR）。

• 提供 .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-iq（IQ 消息通道）、cj-xmpp-stream-features（流特征集成）

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

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

过程质量要求