Java API Compliance Checker 使用教程

Java API Compliance Checker 使用教程

japi-compliance-checkerA tool for checking backward API/ABI compatibility of a Java library项目地址:https://gitcode.com/gh_mirrors/ja/japi-compliance-checker

项目的目录结构及介绍

Java API Compliance Checker（JAPICC）是一个用于检查Java库的向后API/ABI兼容性的工具。以下是该项目的目录结构及其介绍：

japi-compliance-checker/
├── bin/
│   └── japi-compliance-checker  # 可执行文件
├── lib/
│   └── ...  # 依赖库
├── doc/
│   └── ...  # 文档文件
├── examples/
│   └── ...  # 示例文件
├── Makefile  # 安装文件
├── README.md  # 项目说明
└── ...  # 其他辅助文件

• bin/：包含可执行文件 japi-compliance-checker。
• lib/：包含项目依赖的库文件。
• doc/：包含项目的文档文件。
• examples/：包含示例文件，展示如何使用该工具。
• Makefile：用于安装项目的Makefile文件。
• README.md：项目的说明文档。

项目的启动文件介绍

项目的启动文件是 bin/japi-compliance-checker。这是一个可执行脚本，用于启动兼容性检查工具。用户可以通过命令行运行该脚本来比较两个Java库版本的兼容性。

项目的配置文件介绍

Java API Compliance Checker 主要通过命令行参数进行配置。以下是一些常用的配置参数：

• -lib NAME：指定库的名称。
• -old V1.jar：指定旧版本的JAR文件。
• -new V2.jar：指定新版本的JAR文件。
• -old V1.xml：指定旧版本的XML描述文件。
• -new V2.xml：指定新版本的XML描述文件。

示例命令：

japi-compliance-checker -lib MyLibrary -old v1.0.jar -new v2.0.jar

或者使用XML描述文件：

japi-compliance-checker -lib MyLibrary -old v1.0.xml -new v2.0.xml

XML描述文件示例：

<version>1.0</version>
<archives>/path1/to/JAR(s)/ /path2/to/JAR(s)/</archives>

通过这些配置参数，用户可以灵活地指定需要比较的库版本及其路径。

japi-compliance-checkerA tool for checking backward API/ABI compatibility of a Java library项目地址:https://gitcode.com/gh_mirrors/ja/japi-compliance-checker