Java几种常用的断言风格你怎么选?

Wesley13
• 阅读 625

日常工作中,不管你是写Unit Test,还是采用TDD的编程方式进行开发,都会遇到断言。而断言的风格常见的会有Assert、BDD风格,对于这些常见的断言风格你怎么选择呢?

01 Assert风格

JUnit中提供了这样的assert断言风格,例如:

[@Test](https://my.oschina.net/azibug)
    void should_be_unlocked_when_insert_coin_given_a_entrance_machine_with_locked_state() {
        EntranceMachine entranceMachine = new EntranceMachine(EntranceMachineState.LOCKED);

        String result = entranceMachine.execute(Action.INSERT_COIN);

        assertEquals("opened", result);
        assertEquals(EntranceMachineState, entranceMachineState.UNLOCKED);
    }

Hamcrest和AssertJ都提供了assertThat()这样风格的断言,例如:

AssertJ提供的assertThat()的断言语法

[@Test](https://my.oschina.net/azibug)
    void should_be_unlocked_when_insert_coin_given_a_entrance_machine_with_locked_state() {
        EntranceMachine entranceMachine = new EntranceMachine(EntranceMachineState.LOCKED);

        String result = entranceMachine.execute(Action.INSERT_COIN);

        assertThat(result).isEqualsTo("opened");
        assertThat(EntranceMachineState).isEqualsTo(entranceMachineState.UNLOCKED);
    }

Hamcrest提供的assertThat()断言语法

[@Test](https://my.oschina.net/azibug)
    void should_be_unlocked_when_insert_coin_given_a_entrance_machine_with_locked_state() {
        EntranceMachine entranceMachine = new EntranceMachine(EntranceMachineState.LOCKED);

        String result = entranceMachine.execute(Action.INSERT_COIN);

        assertThat(result, is("opened"));
        assertThat(EntranceMachineState, is(entranceMachineState.UNLOCKED));
    }

对比上面三种断言语法,因为场景简单,所以结果差异并不是很大。对于我个人更加偏向于使用AssertJ提供的断言风格。因为这种风格避免JUnit提供的断言中经常遇到的问题,expected在前还是actural在前的问题。相比于Hamcrest的断言风格,在日常工作中综合对比发现AssertJ的更加清晰,毕竟AssertJ中assertThat只需要接收一个参数,而不用关注括号是否对齐的问题。

日常工作中如果使用TDD,且场景适当(例如上面例子),那么Hamcreate和AssertJ的差别不是很大。JUnit5默认提供了Hamcreate的断言,不需要额外的再引入其他依赖。

02 BDD风格

代码的可读性越来越收到开发者的重视。测试代码的可读性同样重要,为了让测试代码结构清晰,便于业务逻辑变动时能快读读懂测试的上下文,很多开发团队约定了BDD的风格来组织测试代码。其中包含两部分的约定:测试方法名的约定,测试代码段落的约定。

例如前面的例子:

    [@Test](https://my.oschina.net/azibug)
    void should_be_unlocked_when_insert_coin_given_a_entrance_machine_with_locked_state() {
      ...
    }

虽然方法名很长,但是通过方法名我们能够快速知道测试类中有哪些测试,通过方法名我们能够清晰的当前测试的上下文,在测什么,期望的结果什么。通过方法名而不是通过比方法名长很多的代码段来获取测试在测什么的信息,毕竟阅读代码时间和修改代码时间可能是10:1,甚至20:1。所以团队约定BDD的风格组织在后续修改代码时,是受益良多的。

当需要也带具体的测试代码的时候,团队发现按照BDD这种三段式的风格来组织代码受益良多。例如:

[@Test](https://my.oschina.net/azibug)
    void should_be_unlocked_when_insert_coin_given_a_entrance_machine_with_locked_state() {
        EntranceMachine entranceMachine = new EntranceMachine(EntranceMachineState.LOCKED);

        String result = entranceMachine.execute(Action.INSERT_COIN);

        assertThat(result).isEqualsTo("opened");
        assertThat(EntranceMachineState).isEqualsTo(entranceMachineState.UNLOCKED);
    }

我们可以清晰的知道哪行代码在描述上下文,哪几行代码在描述测试意图,哪几行代码在描述测试结果验证。

BDD的风格能够帮助团队将测试代码维护的较为清晰。AssertJ提供了BDD风格的断言方式。使用then()语法。例如:

@Test
    void should_be_unlocked_when_insert_coin_given_a_entrance_machine_with_locked_state() {
        EntranceMachine entranceMachine = new EntranceMachine(EntranceMachineState.LOCKED);

        String result = entranceMachine.execute(Action.INSERT_COIN);

        then(result).isEqualsTo("opened");
        then(EntranceMachineState).isEqualsTo(entranceMachineState.UNLOCKED);
    }

断言变化不大。但是真正仔细读的时候,会发现使用then()还是简单那么一点点的。

我们常用的Mock工具Mockito,也提供了BDD风格的断言:then(), should(), and()。

import static org.mockito.BDDMockito.then;
import static org.assertj.core.api.BDDAssertions.and;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;

@SuppressWarnings("static-access")
@Test
public void bdd_assertions_with_bdd_mockito() {
  Person person = mock(Person.class)
  person.ride(bike);

  person.ride(bike);

  then(person).should(times(2)).ride(bike);
  and.then(person.hasBike()).isTrue();
}

所以日常开发中,我会首先选择then(),其次会选择assertThat()。

除了以上两种断言风格,流式断言让代码更清晰,断言重复内容更少

当我们需要为某个结果测试多个测试点时,如果为每个测试点都组织一次相同的上下文,那么重复代码太多。带来的价值就是那么一点点区别,所以在测试力度上我们可以根据经验来在开发工程中动态调整。

下面据一个例子,当我们需要验证有一个查询方法返回的List的结果时,不单单要验证List中元素的数量,还要验证元素是否时期望的顺序。那么流式写法会缩减一部分重复的断言代码。

then(users).hasSize(3)
           .containsExactlyInAnyOrder(
               firstUser,
               secondUser,
               thirdUser);

上面是日常工作中经常使用到的断言技巧,你的怎么选择的呢?那种风格无所谓能工作就行?

参考

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
待兔 待兔
5个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Stella981 Stella981
3年前
Google Java 代码规范
1.(1)简介本文档用于Java编程语言的Google源代码编码标准的完整定义。Java源文件定义为Google风格。于其他编程风格指南一样,所涉及的问题不止包含代码格式美化,还包括其他类型的约定或者编码标准。但是本文档主要关注普遍遵循的严格规则,并避免提供意义不明的可执行建议(无论任何方式)。1.1.
Stella981 Stella981
3年前
Flutter仿写一个iOS风格的通讯录
此文章主要介绍怎么使用Flutter的Cupertino风格控件,写一个iOS风格的通讯录,还有在此过程中遇到的问题及解决办法。大家在用Flutter写App的时候,一般都会使用material风格的控件,因为material风格的控件比较丰富,但是,他在iOS上就会显得Android气息比较重,不太适合,所以本文章将通过用仿写iOS通讯录,系统地介绍C
Stella981 Stella981
3年前
C++系统学习之C库assert
C库之<cassertassert.h定义了一个作为标准调试工具的宏宏函数函数说明assertEvaluateassertion(macro)assert当使用assert()里,给它一个参数,即一个表示断言为真的表达式。预处理器产生测试该断言的代码。如果断言不为真,则发出一
Stella981 Stella981
3年前
JUnit的各种断言
JUnit为我们提供了一些辅助函数,他们用来帮助我们确定被测试的方法是否按照预期的效果正常工作,通常,把这些辅助函数称为断言。下面我们来介绍一下JUnit的各种断言。   1、assertEquals   函数原型1:assertEquals(\Stringmessage\,expected,actual) 参数说
Wesley13 Wesley13
3年前
Unittest 框架之断言,你学会了吗??
unittest断言  Python在unittest.TestCase类中提供了很多断言方法。断言方法检查你认为应该满足的条件是否确实满足。如果该条件确实满足,你对程序行为的假设就得到了确认,你就可以确信其中没有错误。如果你认为应该满足的条件实际上并不满足,Python将引发异常。下表描述了6个常用的断言方法。
Stella981 Stella981
3年前
Ruby on Rails 学习笔记(四)
当页面需要保持风格一致时,最简单的方法是采用模板。详见如下代码:<!doctype html<html <head  <meta charset"UTF8"  <meta name"Generator" content"EditPlus®"  <meta name"Author
Wesley13 Wesley13
3年前
## 码出高效——小组代码规范
码出高效——小组代码规范编程规约一.命名风格1.代码中的命名不能以下划线、美元符号开头或结尾。反例:<fontcolorDC143Csize3\_name/$name/name&/name\_</font2.【强制】代码中的命名严禁使用拼音与英文混合的方式,更不
Stella981 Stella981
3年前
JavaScript编程风格
    所谓"编程风格"(programmingstyle),指的是编写代码的样式规则。不同的程序员,往往有不同的编程风格。    有人说,编译器的规范叫做"语法规则"(grammar),这是程序员必须遵守的;而编译器忽略的部分,就叫"编程风格"(programmingstyle),这是程序员可以自由选择的。这种说法不完全正确,程序员固然可