概述
JaCoCo 提供了一个命令行界面,允许用户在命令行中执行基本操作。命令行工具及其所有依赖项打包在 jacococli.jar
中,并随 JaCoCo 下载提供。执行这些工具需要 Java 1.5 或更高版本。
注意事项
- 虽然提供了
instrument
命令,但 JaCoCo 进行代码覆盖分析的首选方式是使用 JaCoCo Agent 进行即时插桩。离线插桩有多个缺点,仅在特定场景明确需要时才应使用。在使用此模式之前,请查阅有关离线插桩的文档。
可用命令
dump
请求在 'tcpserver' 输出模式下运行的 JaCoCo Agent 的执行数据。
shell
java -jar jacococli.jar dump [--address <address>] --destfile <path> [--port <port>] [--quiet] [--reset] [--retry <count>]
- 选项包括地址、目标文件、帮助、端口、静默模式、重置执行数据、重试次数等。
instrument
对 Java 类文件和 JAR 文件进行离线插桩。
shell
java -jar jacococli.jar instrument [<sourcefiles> ...] --dest <dir> [--quiet]
- 选项包括源文件列表、目标目录、帮助、静默模式等。
merge
合并多个 exec 文件到一个新的文件中。
shell
java -jar jacococli.jar merge [<execfiles> ...] --destfile <path> [--quiet]
- 选项包括执行文件列表、目标文件、帮助、静默模式等。
report
通过读取 exec 和 Java 类文件生成不同格式的报告。
shell
java -jar jacococli.jar report [<execfiles> ...] --classfiles <path> [--csv <file>] [--encoding <charset>] [--html <dir>] [--name <name>] [--sourcefiles <path>] [--tabwith <n>] [--xml <file>]
- 选项包括执行文件列表、类文件位置、CSV 输出文件、编码、HTML 输出目录、报告名称、源文件位置、制表位宽度、XML 输出文件等。
classinfo
打印提供位置的 Java 类文件的信息。
shell
java -jar jacococli.jar classinfo [<classlocations> ...] [--verbose]
- 选项包括类文件位置、帮助、静默模式、详细模式等。
execinfo
以人类可读的格式打印 exec 文件内容。
shell
java -jar jacococli.jar execinfo [<execfiles> ...] [--quiet]
- 选项包括执行文件列表、帮助、静默模式等。
version
打印 JaCoCo 版本信息。
shell
java -jar jacococli.jar version [--quiet]
- 选项包括帮助、静默模式等。
参数说明
- ◼ 表示必须参数。
- 表示可以多次指定的参数。
总结
JaCoCo CLI 提供了一套丰富的命令,用于代码覆盖率的生成、合并、报告等。用户可以根据自己的需求选择合适的命令和参数来执行特定的任务。虽然提供了离线插桩的命令,但推荐使用即时插桩以获得更好的效果和避免潜在的问题。