如何更好的做单元测试并用它来提升代码质量(下)

简介: ## 现代化的spring-test使用方式 > 以下例子可以在`javaconfig-spring-test`中找到。        在`classic-spring-test`中演示的单元测试,还是用配置文件的方式,但是从Spring4之后,官方就鼓励使用Java的方式对spring进行配置,而不是用以前那

现代化的spring-test使用方式

以下例子可以在javaconfig-spring-test中找到。

       在classic-spring-test中演示的单元测试,还是用配置文件的方式,但是从Spring4之后,官方就鼓励使用Java的方式对spring进行配置,而不是用以前那样的xml配置形式了,因此我们基于注解可以来简化单元测试的编写,我们称之为现代化的spring-test方式。

修改单元测试

       测试不用继承AbstractJUnit4SpringContextTests,通过注解即可,然后对于bean的配置,可以通过Java配置风格完成

注解

       使用RunWithContextConfiguration配置即可将一个类声明为支持Spring容器的测试用例。

@RunWith(SpringRunner.class)
@ContextConfiguration(classes = MemberJavaConfigTest.MemberServiceConfig.class)
public class MemberJavaConfigTest {
}
注解 说明
RunWith 该注解是junit提供的,表示用那种方式来执行这个测试,这里是SpringRunner,由spring-test提供
ContextConfiguration 对测试的Spring容器的配置,比如:配置的位置等

配置与示例

       通过注解可以声明按照何种方式去执行测试,以及测试的Spring容器如何组装,但是还或缺在Spring容器中如何配置Bean,以前这是通过xml来进行配置的。

@RunWith(SpringRunner.class)
@ContextConfiguration(classes = MemberJavaConfigTest.MemberServiceConfig.class)
public class MemberJavaConfigTest {

    @Autowired
    private MemberService memberService;

    @Test
    public void insert_member() {
        System.out.println(memberService.insertMember("windowsxp", "abc123"));
        Assert.assertNotNull(memberService.insertMember("windowsxp", "abc123"));
    }

    @Configuration
    static class MemberServiceConfig {

        @Bean
        public MemberService memberService(UserDAO userDAO) {
            MemberServiceImpl memberService =  new MemberServiceImpl();
            memberService.setUserDAO(userDAO);
            return memberService;
        }

        @Bean
        public UserDAO userDAO() {
            UserDAO mock = Mockito.mock(UserDAO.class);
            Mockito.when(mock.insertMember(Mockito.any())).thenReturn(System.currentTimeMillis());
            return mock;
        }
    }
}

       可以看到只需要有一个类,被注解了Configuration,该类就是一个配置类型,而这种Java Config Style已经是Spring官方推荐的方式了。

       Bean注解类似xml中的bean标签,这里配置了两个Bean一个MemberService的实现,另外一个是mock的UserDAO。其中对MemberService的配置需要依赖UserDAO

       剩下的测试过程就和之前classic-spring-test完全一致了,可以看到新的方式没有了恼人的xml配置,变得更加直接和高效。

SpringBoot环境下的测试方法

以下例子可以在spring-boot-test中找到。

       Spring框架实际上是依靠SpringBoot完成了续命,由它焕发了第二春,打开了一个全新的战场。在今天微服务大放异彩的环境下,针对SpringBoot的测试也会有所不同。

       SpringBoot实际是用来启动你的应用,所以它会有配置以及一系列约定大于配置的环境准备,所以需要依赖spring-boot-test支持来完成单元测试。

修改单元测试

       如果需要在单元测试启动时启动SpringBoot,需要做一下相关的配置,增加一些注解。

依赖

       增加依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-test</artifactId>
    <scope>test</scope>
</dependency>

注解

       和JavaConfig的方式非常类似,通过注解可以声明该测试是SpringBootTest,并且可以指定运行的SpringBoot容器的配置。

@SpringBootTest(classes = SpringBootMemberTest.Config.class)
@TestPropertySource(locations = "classpath:test-application.properties")
@RunWith(SpringRunner.class)
public class SpringBootMemberTest {
注解 说明
SpringBootTest 描述了该SpringBoot单元测试是根据哪个配合来启动容器
TestPropertySource 应用的配置使用哪个

配置

       通过注解可以声明按照何种方式去执行测试,以及测试的Spring容器如何组装,还或缺在Spring容器中如何配置Bean。

@SpringBootTest(classes = SpringBootMemberTest.Config.class)
@TestPropertySource(locations = "classpath:test-application.properties")
@RunWith(SpringRunner.class)
public class SpringBootMemberTest {

    @Autowired
    private Environment env;
    @MockBean
    private UserDAO userDAO;
    @Autowired
    private MemberService memberService;

    @Test
    public void environment() {
        Assert.assertEquals("Alibaba", env.getProperty("brand-owner.name"));
    }

    @Before
    public void init() {
        Mockito.when(userDAO.insertMember(Mockito.any())).thenReturn(System.currentTimeMillis());
    }

    @Test
    public void insert_member() {
        System.out.println(memberService.insertMember("windowsxp", "abc123"));
        Assert.assertNotNull(memberService.insertMember("windowsxp", "abc123"));
    }

    @Configuration
    static class Config {

        @Bean
        public MemberService memberService(UserDAO userDAO) {
            MemberServiceImpl memberService =  new MemberServiceImpl();
            memberService.setUserDAO(userDAO);
            return memberService;
        }
    }

}

       可以看到新增了一个注解MockBean,这个用来帮助我们创建一个Mock的UserDAO,而不用通过编码来进行创建,回忆之前在classic以及javaconfig中的Mock方式,都需要调用Mockito.mock(Class type)方法来创建一个Mock对象,而在SpringBootTest中就不需要了,直接在成员变量上增加MockBean的注解就可以了。

       同时可以看到在单元测试中增加了一个注入属性,Environment,它代表Spring运行的环境,可以从中获取配置,以下是test-application.application中的内容:

brand-owner.name=Alibaba
brand-owner.company=Alibaba-inc.

       在environment测试方法中,可以访问测试的配置内容,从这里可以看到SpringBootTestspring-test基础上,除了启动一个Spring容器,还准备好了一个SpringBoot运行时环境。

       但是从侧面上讲,使用SpringBootTest就依赖了运行时环境,这不是一个好的选择,所以在大多数情况下,对于代码的单元测试spring-test就可以完全应对。

单元测试覆盖率

       就像刻意的刷分数一样,单元测试覆盖率也是一个我们追求的目标,当单元测试行覆盖率超过70%的时候,整个项目的质量会很不错。持续稳定的单元测试覆盖率,会保障一个应用一直处于较稳定的状态,后续投入维护的资源会降低。

       在不少IDE中,如:IDEA,都内置了统计单元测试的工具,只需要按照package运行测试即可,在这里我们不依赖具体的IDE,而是用maven插件来做。

jacoco

       该插件对java8的语法支持较好,在pom文件中增加配置。

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.1</version>
    <executions>
        <execution>
            <id>prepare-agent</id>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
        <execution>
            <id>report</id>
            <phase>prepare-package</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
        <execution>
            <id>post-unit-test</id>
            <phase>test</phase>
            <goals>
                <goal>report</goal>
            </goals>
            <configuration>
                <dataFile>target/jacoco.exec</dataFile>
                <outputDirectory>target/jacoco-ut</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

       当运行mvn test时会生产单元测试覆盖率报告。

位置一般在项目的 target/jacoco-ut 目录下。

覆盖率

       打开目录下的index.html可以看到各个类的覆盖率情况。

<img src="https://raw.githubusercontent.com/weipeng2k/mockito-sample/master/resources/chapter6-1.png" />

缺失路径

       点击到对应的package中的类,可以查看缺失的测试路径,这样就可以指导哪些分支没有纳入单测。

<img src="https://raw.githubusercontent.com/weipeng2k/mockito-sample/master/resources/chapter6-2.png" />

测试驱动开发简介

       测试驱动开发的基本思想就是在开发功能代码之前,先编写测试代码,然后只编写使测试通过的功能代码,从而以测试来驱动整个开发过程的进行。这有助于编写简洁可用和高质量的代码,有很高的灵活性和健壮性,能快速响应变化,并加速开发过程。

测试开发驱动模式

       测试驱动开发的基本过程如下:

  • 快速新增一个测试
  • 运行所有的测试(有时候只需要运行一个或一部分),发现新增的测试不能通过
  • 做一些小小的改动,尽快地让测试程序可运行,为此可以在程序中使用一些不合情理的方法
  • 运行所有的测试,并且全部通过
  • 重构代码,以消除重复设计,优化设计结构

       简单来说,就是不可运行/可运行/重构——这正是测试驱动开发的口号。

可取之处

       测试驱动开发能够让代码上生产环境之前,能够以使用者的角度审视编写的代码:

  • 如果代码难测,那就是对问题的分析还没有到位
  • 如果大量的Mock,那就是依赖过于复杂

       除了能够通过反向刺激让我们看到代码的不足,它还能以使用者的角度去看:

  • 这个方法命名是否够妥帖
  • 别人用这个函数会误用吗
  • 这个类是不是承担了过多的职责
目录
相关文章
|
1月前
|
存储 安全 测试技术
软件测试:确保代码质量与用户满意度的关键步骤
软件测试:确保代码质量与用户满意度的关键步骤
|
16天前
|
SQL 敏捷开发 算法
深入白盒测试:静态分析与代码质量保障
【4月更文挑战第2天】 随着软件开发的复杂性日益增加,确保代码质量和功能正确性成为开发流程中不可或缺的一环。白盒测试作为一种重要的软件测试方法,允许测试者通过检查程序内部结构、设计和编码来识别缺陷和错误。本文将探讨白盒测试中的静态分析技术及其在维护代码质量和提升测试效率中的应用,同时介绍相关工具和最佳实践,为读者提供一种系统化的白盒测试方法论。
13 3
|
3月前
|
测试技术 开发者 Python
Python自动化测试与单元测试框架:提升代码质量与效率
在软件开发过程中,测试是不可或缺的环节。Python作为一门广泛应用的编程语言,拥有丰富的自动化测试和单元测试框架,例如unittest和pytest。本文将介绍Python自动化测试的重要性,并深入探讨这两个主流的单元测试框架的特点、使用方法以及优势。通过学习和应用这些框架,开发者可以提高代码质量、提升开发效率,并确保软件在不断迭代中保持稳定。
|
6月前
|
Java 测试技术 C语言
代码质量保障第2讲:单元测试 - 浅谈单元测试
代码质量保障第2讲:单元测试 - 浅谈单元测试
|
Oracle 关系型数据库 Java
白盒测试工具 - sonar的安装、配置与使用入门手册,用sonar检查代码质量实战演示
白盒测试工具 - sonar的安装、配置与使用入门手册,用sonar检查代码质量实战演示
488 0
白盒测试工具 - sonar的安装、配置与使用入门手册,用sonar检查代码质量实战演示
|
XML 移动开发 前端开发
白盒测试工具 - sonar报告常见示例分析,sonar代码质量问题分析演示
白盒测试工具 - sonar报告常见示例分析,sonar代码质量问题分析演示
409 0
白盒测试工具 - sonar报告常见示例分析,sonar代码质量问题分析演示
|
XML 敏捷开发 算法
复杂系统如何保障代码质量?让测试先行
TDD(Test Driven Development)是一种强调测试先行的开发方式,通过编写单元测试用例,有效保障存量复杂系统在开发、重构上的质量。本文通过分析现有测试方法面临的问题,分享如何使用GTest框架进行单元测试,以及在单元测试中的一些实践心得。
复杂系统如何保障代码质量?让测试先行
|
测试技术
SOFAChannel#5 线上直播报名:给研发工程师的代码质量利器 —— 自动化测试框架 SOFAActs
线上直播第 5 期《给研发工程师的代码质量利器 —— 自动化测试框架 SOFAActs》报名开启!5 月 16 日周四晚 7 点,围绕蚂蚁金服的多年测试实践的积累与沉淀,自动化测试框架 SOFAActs 核心成员青勤将为大家带来精彩分享,不要错过哦。
989 0
|
XML Java 测试技术
如何更好的做单元测试并用它来提升代码质量(上)
> 一个使用mockito和spring-test的例子 > 可以在:`https://github.com/weipeng2k/mockito-sample`找到示例。        Java单元测试框架在业界非常多,以JUnit为事实上的标准,而JUnit只是解决了单元测试的基本骨干,而对于Mock的支持却没有。
1386 0
|
关系型数据库 jenkins 测试技术
使用Jenkins+Sonarqueb进行自动化测试和代码质量检测
# 简介 ## Jenkins Jenkins是一款开源的持续集成工具,它的特点:易于安装、易于配置、可扩展(自己开发插件),并且它拥有数以百计的成熟插件,这种插件式的特点提供可做任何事情的可能。
9052 0