Jacoco的XML报告详解

使用jacococli完成jacoco测试报告生成后，会看到有一个.xml结尾的文件，这个就是xml格式的覆盖率报告。除了xml还有csv、html格式的报告，本文进介绍xml报告。

DTD文件

在介绍jacoco的xml报告之前，我们应该先看一下对应的DTD文件的内容。(DTD的全称为Document Type Definition，是一种文件定义格式，它规定了XML文件结构为XML文件提供了语法与规则.)如下实在官网下载（https://www.jacoco.org/jacoco/trunk/coverage/report.dtd）的DTD文件内容，我删除了一些版本上的注释。

<!-- 报告的根节点-->
<!ELEMENT report (sessioninfo*, (group* | package*), counter*)>
  <!ATTLIST report name CDATA #REQUIRED>

<!-- 一些关于session执行过程的信息 -->
<!ELEMENT sessioninfo EMPTY>
  <!-- session id -->
  <!ATTLIST sessioninfo id CDATA #REQUIRED>
  <!-- 开始时间戳 -->
  <!ATTLIST sessioninfo start CDATA #REQUIRED>
  <!-- dump 时间戳 -->
  <!ATTLIST sessioninfo dump CDATA #REQUIRED>

<!-- 一个group信息-->
<!ELEMENT group ((group* | package*), counter*)>
  <!-- group 名字 -->
  <!ATTLIST group name CDATA #REQUIRED>

<!-- 一个package信息-->
<!ELEMENT package ((class | sourcefile)*, counter*)>
  <!-- package name in VM notation -->
  <!ATTLIST package name CDATA #REQUIRED>

<!-- 一个class的信息 -->
<!ELEMENT class (method*, counter*)>
  <!-- fully qualified VM name -->
  <!ATTLIST class name CDATA #REQUIRED>
  <!-- 类对应的 source file -->
  <!ATTLIST class sourcefilename CDATA #IMPLIED>

<!-- 一个method的信息-->
<!ELEMENT method (counter*)>
  <!-- method明 -->
  <!ATTLIST method name CDATA #REQUIRED>
  <!-- method  描述 -->
  <!ATTLIST method desc CDATA #REQUIRED>
  <!-- method第一行行号 -->
  <!ATTLIST method line CDATA #IMPLIED>

<!-- 一个源代码文件-->
<!ELEMENT sourcefile (line*, counter*)>
  <!-- 本地文件名 -->
  <!ATTLIST sourcefile name CDATA #REQUIRED>

<!-- 一个源代码行-->
<!ELEMENT line EMPTY>
  <!--  行号 -->
  <!ATTLIST line nr CDATA #REQUIRED>
  <!-- 未覆盖的instruction的数量 -->
  <!ATTLIST line mi CDATA #IMPLIED>
  <!-- 覆盖的instruction的数量 -->
  <!ATTLIST line ci CDATA #IMPLIED>
  <!-- 未覆盖的分支的数量 -->
  <!ATTLIST line mb CDATA #IMPLIED>
  <!-- 覆盖的分支的数量  -->
  <!ATTLIST line cb CDATA #IMPLIED>

<!-- 不同的计数器-->
<!ELEMENT counter EMPTY>
  <!-- metric type -->
  <!ATTLIST counter type (INSTRUCTION|BRANCH|LINE|COMPLEXITY|METHOD|CLASS) #REQUIRED>
  <!-- number of missed items -->
  <!ATTLIST counter missed CDATA #REQUIRED>
  <!-- number of covered items -->
  <!ATTLIST counter covered CDATA #REQUIRED>

counter 计数器

在解读jacoco的xml报告的时候，counter是重要的部分。

<counter type="INSTRUCTION" missed="18" covered="138"/>
<counter type="BRANCH" missed="4" covered="10"/>
<counter type="LINE" missed="5" covered="43"/>
<counter type="COMPLEXITY" missed="3" covered="8"/>
<counter type="METHOD" missed="0" covered="4"/>
<counter type="CLASS" missed="0" covered="1"/>

• INSTRUCTION：指令
• BRANCH：分支
• LINE：行
• COMPLEXITY：复杂度
• METHOD：方法
• CLASS：类

missed代表是未覆盖数量，covered代表覆盖数量。

package

 <package name="com/cicc/ut/util">
        <class name="com/cicc/ut/util/PasswordUtil" sourcefilename="PasswordUtil.java">
            <method name="md5" desc="(Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String;" line="13">
                <counter type="INSTRUCTION" missed="0" covered="24"/>
                <counter type="LINE" missed="0" covered="2"/>
                <counter type="COMPLEXITY" missed="0" covered="1"/>
                <counter type="METHOD" missed="0" covered="1"/>
            </method>
            <counter type="INSTRUCTION" missed="0" covered="24"/>
            <counter type="LINE" missed="0" covered="2"/>
            <counter type="COMPLEXITY" missed="0" covered="1"/>
            <counter type="METHOD" missed="0" covered="1"/>
            <counter type="CLASS" missed="0" covered="1"/>
        </class>
        <sourcefile name="PasswordUtil.java">
            <line nr="13" mi="0" ci="12" mb="0" cb="0"/>
            <line nr="14" mi="0" ci="12" mb="0" cb="0"/>
            <counter type="INSTRUCTION" missed="0" covered="24"/>
            <counter type="LINE" missed="0" covered="2"/>
            <counter type="COMPLEXITY" missed="0" covered="1"/>
            <counter type="METHOD" missed="0" covered="1"/>
            <counter type="CLASS" missed="0" covered="1"/>
        </sourcefile>
        <counter type="INSTRUCTION" missed="0" covered="24"/>
        <counter type="LINE" missed="0" covered="2"/>
        <counter type="COMPLEXITY" missed="0" covered="1"/>
        <counter type="METHOD" missed="0" covered="1"/>
        <counter type="CLASS" missed="0" covered="1"/>
    </package>

package包含了很多内容，其中counter和前面介绍的是一致的。除去counter以外还有class和sourcefile两部分。class下包含了method的信息，每个method的counter信息也会记录，class下还有对应class的一些覆盖的统计信息。sourcefile是在源文件的角度进行的一些counter信息的记录，除此之外还有line的信息：

• nr: 表示行号（Number），即源代码中的行数。
• mi: 表示未执行的指令数（Missed Instructions）。这个属性通常用于调试信息，指示该行代码中未被执行的指令数量。
• ci: 表示已执行的指令数（Covered Instructions）。同样，这个属性用于调试信息，指示该行代码中被执行的指令数量。
• mb: 表示未执行的分支数（Missed Branches）。这个属性表示在该行代码中，有多少个分支（如if-else语句中的条件分支）没有被执行。
• cb: 表示已执行的分支数（Covered Branches）。这个属性表示在该行代码中，有多少个分支被执行。\
  如上例子中<line nr="13" mi="0" ci="12" mb="0" cb="0"/>,表达的含义就是这个源代码文件第13行没有未覆盖指令，覆盖了12个指令，没有未覆盖的分支也没有覆盖的分支（这说明就没有分支处理）。