※背景
在使用sonarqube做静态代码扫描的时候,经常会有些不符合其规则的代码,当然有些代码无法避免,可不予采纳修改,
但是有些比较复杂且还有完善空间的逻辑代码值得修改,但是开发周期又略显紧凑,那么我就知道一边代码走查<因为没人配合做code view>,
那么我想去证实那段代码,就需要自己写单元测试用例,然后覆盖其分支的单元测试。真实发现了,在手工测试的时候,真的无法去覆盖所有的测试场景,
也就是说逻辑代码无法全部覆盖测试<发现好难>。
※方案
尽管无法覆盖,但是也不能不做<总得找点事做>,于是clone代码到本地开始单元测试<没有什么设计方案,就是先简单的数据覆盖--某些分支>,
但是这样有些不直观,无法知道自己的单元测试到底测试到了哪些代码。所以要引入检测是代码覆盖率的工具:jacoco,之前也有在eclipse工具集成并使用过。
※行动
  • 1、先来第一步:pom配置<本次采用的是IntelliJ IDEA工具>
<dependency>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.4</version>
</dependency>

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.4</version>
    <configuration>
        <destFile>target/coverage-reports/jacoco-unit.exec</destFile>
        <dataFile>target/coverage-reports/jacoco-unit.exec</dataFile>
        <includes>
            <include>**/service/**</include>
            <include>**/controller/**</include>
            <!--<include>**/service/impl/*.class</include>-->
        </includes>
        <!-- rules里面指定覆盖规则 -->
        <rules>
            <rule implementation="org.jacoco.maven.RuleConfiguration">
                <element>BUNDLE</element>
                <limits>  
                    <!-- 指定方法覆盖到50% -->
                    <limit implementation="org.jacoco.report.check.Limit">
                        <counter>METHOD</counter>
                        <value>COVEREDRATIO</value>
                        <minimum>0.50</minimum>
                    </limit>
                    <!-- 指定分支覆盖到50% -->
                    <limit implementation="org.jacoco.report.check.Limit">
                        <counter>BRANCH</counter>
                        <value>COVEREDRATIO</value>
                        <minimum>0.50</minimum>
                    </limit>
                    <!-- 指定类覆盖到100%,不能遗失任何类 -->
                    <limit implementation="org.jacoco.report.check.Limit">
                        <counter>CLASS</counter>
                        <value>MISSEDCOUNT</value>
                        <maximum>0</maximum>
                    </limit>
                </limits>
            </rule>
        </rules>
    </configuration>
    <executions>
        <execution>
            <id>jacoco-initialize</id>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
        <!--这个check:对代码进行检测,控制项目构建成功还是失败-->
        <execution>
            <id>check</id>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
        <!--这个report:对代码进行检测,然后生成index.html在 target/site/index.html中可以查看检测的详细结果-->
        <execution>
            <id>jacoco-site</id>
            <phase>package</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
    </executions>
</plugin>
  • 2、配置IDEA工具
    image.png
  • 3、点击设置按钮
    image.png
  • 4、选择TestNG框架<个人习惯,知道公司基本大多数后台开发还喜欢使用Junit>
    image.png- 5、按照上面的配置,开始执行测试用例,记住,要选择coverage
    image.png
  • 6、温馨提示:创建测试用例的package包名要跟src/main/java下测试的代码同名,否则会找不到
    image.png- 7、点击第六点,可以到处生成代码覆盖率HTML测试报告,自己可以自定义输出路径,效果如下:
    image.png
※总结:需要了解jacoco的原理、及使用它的目的

原理:简单说使用asm动态修改字节码,在代码中进行打桩,从而进行统计; 目的:很简单了,就是检测我们代码逻辑覆盖、提高代码质量。

更多推荐