使用Spring Boot进行单元测试详情

目录
  • 前言
  • 使用 Spring Boot 进行测试系列文章
  • 依赖项
  • 不要在单元测试中使用Spring
  • 创建一个可测试的类实例
    • 属性注入是不好的
    • 提供一个构造函数
    • 减少模板代码
  • 使用Mockito来模拟依赖项
    • 使用普通Mockito来模拟依赖
    • 通过Mockito的@Mock注解模拟对象
  • 使用AssertJ创建可读断言
  • 结论

前言

本文给你提供在Spring Boot 应用程序中编写好的单元测试的机制,并且深入技术细节。

我们将带你学习如何以可测试的方式创建Spring Bean实例,然后讨论如何使用MockitoAssertJ,这两个包在Spring Boot中都为了测试默认引用了。

本文只讨论单元测试。至于集成测试,测试web层和测试持久层将会在接下来的系列文章中进行讨论。

使用 Spring Boot 进行测试系列文章

这个教程是一个系列:

  • 使用 Spring Boot 进行单元测试(本文)
  • 使用 Spring Boot 和 @WebMvcTest 测试SpringMVC controller层
  • 使用 Spring Boot 和 @DataJpaTest 测试JPA持久层查询
  • 通过 @SpringBootTest 进行集成测试

如果你喜欢看视频教程,可以看看Philip的课程:测试Spring Boot应用程序课程

依赖项

本文中,为了进行单元测试,我们会使用JUnit Jupiter(Junit 5)MockitoAssertJ。此外,我们会引用Lombok来减少一些模板代码:

dependencies{
  compileOnly('org.projectlombok:lombok')
  testCompile('org.springframework.boot:spring-boot-starter-test')
  testCompile 'org.junit.jupiter:junit-jupiter-engine:5.2.0'
  testCompile('org.mockito:mockito-junit-jupiter:2.23.0')
}

MockitoAssertJ会在spring-boot-test依赖中自动引用,但是我们需要自己引用Lombok

不要在单元测试中使用Spring

如果你以前使用Spring或者Spring Boot写过单元测试,你可能会说我们不要在写单元测试的时候用Spring。但是为什么呢?

考虑下面的单元测试类,这个类测试了RegisterUseCase类的单个方法:

@ExtendWith(SpringExtension.class)
@SpringBootTest
class RegisterUseCaseTest {

  @Autowired
  private RegisterUseCase registerUseCase;

  @Test
  void savedUserHasRegistrationDate() {
    User user = new User("zaphod", "zaphod@mail.com");
    User savedUser = registerUseCase.registerUser(user);
    assertThat(savedUser.getRegistrationDate()).isNotNull();
  }

}

这个测试类在我的电脑上需要大概4.5秒来执行一个空的Spring项目。

但是一个好的单元测试仅仅需要几毫秒。否则就会阻碍TDD(测试驱动开发)流程,这个流程倡导“测试/开发/测试”。

但是就算我们不使用TDD,等待一个单元测试太久也会破坏我们的注意力。

执行上述的测试方法事实上仅需要几毫秒。剩下的4.5秒是因为@SpringBootTest告诉了 Spring Boot 要启动整个Spring Boot 应用程序上下文。

所以我们启动整个应用程序仅仅是因为要把RegisterUseCase实例注入到我们的测试类中。启动整个应用程序可能耗时更久,假设应用程序更大、Spring需要加载更多的实例到应用程序上下文中。

所以,这就是为什么不要在单元测试中使用Spring。坦白说,大部分编写单元测试的教程都没有使用Spring Boot

创建一个可测试的类实例

然后,为了让Spring实例有更好的测试性,有几件事是我们可以做的。

属性注入是不好的

让我们以一个反例开始。考虑下述类:

@Service
public class RegisterUseCase {

  @Autowired
  private UserRepository userRepository;

  public User registerUser(User user) {
    return userRepository.save(user);
  }

}

这个类如果没有Spring没法进行单元测试,因为它没有提供方法传递UserRepository实例。因此我们只能用文章之前讨论的方式-让Spring创建UserRepository实例,并通过@Autowired注解注入进去。

这里的教训是:不要用属性注入。

提供一个构造函数

实际上,我们根本不需要使用@Autowired注解:

@Service
public class RegisterUseCase {

  private final UserRepository userRepository;

