japicmp 使用教程

japicmp 使用教程

japicmpComparison of two versions of a jar archive项目地址:https://gitcode.com/gh_mirrors/ja/japicmp

japicmp 是一个用于比较两个Java JAR版本之间差异的工具，它可以帮助开发者检查API的向后兼容性。以下是该项目的基本使用教程。

1. 目录结构及介绍

由于没有提供直接的项目克隆，这里假设你已经通过 git clone https://github.com/siom79/japicmp.git 拷贝了项目源码。典型的Java项目目录结构可能如下：

.
├── pom.xml            # 主项目的Maven配置文件
└── src
    └── main
        ├── java       # Java源代码
        │   └── ...     # 包含主程序类和其他类
        └── resources  # 配置资源文件
            └── ...     # 可能包含日志配置等

• pom.xml: Maven项目的配置文件，定义依赖和构建过程。
• src/main/java: 存放Java源代码的地方。
• src/main/resources: 项目的资源配置文件。

2. 项目启动文件介绍

japicmp通常作为库或者Maven插件使用，所以并没有传统的可执行JAR或命令行启动脚本。你可以通过以下两种方式运行：

CLI 工具

• 编译项目并找到包含依赖的jar包（例如 target/japicmp-x.x.x-jar-with-dependencies.jar）。
• 在终端中使用命令：java -jar japicmp-x.x.x-jar-with-dependencies.jar -n 新版本.jar -o 老版本.jar

Maven 插件

• 将插件添加到你的Maven项目pom.xml中。
• 运行mvn verify，插件将在验证阶段自动执行API比较。

3. 项目配置文件介绍

对于japicmp来说，主要的配置是通过Maven的插件配置来完成的。在pom.xml中，你需要设置<configuration>标签下的参数以定制比较行为，例如：

<plugin>
  <groupId>com.github.siom79.japicmp</groupId>
  <artifactId>japicmp-maven-plugin</artifactId>
  <version>0.x.x</version>
  <configuration>
    <!-- 配置旧版JAR -->
    <oldVersion>
      ...
    </oldVersion>
    <!-- 配置新版JAR -->
    <newVersion>
      ...
    </newVersion>
    <!-- 其他参数，如是否仅显示二进制不兼容修改 -->
    <onlyBinaryIncompatibleModifications>true</onlyBinaryIncompatibleModifications>
    <!-- 更多配置参见官方文档 -->
  </configuration>
  <executions>
    ...
  </executions>
</plugin>

• <oldVersion> 和 <newVersion> 用来指定要比较的两个不同版本的JAR文件路径或Maven依赖。
• <onlyBinaryIncompatibleModifications> 等其他参数控制报告的详细程度，可以根据具体需求进行调整。

请参考japicmp 官方文档获取更详细的配置选项和使用说明。

japicmpComparison of two versions of a jar archive项目地址:https://gitcode.com/gh_mirrors/ja/japicmp