一点断言的小感悟
本文以node.js的assert为例,来看一看断言是什么,让我们一起走进断言的世界~
本文主要分为几个部分:
1. 什么是断言
2. 断言的使用方法
3 .断言的作用
4. 断言的使用场景
什么是断言?
断言,顾名思义,就是程序运行到某处的时候运行不下去了,中断了,罢工了。那么它是依据什么来决定罢不罢工的呢?这就需要传入一个参数,当参数不为真时,就发出一个错误信息告诉断言是什么以及错误信息,然后程序终止。
它就相当于一个if语句
if(条件为真) {
程序正常运行
} else {
报错,程序终止
}
但是如果都用if语句的话就使得我们的代码很臃肿,没有使用断言显得优雅。另外,断言一般是用来debugger的,测试自己的代码有没有非法情况出现。就像测试一个函数的参数,如果这个函数是内部使用的话,可以用断言来测试;如果是对外提供的接口的话,还是要用if判断,因为如果传入一个异常值的话,不能就让程序终止运行了啊。if语句是如果判断为真,就执行里面的语句,否则就不执行,而断言是会直接终止程序的,所以更适合在测试的时候使用。
知道了何为断言,我们就来看看assert有哪些常用的断言测试的函数吧。
断言的使用
首先在项目中引入assert模块:
const assert = require('assert');
之后就可以愉快的使用啦
常用的断言测试函数:
先说明一下以下字段代表的含义:
actual: 真实的值
expected: 预期的值
message: 报错信息
1. assert(value[, message])
value: 要检查是否为真的值
message: | 抛出的错误信息
等价于使用assert.ok()
2. assert.strictEqual(actual, expected[, message])
比较 actual 参数和 expected 参数是否全等,是使用的 === 比较符而不是 ==, 例如:
assert.strictEqual(1, 1); // 测试通过
assert.strictEqual(1, '1'); // 报错
另外,assert.strictEqual() 是浅层的比较,也就是说如果是比较两个对象的话,比较的是对象的引用,而不是按值比较的。
3. assert.deepStrictEqual(actual, expected[, message])
这个是深层比较,可以比较出对象是否完全相等。对对象的原型也会进行比较
assert.deepStrictEqual({ a: 1 }, { a: 1 }); // 通过
const object = {};
const fakeDate = {};
Object.setPrototypeOf(fakeDate, Date.prototype);
assert.deepStrictEqual(object, fakeDate); // 原型不同,测试不通过
4. assert.equal(actual, expected[, message)
使用 == 符号来判断真实值是否和预期值浅层的相等
5. assert.deepEqual(actual, expected[, message)
使用 == 符号来判断真实值是否和预期值深层的相等
assert.deepEqual({ a: 1 }, { a: ’1‘ }); // 通过
deepEqual()只测试自身可枚举的属性,不测试对象的原型
6. assert.throws(block[, error][, message])
block: <Function>
error: <RegExp> | <Function> | <Object> | <Error>
message: <String> | <Error>
预期block会抛出一个错误,error会验证错误。如果block抛出的错误满足error参数,即抛出错误与期望一致,则断言通过。否则抛出block中的错误,如果block不抛出错误,则抛出[assertionError]
assert.throws(
() => {
throw new Error('错误信息');
},
Error
); // error是构造函数,block抛出的错误与预期一致,断言通过
注意:error参数不能是字符串,如果是字符串则会省略error参数,字符串被传入message参数
assert.throws(fn, '错误信息', '没有抛出期望的信息'); // 错误
assert.throws(fn, /错误信息/, '没有抛出期望的信息');// 正确
断言的作用
assert模块主要用于编写程序的单元测试时使用,通过断言可以尽早发现错误。一般在测试环境使用,正式环境禁用。
断言的使用场景
使不使用断言可以先考虑以下如果断言的条件不满足,程序是否可以正常运行,如果可以,就不用使用了,如果不可以,就可以使用。
1. 对函数参数的合法性进行确认
function fn(a) {
assert(!isNaN(a), '不是一个数字');
}