  public RegisterUseCase(UserRepository userRepository) {
    this.userRepository = userRepository;
  }

  public User registerUser(User user) {
    return userRepository.save(user);
  }

}

这个版本通过提供一个允许传入UserRepository实例参数的构造函数来允许构造函数注入。在这个单元测试中,我们现在可以创建这样一个实例(或者我们之后要讨论的Mock实例)并通过构造函数注入了。

当创建生成应用上下文的时候,Spring会自动使用这个构造函数来初始化RegisterUseCase对象。注意,在Spring 5 之前,我们需要在构造函数上增加@Autowired注解,以便让Spring找到这个构造函数。

还要注意的是,现在UserRepository属性是final修饰的。这很重要,因为这样的话,应用程序生命周期时间内这个属性内容不会再变化。此外,它还可以帮我们避免变成错误,因为如果我们忘记初始化该属性的话,编译器就报错。

减少模板代码

通过使用Lombok@RequiredArgsConstructor注解,我们可以让构造函数自动生成:

@Service
@RequiredArgsConstructor
public class RegisterUseCase {

  private final UserRepository userRepository;

  public User registerUser(User user) {
    user.setRegistrationDate(LocalDateTime.now());
    return userRepository.save(user);
  }

}

现在,我们有一个非常简洁的类,没有样板代码,可以在普通的 java 测试用例中很容易被实例化:

class RegisterUseCaseTest {

  private UserRepository userRepository = ...;

  private RegisterUseCase registerUseCase;

  @BeforeEach
  void initUseCase() {
    registerUseCase = new RegisterUseCase(userRepository);
  }

  @Test
  void savedUserHasRegistrationDate() {
    User user = new User("zaphod", "zaphod@mail.com");
    User savedUser = registerUseCase.registerUser(user);
    assertThat(savedUser.getRegistrationDate()).isNotNull();
  }

}

还有部分确实,就是如何模拟测试类所依赖的UserReposity实例,我们不想依赖真实的类,因为这个类需要一个数据库连接。

使用Mockito来模拟依赖项

现在事实上的标准模拟库是 Mockito。它提供至少两种方式来创建一个模拟UserRepository实例,来填补前述代码的空白。

使用普通Mockito来模拟依赖

第一种方式是使用Mockito编程:

private UserRepository userRepository = Mockito.mock(UserRepository.class);

这会从外界创建一个看起来像UserRepository的对象。默认情况下,方法被调用时不会做任何事情,如果方法有返回值,会返回null

因为userRepository.save(user)返回null,现在我们的测试代码assertThat(savedUser.getRegistrationDate()).isNotNull()会报空指针异常(NullPointerException)。

所以我们需要告诉Mockito,当userRepository.save(user)调用的时候返回一些东西。我们可以用静态的when方法实现:

@Test
void savedUserHasRegistrationDate() {
  User user = new User("zaphod", "zaphod@mail.com");
  when(userRepository.save(any(User.class))).then(returnsFirstArg());
  User savedUser = registerUseCase.registerUser(user);
  assertThat(savedUser.getRegistrationDate()).isNotNull();
}

这会让userRepository.save()返回和传入对象相同的对象。

Mockito为了模拟对象、匹配参数以及验证方法调用,提供了非常多的特性。想看更多,文档

通过Mockito@Mock注解模拟对象

创建一个模拟对象的第二种方式是使用Mockito@Mock注解结合 JUnit Jupiter的MockitoExtension一起使用:

@ExtendWith(MockitoExtension.class)
class RegisterUseCaseTest {

  @Mock
  private UserRepository userRepository;

  private RegisterUseCase registerUseCase;

  @BeforeEach
  void initUseCase() {
    registerUseCase = new RegisterUseCase(userRepository);
  }

  @Test
  void savedUserHasRegistrationDate() {
    // ...
  }

}

@Mock注解指明那些属性需要Mockito注入模拟对象。由于JUnit不会自动实现,MockitoExtension则告诉Mockito来评估这些@Mock注解。

这个结果和调用Mockito.mock()方法一样,凭个人品味选择即可。但是请注意,通过使用 MockitoExtension,我们的测试用例被绑定到测试框架。

我们可以在RegisterUseCase属性上使用@InjectMocks注解来注入实例,而不是手动通过构造函数构造。Mockito会使用特定的算法来帮助我们创建相应实例对象:

