PDFCompare 项目使用教程

1. 项目目录结构及介绍

PDFCompare 是一个用于比较两个 PDF 文件的 Java 库。以下是项目的目录结构及其介绍：

pdfcompare/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── de/redsix/pdfcompare/
│   │   │       ├── Main.java
│   │   │       ├── PdfComparator.java
│   │   │       └── ...
│   │   └── resources/
│   │       ├── application.conf
│   │       └── ...
│   └── test/
│       └── ...
├── CHANGELOG.md
├── LICENSE
├── README.md
├── pom.xml
└── ...

目录结构说明

• src/main/java/: 包含项目的主要 Java 源代码文件。
  • de.redsix.pdfcompare: 主要的包目录，包含 Main.java 和 PdfComparator.java 等核心类。
• src/main/resources/: 包含项目的资源文件，如配置文件 application.conf。
• src/test/: 包含项目的测试代码。
• CHANGELOG.md: 项目的更新日志。
• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍和使用说明。
• pom.xml: Maven 项目的配置文件。

2. 项目启动文件介绍

PDFCompare 项目的启动文件是 Main.java，位于 src/main/java/de/redsix/pdfcompare/ 目录下。该文件提供了命令行界面和简单的交互式 UI，用于选择要比较的 PDF 文件并执行比较操作。

Main.java 功能介绍

• 命令行界面: 可以通过命令行参数指定要比较的 PDF 文件，并提供帮助选项 -h 或 --help。
• 交互式 UI: 在没有命令行参数的情况下启动时，会弹出一个简单的 UI，允许用户选择要比较的文件，并标记忽略的区域。

3. 项目的配置文件介绍

PDFCompare 项目的配置文件是 application.conf，位于 src/main/resources/ 目录下。该文件用于配置项目的各种参数，如颜色设置、DPI 设置、临时文件目录等。

application.conf 配置项说明

• DPI: 设置 PDF 页面渲染的 DPI，默认值为 300。
• expectedColor: 设置预期颜色的 HTML 样式格式，默认值为 00B400 (绿色)。
• actualColor: 设置实际颜色的 HTML 样式格式，默认值为 D20000 (红色)。
• tempDir: 设置临时文件目录，默认值为 Java 默认的临时目录。
• allowedDifferenceInPercentPerPage: 设置每页允许的像素差异百分比，默认值为 0.2%。
• failOnMissingIgnoreFile: 设置当忽略文件不存在时是否抛出异常，默认值为 false。

通过这些配置项，用户可以根据需要调整 PDFCompare 的行为和输出结果。