使用SpringBoot编写一个优雅的单元测试

 更新时间:2023年07月21日 17:03:20   作者:Young丶  
这篇文章主要为大家详细介绍了如何使用SpringBoot编写一个优雅的单元测试,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起了解一下

什么是单元测试

当一个测试满足下面任意一点时,测试就不是单元测试 (by Michael Feathers in 2005):

  • 与数据库交流
  • 与网络交流
  • 与文件系统交流
  • 不能与其他单元测试在同一时间运行
  • 不得不为运行它而作一些特别的事

如果一个测试做了上面的任何一条,那么它就是一个集成测试。

不要用 Spring 编写单元测试

@SpringBootTest
class OrderServiceTests {
    @Autowired
    private OrderRepository orderRepository;
    @Autowired
    private OrderService orderService;
    @Test
    void payOrder() {
        Order order = new Order(1L, false);
        orderRepository.save(order);
        Payment payment = orderService.pay(1L, "4532756279624064");
        assertThat(payment.getOrder().isPaid()).isTrue();
        assertThat(payment.getCreditCardNumber()).isEqualTo("4532756279624064");
    }
}

这是一个单元测试吗?首先@SpringBootTest注解加载了整个应用上下文,而仅仅是为了注入两个 Bean。

另一个问题是我们需要读取和写入订单到数据库,这也是集成测试的范畴。

Spring Framework 文档对于单元测试的描述

真正的单元测试运行的非常快,因为不需要运行时去装配基础设施。强调将真正的单元测试作为开发方法的一部分可以提高你的生产力。

编写 “可单元测试” 的 Service

Spring Framework 文档对于单元测试的另一描述

依赖注入可以让你的代码减少依赖。POJO 可以让你的应用可以通过new操作符在 JUnit 或 TestNG 上进行测试,不需要任何的 Spring 和其他容器

考虑如果编写这样的 Service,它方便进行单元测试吗!?

@Service
public class BookService {
    @Autowired
    private BookRepository repository;
    // ... service methods
}

不方便,因为BookRepository通过@Autowired被注入到 Service 中,并且repository是一个私有变量,这就限定了外界只能通过 Spring 或其它依赖注入容器(或反射)设置这个值,那么单元测试如果不想加载整个 Spring 容器,那么它就无法使用这个 Service。

而如果这样写,使用构造方法注入,外界也可以通过new去自行传递Repository,这样即使没有 Spring,外界也能进行快速的测试。这可能也是 Spring 不推荐属性注入的原因。

@Service
public class BookService {
    private BookRepository repository;
    @Autowired
    public BookService(BookRepository repository) {
        this.repository = repository;
    }
}

编写单元测试

Mockito 介绍

前面的知识表明,单元测试就是对一个系统中的某个最小单元的逻辑正确性的测试,通常是对一个方法来进行测试,因为只测试逻辑正确性,所以这个测试是独立的,不与任何外界环境相关,比如不需要连接数据库,不访问网络和文件系统,不依赖其他单元测试。但是现实的业务逻辑中往往有很多复杂错综的依赖关系,比如你想对 Service 进行单元测试,那么它要依赖一个数据库持久层的 Repository 对象,这时候就难办了,若创建了一个 Repository 便连接了数据库,连接了数据库便不是一个独立的单元测试。

Mockito 是一个用来在单元测试中快速模拟那些需要与外界环境沟通的对象,以便我们快速的、方便的进行单元测试而不用启动整个系统。

下面的代码就是 Mockito 的一个基础使用,Mock 意为伪造。

// 通过mock方法伪造一个orderRepository的实现,这个实现目前什么都不会做
orderRepository = mock(OrderRepository.class);
// 通过mock方法伪造一个paymentRepository的实现,这个实现目前什么都不会做
paymentRepository = mock(PaymentRepository.class)
// 创建一个Order对象以便一会儿使用
Order order = new Order(1L, false);
// 使用when方法,定义当orderRepository.findById(1L)被调用时的行为,直接返回刚刚创建的order对象
when(orderRepository.findById(1L)).thenReturn(Optional.of(order));
// 使用when方法,定义当paymentRepository.save(任何参数)被调用时的行为,直接返回传入的参数。
when(paymentRepository.save(any())).then(returnsFirstArg());

单元测试