@ExtendWith(MockitoExtension.class)
class RegisterUseCaseTest {

  @Mock
  private UserRepository userRepository;

  @InjectMocks
  private RegisterUseCase registerUseCase;

  @Test
  void savedUserHasRegistrationDate() {
    // ...
  }

}

使用AssertJ创建可读断言

Spring Boot 测试包自动附带的另一个库是AssertJ。我们在上面的代码中已经用到它进行断言:

assertThat(savedUser.getRegistrationDate()).isNotNull();

然而,有没有可能让断言可读性更强呢?像这样,例子:

assertThat(savedUser).hasRegistrationDate();

有很多测试用例,只需要像这样进行很小的改动就能大大提高可理解性。所以,让我们在test/sources中创建我们自定义的断言吧:

class UserAssert extends AbstractAssert<UserAssert, User> {

  UserAssert(User user) {
    super(user, UserAssert.class);
  }

  static UserAssert assertThat(User actual) {
    return new UserAssert(actual);
  }

  UserAssert hasRegistrationDate() {
    isNotNull();
    if (actual.getRegistrationDate() == null) {
      failWithMessage(
        "Expected user to have a registration date, but it was null"
      );
    }
    return this;
  }
}

现在,如果我们不是从AssertJ库直接导入,而是从我们自定义断言类UserAssert引入assertThat方法的话,我们就可以使用新的、更可读的断言。

创建一个这样自定义的断言类看起来很费时间,但是其实几分钟就完成了。我相信,将这些时间投入到创建可读性强的测试代码中是值得的,即使之后它的可读性只有一点点提高。我们编写测试代码就一次,但是之后,很多其他人(包括未来的我)在软件生命周期中,需要阅读、理解然后操作这些代码很多次。

如果你还是觉得很费事,可以看看断言生成器

结论

尽管在测试中启动Spring应用程序也有些理由,但是对于一般的单元测试,它不必要。有时甚至有害,因为更长的周转时间。换言之,我们应该使用更容易支持编写普通单元测试的方式构建Spring实例。

Spring Boot Test Starter附带MockitoAssertJ作为测试库。让我们利用这些测试库来创建富有表现力的单元测试!

到此这篇关于使用Spring Boot进行单元测试详情的文章就介绍到这了,更多相关Spring Boot单元测试内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

时间: 2022-09-19

SpringBoot单元测试没有执行的按钮问题及解决

目录 单元测试没有执行的按钮 问题说明 解决方法 单元测试没有启动按钮(另辟蹊径) 大致如下图(红圈处,没有启动按钮) 现状 转机 结论 单元测试没有执行的按钮 问题说明 在搭建SpringBoot项目单元测试中,突然发现没有执行的按钮,如是,我使用鼠标右键,强行执行该测试方法.结果报错. 报错信息: The class com.example.demo.DemoApplicationTests is not public. idea给的建议: Test class should have ex

SpringBoot单元测试使用@Test没有run方法的解决方案

目录 SpringBoot单元测试使用@Test没有run方法 原因找到了 SpringBoot写单元测试遇到的坑 SpringBoot怎么写单元测试 SpringBoot使用Mockito进行单元测试 通过真实测试用例测试代码 SpringBoot单元测试使用@Test没有run方法 吐了!一个关键字,纠错两小时,看了十几篇博客....最后重新建测试类发现@Test又有用,结果发现是因为默认的Tests测试类没有public关键字! 这个破错改了两小时... ==后续来了:== 原因找到了 建

IDEA&nbsp;单元测试报错:Class&nbsp;not&nbsp;found:xxxx&nbsp;springboot的解决

目录 IDEA单元测试报错:Class not found:xxxx springboot 报错 解决 让人抓狂的ClassNotFoundException 启动项目时,始终出现如下错误提示 在项目的pom文件,添加了以下代码 IDEA单元测试报错:Class not found:xxxx springboot 报错 引入了新依赖,想着在测试模块进行测试. 结果报错说 Class not found:xxxx 说找不到这个类. 解决 把安装了新依赖的父工程 重新 install一下 再进行测试

springboot打包如何忽略Test单元测试

springboot打包忽略Test单元测试 在maven pom.xml中加入配置: <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.20.1</version> <configuration> <skipTests>true

springboot集成junit编写单元测试实战

