【Maven】单元测试、统计、覆盖率相关插件使用介绍

今天药忘吃喽~ 2023-10-10 23:26 65阅读 0赞

## maven-surefire-plugin ##

*  `maven-surefire-plugin`是`maven`执行单元测试的插件，不显性配置也可以直接使用。
 *  这个插件的`surefire:test`命令会默认绑定`maven`执行的`test`阶段。
 *  执行结束后，默认在`target/surefire-reports`目录下会生成`txt`和`xml`两种格式的结果，不利于直观展示，需要结合其它插件一起使用。

> 如果你自己声明了，那么可以指定自己的版本，并且可以配置自定义的参数。

### 配置示例 ###

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <configuration>
            
            <skipTests>false</skipTests>
            
            <testFailureIgnore>true</testFailureIgnore>
            <argLine>${argLine}</argLine>
        </configuration>
    </plugin>

>  *  argLine参数说明
>  *  jacoco:report-aggregate聚合报告后，覆盖率显示为0，与这个参数有关
>  *  jacoco在prepare-agent阶段会生成一个属性指向jacoco的runtime agent，默认这个属性叫argLine
>  *  需要在maven-surefire-plugin的配置中，引用这个属性

## maven-surefire-report-plugin ##

为单元测试生成`html`报告，默认位置`target/site/surefire-report.html`

### 配置示例 ###

<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-report-plugin</artifactId>
        <version>${maven-surefire-report-plugin.version}</version>
        <executions>
            <execution>
                <id>report</id>
                <phase>test</phase>
                <goals>
                    <goal>report</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

> 执行mvn test时，会生成报告

### 效果预览 ###

![在这里插入图片描述][c8014639ea5649cc9f0046c3ece5162e.png]

## jacoco-maven-plugin ##

用于生成代码覆盖率报告，可以帮助我们了解代码中哪些部分已经被测试覆盖，哪些部分需要更多的测试，默认位置`target/site/jacoco/index.html`

### 配置示例 ###

<plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <executions>
            <execution>
                <goals>
                    <goal>prepare-agent</goal>
                </goals>
                <configuration>
                    
                    <propertyName>argLine</propertyName>
                </configuration>
            </execution>
            <execution>
                <id>report</id>
                <phase>test</phase>
                <goals>
                    <goal>report</goal>
                </goals>
            </execution>
        </executions>
        <configuration>
            
            <append>false</append>
            
            <rules>
                <rule implementation="org.jacoco.maven.RuleConfiguration">
                    <element>BUNDLE</element>
                    <limits>
                        
                        <limit implementation="org.jacoco.report.check.Limit">
                            <counter>METHOD</counter>
                            <value>COVEREDRATIO</value>
                            <minimum>0.80</minimum>
                        </limit>
                        
                        <limit implementation="org.jacoco.report.check.Limit">
                            <counter>INSTRUCTION</counter>
                            <value>COVEREDRATIO</value>
                            <minimum>0.80</minimum>
                        </limit>
                        
                        <limit implementation="org.jacoco.report.check.Limit">
                            <counter>LINE</counter>
                            <value>COVEREDRATIO</value>
                            <minimum>0.80</minimum>
                        </limit>
                        
                        <limit implementation="org.jacoco.report.check.Limit">
                            <counter>CLASS</counter>
                            <value>MISSEDCOUNT</value>
                            <maximum>0</maximum>
                        </limit>
                    </limits>
                </rule>
            </rules>
        </configuration>
    </plugin>

### 效果展示 ###

![在这里插入图片描述][1898f96845bc4055a1d857ebe1231a26.png]

> 如果覆盖率显示为0，需要修改maven-surefire-plugin插件的配置

![在这里插入图片描述][d2361ba8a39b4d218c77645857491a3c.png]

[c8014639ea5649cc9f0046c3ece5162e.png]: https://img-blog.csdnimg.cn/c8014639ea5649cc9f0046c3ece5162e.png
[1898f96845bc4055a1d857ebe1231a26.png]: https://img-blog.csdnimg.cn/1898f96845bc4055a1d857ebe1231a26.png
[d2361ba8a39b4d218c77645857491a3c.png]: https://img-blog.csdnimg.cn/d2361ba8a39b4d218c77645857491a3c.png