class OrderServiceTests {
    private OrderRepository orderRepository;
    private PaymentRepository paymentRepository;
    private OrderService orderService;
    @BeforeEach
    void setupService() {
        orderRepository = mock(OrderRepository.class);
        paymentRepository = mock(PaymentRepository.class);
        orderService = new OrderService(orderRepository, paymentRepository);
    }
    @Test
    void payOrder() {
        Order order = new Order(1L, false);
        when(orderRepository.findById(1L)).thenReturn(Optional.of(order));
        when(paymentRepository.save(any())).then(returnsFirstArg());
        Payment payment = orderService.pay(1L, "4532756279624064");
        assertThat(payment.getOrder().isPaid()).isTrue();
        assertThat(payment.getCreditCardNumber()).isEqualTo("4532756279624064");
    }
}

现在我们即使不想连接数据库,也可以通过mock来给定一个 Repository 的其他实现,这样这个方法可以在毫秒内完成。

也可以使用Mockito

@ExtendWith(MockitoExtension.class)
class OrderServiceTests {
    @Mock
    private OrderRepository orderRepository;
    @Mock
    private PaymentRepository paymentRepository;
    @InjectMocks
    private OrderService orderService;
    // ...
}

以上就是使用SpringBoot编写一个优雅的单元测试的详细内容,更多关于SpringBoot单元测试的资料请关注脚本之家其它相关文章!

相关文章

  • java教学笔记之对象的创建与销毁

    java教学笔记之对象的创建与销毁

    面向对象的编程语言使程序能够直观的反应客观世界的本来面目,并且使软件开发人员能够运用人类认识事物所采用的一般思维方法进行软件开发,是当今计算机领域中软件开发和应用的主流技术。
    2016-01-01
  • Mybatis的核心配置文件使用方法

    Mybatis的核心配置文件使用方法

    Mybatis的核心配置文件有两个,一个是全局配置文件,它包含了会深深影响Mybatis行为的设置和属性信息;一个是映射文件,它很简单,让用户能更专注于SQL代码,本文主要介绍了Mybatis的核心配置文件使用方法,感兴趣的可以了解一下
    2023-11-11
  • 解决SpringBoot在IDEA中热部署失效问题

    解决SpringBoot在IDEA中热部署失效问题

    热部署是指程序运行过程中实时更新或替换其组件的技术,即项目正在启动中,修改了配置文件中某个值或者添加了某个方法或者修改了某个方法参数,本文给大家介绍了解决SpringBoot在IDEA中热部署失效问题,需要的朋友可以参考下
    2024-01-01
  • Java实现简单猜数字小游戏

    Java实现简单猜数字小游戏

    这篇文章主要为大家详细介绍了Java实现猜数字游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-12-12
  • 使用maven创建普通项目命令行程序详解

    使用maven创建普通项目命令行程序详解

    大部分使用maven创建的是web项目,这里使用maven创建一个命令行程序,目的是让大家了解maven特点和使用方式,有需要的朋友可以借鉴参考下
    2021-10-10
  • 一文详解Java中的JSON数据处理指南

    一文详解Java中的JSON数据处理指南

    JSON作为一种轻量级的数据交换格式,在Web服务和应用程序之间广泛使用,本文详细介绍了在Java中解析和操作JSON数据的步骤,包括导入库、创建JSON对象和数组、读取数据、创建和序列化JSON对象,以及错误处理等,感兴趣的朋友跟随小编一起看看吧
    2025-09-09
  • Springmvc实现文件下载2种实现方法

    Springmvc实现文件下载2种实现方法

    这篇文章主要介绍了Springmvc实现文件下载2种实现方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • java实现微信点餐申请微信退款

    java实现微信点餐申请微信退款

    这篇文章主要为大家详细介绍了java实现微信点餐申请微信退款,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-09-09
  • SpringBoot2.x 集成 Thymeleaf的详细教程

    SpringBoot2.x 集成 Thymeleaf的详细教程

    本文主要对SpringBoot2.x集成Thymeleaf及其常用语法进行简单总结,其中SpringBoot使用的2.4.5版本。对SpringBoot2.x 集成 Thymeleaf知识感兴趣的朋友跟随小编一起看看吧
    2021-07-07
  • Spring超详细讲解事务和事务传播机制

    Spring超详细讲解事务和事务传播机制

    Spring事务的本质就是对数据库事务的支持,没有数据库事务,Spring是无法提供事务功能的。Spring只提供统一的事务管理接口,具体实现都是由数据库自己实现的,Spring会在事务开始时,根据当前设置的隔离级别,调整数据库的隔离级别,由此保持一致
    2022-06-06

最新评论