java插桩-Jacoco java代码覆盖率可视化_jacoco 插桩

│   ├── examples
│   ├── faq.html
│   ├── flow.html
│   ├── help-mojo.html
│   ├── implementation.html
│   ├── index.html
│   ├── instrument-mojo.html
│   ├── integrations.html
│   ├── license.html
│   ├── maven.html
│   ├── merge-mojo.html
│   ├── mission.html
│   ├── offline.html
│   ├── prepare-agent-integration-mojo.html
│   ├── prepare-agent-mojo.html
│   ├── repo.html
│   ├── report-aggregate-mojo.html
│   ├── report-integration-mojo.html
│   ├── report-mojo.html
│   ├── resources
│   ├── restore-instrumented-classes-mojo.html
│   ├── support.html
│   └── team.html
├── index.html
├── lib
│   ├── jacocoagent.jar
│   ├── jacocoant.jar
│   ├── jacococli.jar
│   ├── org.jacoco.agent-0.8.5.201910111838.jar
│   ├── org.jacoco.ant-0.8.5.201910111838.jar
│   ├── org.jacoco.core-0.8.5.201910111838.jar
│   └── org.jacoco.report-0.8.5.201910111838.jar
└── test
    ├── index.html
    └── TESTS-TestSuites.xml

• coverage 覆盖率
• doc 文档
• lib 库，一些jar包  本文使用了jacocoagent.jar和jacococli.jar
• test 测试
• index.html 主页

使用

javaagent

何时转储

• 文件系统：在JVM终止时，执行数据被写入本地文件。
• TCP套接字服务器：外部工具可以连接到VM，并通过套接字连接检索执行数据。可以在JVM退出时进行可选的执行数据重置和执行数据转储。
• TCP套接字客户端：启动时，JaCoCo代理连接到给定的TCP端点。执行数据根据请求写入套接字连接。可以在VM退出时进行可选的执行数据重置和执行数据转储。

设置代理

-javaagent:[yourpath/]jacocoagent.jar=[option1]=[value1],[option2]=[value2]

参数

| 选项 | 默认值 | 说明 |
| destfile | jacoco.exec | 执行数据输出文件的路径。 |
| output | file | 用于写入coverage数据的输出方法。有效选项包括：

• file:注意，在VM终止时，执行数据将写入destfile属性中指定的文件中。
• tcpserver：代理在address和``port属性指定的TCP端口上侦听传入连接。执行数据将写入此TCP连接。
• tcpclient：在启动时，代理连接到address和port 属性指定的TCP端口。执行数据将写入此TCP连接。
• none：不产生任何输出。

请参阅下面的安全注意事项。 |
| address | 回送接口 | IP地址或主机名，结合output为 tcpserver或tcpclient。在tcpserver模式下，值“ *”使代理接受任何本地地址上的连接。 |
| port | 6300 | 当output参数为tcpserver或tcpclient时绑定到的端口。在 tcpserver模式下，端口必须可用，这意味着如果多个JaCoCo代理在同一台机器上运行，则必须指定不同的端口。 |
| append | true | 如果设置为true，并且执行数据文件已经存在，那么coverage数据将附加到现有文件中。如果设置为 false，将替换现有的执行数据文件。 |
| includes | * (所有类) | 执行分析中应包括的类名列表。列表条目用冒号（:）分隔，并且可以使用通配符（*和?）。除性能优化或技术特殊情况外，通常不需要此选项。 |
| excludes | empty（无排除类） | 应该从执行分析中排除的类名称的列表。列表条目用冒号（:）分隔，并且可以使用通配符（*和?）。除性能优化或技术特殊情况外，通常不需要此选项。如果要从报告中排除类别，请相应地配置相应的报告生成工具。 |
| exclclassloader | sun.reflect.DelegatingClassLoader | 应该从执行分析中排除的类加载器名称的列表。列表条目用冒号（:）分隔，并且可以使用通配符（*和 ?）。在与JaCoCo代码规范冲突的特殊框架的情况下，尤其是无法访问Java运行时类的类加载器时，可能需要此选项。 |
| inclbootstrapclasses | false | 指定是否还应该检测引导类加载器中的类。谨慎使用此功能，它需要大量的包含/排除调整。 |
| inclnolocationclasses | false | 指定是否还应检测没有源位置的类。通常，此类在运行时（例如，通过模拟框架）生成，因此默认情况下将其排除在外。 |
| sessionid | 自动产生 | 与执行数据一起写入的会话标识符。没有此参数，代理将创建一个随机标识符。 |
| dumponexit | true | 如果设置为true,覆盖率数据将在VM关闭时写入。仅当file指定了其中一个或输出为tcpserver/ tcpclient 并且在VM终止时打开了连接时，才能写入转储。 |
| classdumpdir | 没有转储 | 相对于工作目录的位置，代理看到的所有类文件都将转储到该目录。这对于调试目的或在动态创建类的情况下（例如在使用脚本引擎时）很有用。 |
| jmx | false | 如果设置为true，该代理由于功能原因通过JMX下的公开属性org.jacoco:type=Runtime暴露出来。请查看下面的安全注意事项。 |

安全注意事项：在tcpserver和 tcpclient模式下打开的端口和连接以及JMX接口不提供任何身份验证机制。如果在生产系统上运行JaCoCo，请确保没有不受信任的源可以访问TCP服务器端口，或者JaCoCo TCP客户端仅连接到受信任的目标。否则，可能会泄露应用程序的内部信息，或者可能发生DOS攻击。

jacococli

dump命令

格式

java -jar jacococli.jar dump [--address <address>] --destfile <path> [--help] [--port <port>] [--quiet] [--reset] [--retry <count>]

向以“ tcpserver”输出模式运行的JaCoCo代理请求执行数据。

参数
| 选项 | 描述 |
| --address

| 主机名或ip，默认本机 |
| <execfiles> | 要读取的JaCoCo * .exec文件列表 |
| --classfiles <path> | Java类文件的位置（必填项） |
| --csv <file> | CSV报告的输出文件（处理数据方便） |
| --html <dir> | HTML报告的输出目录（可视化） |
| --encoding <charset> | 源文件编码（默认情况下使用平台编码） |
| --help | 显示帮助 |
| --name <name> | 此报告使用的名称 |
| --quiet | 抑制stdout上的所有输出 |
| --sourcefiles <path> | 源文件的位置 |
| --tabwith <n> | 源页面的制表位停止宽度（默认为4） |
| --reset | dump后重置测试目标上的执行数据 |
| --retry <count> | 重试次数（默认10） |

instrument命令

格式

java -jar jacococli.jar instrument [<sourcefiles> ...] --dest <dir> [--help] [--quiet]

Java类文件和JAR文件的离线检测。

参数
| 选项 | 描述 |
| <sourcefiles> | 要回避检测的文件夹或文件列表 |
| --dest <dir> | 将检测的Java类写入的路径 |
| --help | 显示帮助 |
| --quiet | 抑制stdout上的所有输出 |

merge命令

格式

java -jar jacococli.jar merge [<execfiles> ...] --destfile <path> [--help] [--quiet]

将多个exec文件合并到一个新的文件中。

参数
| 选项 | 描述 |
| <execfiles> | 要读取的JaCoCo * .exec文件列表 |
| --destfile <path> | 将合并的执行数据写入的文件 |
| --help | 显示帮助 |
| --quiet | 抑制stdout上的所有输出 |

report命令

格式

java -jar jacococli.jar report [<execfiles>...] --classfiles <path> [--csv <file>] [--encoding <charset>] [--help] [--html <dir>] [--name <name>] [--quiet] [--sourcefiles <path>] [--tabwith <n>] [--xml <file>]

通过读取exec和Java类文件生成不同格式的报告。

参数
| 选项 | 描述 |
| <execfiles> | 要读取的JaCoCo * .exec文件列表 |
| --classfiles <path> | Java类文件的位置（必填项） |
| --csv <file> | CSV报告的输出文件（处理数据方便） |
| --html <dir> | HTML报告的输出目录（可视化） |
| --xml <file> | XML报告的输出文件 |
| --encoding <charset> | 源文件编码（默认情况下使用平台编码） |
| --help | 显示帮助 |
| --name <name> | 此报告使用的名称 |
| --quiet | 抑制stdout上的所有输出 |
| --sourcefiles <path> | 源文件的位置 |
| --tabwith <n> | 源页面的制表位停止宽度（默认为4） |

一般情况下填写–classfiles参数，–csv、–html、–xml中选一个，具体情况看读者要求。

classinfo命令

格式

java -jar jacococli.jar classinfo [<classlocations>...] [--help] [--quiet] [--verbose]

在提供的位置打印有关Java类文件的信息。

参数
| 选项 | 描述 |
| <classlocations> | Java类文件的位置 |
| --help | 显示帮助 |
| --quiet | 抑制stdout上的所有输出 |
| --verbose | 显示方法和行号详细信息 |

execinfo命令

格式

java -jar jacococli.jar execinfo [<execfiles>...] [--help] [--quiet]

以人类可读的格式打印exec文件内容。

version命令

格式

java -jar jacococli.jar version [--help] [--quiet]

打印JaCoCo版本信息。

参数
| 选项 | 描述 |
| --help | 显示帮助 |
| --quiet | 抑制stdout上的所有输出 |

使用举例（OpenDaylight）

javaagent

java代理jar包路径: /home/llvm/apps/jacoco/lib/jacocoagent.jar

待插桩jar包路径:/usr/lib/opendaylight/karaf-0.7.3/system/org/opendaylight/openflowplugin/openflowjava/openflow-protocol-api/0.5.3/openflow-protocol-api-0.5.3.jar

1.启动时带上Javacoco的agent

sudo vim /usr/lib/opendaylight/karaf-0.7.3/bin/karaf

JAVA_OPTS="$JAVA_OPTS -javaagent:/home/llvm/apps/jacoco/lib/jacocoagent.jar=destfile=jacoco.exec,output=tcpserver"

添加JAVA_OPTS

javacli

version命令

classinfo命令

显示类名等信息

使用一下你要测试的jar包。

dump命令

获取执行情况数据，在jacococli.jar所在目录（与jacocoagent.jar目录一致）执行命令：

java -jar jacococli.jar dump  --port 6300 --destfile data/jacoco-it.exec

生成.exec文件

生成.exec文件

execinfo命令

java -jar jacococli.jar execinfo data/jacoco-it.exec

.exec中包含了包名等信息

report命令

执行如下命令生成html报告。–classfiles指定应用程序的class文件所在目录，–html指定html报告所在目录。

java -jar jacococli.jar report data/jacoco-it.exec --classfiles /usr/lib/opendaylight/karaf-0.7.3/system/org/opendaylight/openflowplugin/openflowjava/openflow-protocol-api/0.5.3/ --html html

生成html

目录

点击html目录中的index.html查看代码覆盖率

包的覆盖率

类、方法、分支等覆盖率

一、网安学习成长路线图

网安所有方向的技术点做的整理，形成各个领域的知识点汇总，它的用处就在于，你可以按照上面的知识点去找对应的学习资源，保证自己学得较为全面。

二、网安视频合集

观看零基础学习视频，看视频学习是最快捷也是最有效果的方式，跟着视频中老师的思路，从基础到深入，还是很容易入门的。

三、精品网安学习书籍

当我学到一定基础，有自己的理解能力的时候，会去阅读一些前辈整理的书籍或者手写的笔记资料，这些笔记详细记载了他们对一些技术点的理解，这些理解是比较独到，可以学到不一样的思路。

四、网络安全源码合集+工具包

光学理论是没用的，要学会跟着一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。

五、网络安全面试题

最后就是大家最关心的网络安全面试题板块