目录 一:查看jar包版本号是否为junit4: 二:实战应用: 三:扩展 在做单元测试时,代码覆盖率常常被拿来作为衡量测试好坏的指标,甚至,用代码覆盖率来考核测试任务完成情况,比如,代码覆盖率必须达到80%或 90%.于是乎,测试人员费尽心思设计案例覆盖代码.用代码覆盖率来衡量,有利也有弊. 首先,让我们先来了解一下所谓的“代码覆盖率”.我找来了所谓的定义:代码覆盖率 = 代码的覆盖程度,一种度量方式. 一:查看jar包版本号是否为junit4: junit自身注解: @BeforeClass

详解springboot中junit回滚

springboot中使用junit编写单元测试,并且测试结果不影响数据库. pom引入依赖 如果是IDE生成的项目,该包已经默认引入. <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency&g

Springboot使用Junit测试没有插入数据的原因

从写Junit开始笔者就有一个疑问,为什么执行插入测试方法成功了但是数据库里却没有对应数据,那怎么测试的呢?今天查阅了资料找到了原因 1.Junit测试原理 springboot中使用junit编写单元测试默认是事物回滚的,这样测试的脏数据不影响数据库,即实际上是执行了对应的插入操作,但是完成操作后执行了事务回滚操作,从而数据库中没有对应数据. 2.关闭自动事务回滚 在对应的测试方法上添加@Rollback(false)关闭回滚. 补充知识:Spring Boot Junit无法执行问题汇总 S

Springboot集成JUnit5优雅进行单元测试的示例

为什么使用JUnit5 JUnit4被广泛使用,但是许多场景下使用起来语法较为繁琐,JUnit5中支持lambda表达式,语法简单且代码不冗余. JUnit5易扩展,包容性强,可以接入其他的测试引擎. 功能更强大提供了新的断言机制.参数化测试.重复性测试等新功能. ps:开发人员为什么还要测试,单测写这么规范有必要吗?其实单测是开发人员必备技能,只不过很多开发人员开发任务太重导致调试完就不管了,没有系统化得单元测试,单元测试在系统重构时能发挥巨大的作用,可以在重构后快速测试新的接口是否与重构前有

springboot使用单元测试实战

前言 springboot提供了 spirng-boot-starter-test 以供开发者使用单元测试,在引入 spring-boot-starter-test 依赖后: <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope>

SpringBoot集成swagger的实例代码

Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件.本文简单介绍了在项目中集成swagger的方法和一些常见问题.如果想深入分析项目源码,了解更多内容,见参考资料. Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步.Swagger 让部署管理和使用功能强大的API从未如此简单. 对于

SpringBoot整合Junit实例过程解析

这篇文章主要介绍了SpringBoot整合Junit实例过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 前提条件:SpringBoot已经整合了Mybatis,至于SpringBoot如何整合Mybatis可参考SpringBoot整合mybatis简单案例过程解析 SpringBoot为什么要整合Juni? SpringBoot整合了Junit后,在写了Mapper接口后,可直接通过Junit进行测试,不用再写Controller层,

SpringBoot 集成 activiti的示例代码

SpringBoot 集成 activiti  基础环境搭建 添加依赖 <dependency> <groupId>org.activiti</groupId> <artifactId>activiti-spring-boot-starter-basic</artifactId> <version>6.0.0</version> </dependency> 添加配置文件 server: tomcat: uri-

详解Spring-Boot集成Spring session并存入redis

spring Session 提供了一套用于管理用户 session 信息的API和实现. Spring Session为企业级Java应用的session管理带来了革新,使得以下的功能更加容易实现: 编写可水平扩展的原生云应用. 将session所保存的状态卸载到特定的外部session存储中,如Redis或Apache Geode中,它们能够以独立于应用服务器的方式提供高质量的集群. 当用户使用WebSocket发送请求的时候,能够保持HttpSession处于活跃状态. 在非Web请求的处

详解SpringBoot集成jsp(附源码)+遇到的坑

本文介绍了SpringBoot集成jsp(附源码)+遇到的坑 ,分享给大家 1.大体步骤 (1)创建Maven web project: (2)在pom.xml文件添加依赖: (3)配置application.properties支持jsp (4)编写测试Controller (5)编写JSP页面 (6)编写启动类App.java 2.新建SpringInitialzr 3.pom文件 <dependencies> <dependency> <groupId>org.s

SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)

pom.xml增加依赖包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <