Merged
refactor(java-sdk): 对齐公开 API 并完善文档与示例 #386
machuanAdd on 16 days ago
refactor(java-sdk): 对齐公开 API 并完善文档与示例 #386
Merged
Pull Request has been successfully merged by openJiuwen-bot.
(Thank you for machuan's contribution.)atomgit-bot
16 days ago Comments:
16 days ago Comments:
变更摘要
本 PR 主要围绕 Java SDK 的公开 API 对齐与文档完善展开:将 A4pIntentCodec 由接口收敛为可直接实例化的具体类并删除内部实现 CanonicalIntentCodec,收紧部分工具类的可见性,为 A4p、Models、A4pResult、Validation、Accounting 等公开类型补齐 Javadoc,同时通过 Maven 插件与构建脚本新增文档产出能力,并把示例与一致性校验工具从主代码中拆分为独立的 examples 模块。
主要改动
- 编解码器 API 收敛:
A4pIntentCodec从interface改为具体class,移除static standard()工厂方法,原CanonicalIntentCodec.INSTANCE的实现与内部ContextJson、RecordJson记录整体并入,调用方改为new A4pIntentCodec()。 - 公开面与可见性调整:
CanonicalJson由public final class改为包级私有的final class,A4pResult.ok/failure降为包级私有,同时新增公开构造器A4pResult(boolean, T, long, String)并对 status、payload、code 一致性做校验。 - API 文档与文档构建:为生命周期方法、错误码、模型记录、校验与计账逻辑大量补充 Javadoc(含
@param/@return/@throws),pom.xml新增maven-javadoc-plugin(doclint all,-missing、failOnError true、attach-javadocs绑定到package),scripts/build.sh增加docs模式生成英文 HTML 文档。 - 示例拆分与去内部依赖:新增
examples/pom.xml形成独立示例模块,Rsa3072迁至io.openjiuwen.a4p.examples并移除对Validation、CanonicalJson的依赖,改为自实现 Base64URL 规范解码与参数校验,PaymentExample改用实例化 codec 并做序列化往返校验,另新增Rsa3072Test。 - 新增 codec 一致性校验:新增
CodecConformanceCheck命令行工具与配套CodecConformanceCheckTest,用既有 L1/L2/L3 与 Context 向量比对自定义A4pIntentCodec实现与标准实现的行为是否一致。


Incorrect?
atomgit-bot
16 days ago Comments:
16 days ago Comments:
16 days ago Set YiyangShao,xinyu-jiuwen as approver
atomgit-bot
16 days ago Comments:
16 days ago Comments:
16 days ago Added label: sig/sig-agent-protocol
60 messages are collapsed here。 See more
14 days ago Added label: approvedlgtm-mingo007
openJiuwen-bot
14 days ago Comments:
14 days ago Comments:
14 days ago Merged pull request
14 days ago Removed label: ci-successful
13 days ago Associated issue: [Feature]: A4P 协议提供 java 版本 SDK
Paired: GitHub #190 ↔ GitCode !386
What type of PR is this?
/kind refactor
Self-checklist:(请自检,在[ ]内打上x,我们将检视你的完成情况,否则会导致pr无法合入)