搜尋

首頁 >web前端 >js教程 >node.js之斷言assert的使用範例分享

node.js之斷言assert的使用範例分享

小云云
小云云原創
2018-01-29 17:27:471390瀏覽

斷言是程式設計術語，表示為一些布林表達式，程式設計師相信在程式中的某個特定點該表達式值為真，可以在任何時候啟用和停用斷言驗證，因此可以在測試時啟用斷言而在部署時禁用斷言。同樣，程式投入運行後，最終用戶在遇到問題時可以重新啟用斷言。

使用斷言可以創建更穩定、品質更好且 不易於出錯的程式碼。當需要在一個值為FALSE時中斷當前操作的話，可以使用斷言。 【單元測試】必須使用斷言。

Node提供了 10 多個斷言測試的函數，用於測試不變式，我在文章中將這 10 多個函數進行了分組，方便理解記憶。

【提示】在本文章中，expected 代表預期值，actual 代表實際值， message 代表自訂資訊

二.判斷值是否為真值

#判斷值是否為真值有以下兩個斷言測試函數

2.1 assert(value[, message])

這個測試函數在【Boolean(value)】 為【true】時透過斷言測試，否則拋出【AssertionError】

const assert = require("assert");

assert("blue","第一个值为false时以我为错误信息抛出");

assert(true,"第一个值为false时以我为错误信息抛出");

上面一段程式碼由於【Boolean(value)】全部為true，所以全部透過斷言測試

assert(false,"第一个值为false时以我为错误信息抛出");

// AssertionError [ERR_ASSERTION]: 第一个值为false时以我为错误信息抛出

上面程式碼中value 為false，則拋出一個帶有message 屬性的【AssertionError】，其中message 屬性的值等於傳入的message 參數的值。 【如果 message 參數為 undefined，則賦予預設的錯誤訊息】。 

assert(false);
// AssertionError [ERR_ASSERTION]: false == true

上面程式碼由於沒有指定【message】參數，拋出的為預設錯誤訊息的【AssertionError】

2.2 assert.ok(value[, message])

#assert.ok() 與assert()的作用是一樣的，都是測試【value】是否為真值。而且用法也一樣，所以可以將assert()視為assert.ok()的語法糖

const assert = require("assert");
assert.ok(true);
assert.ok(1);

上面程式碼【Boolean(value)】全部為true，所以全部斷言通過，下面是斷言不通過的情況，分別列出了預設錯誤訊息

assert.ok(0);
//AssertionError [ERR_ASSERTION]: 0 == true

assert.ok(false);
//AssertionError [ERR_ASSERTION]: false == true

assert.ok(false,"自定义错误信息");
//AssertionError [ERR_ASSERTION]: 自定义错误信息

三. 判斷預期值和實際值相等（==）

這一組裡面有兩個測試函數，用來測試預期值與實際值是否相等，如果相等則斷言通過，否則拋出【AssertionError】

3.1 assert.equal(actual, expected[, message])

assert.equal()用於測試期望值和實際值是否相等，【在值類型的時候比較的是兩個值是否相等，當預期值和實際值為引用類型的時候，比較的是值得引用】

assert.equal(1, 1);
assert.equal("1", 1);

上面程式碼是對值類型的比較，說明equal()在內部使用的是（==）,而非嚴格相等，待會兒我會總結到嚴格相等（===）

assert.equal({},{},"AssertionError");
assert.equal(() => { }, () => { }, "AssertionError");
assert.equal([],[],'AssertionError');

上面三個表達式都會拋出【message】屬性值為'AssertionError'的【AssertionError】對象，【所以當值為引用類型的時候，equal（）比較的是值得引用，因此兩個引用類型的值是沒法透過equal（）斷言的】

const obj={};
assert.equal(obj,obj);
// 断言通过

上面程式碼由於比較的是同一個對象，兩個值得引用相等，所以斷言通過。

3.2 assert.deepEqual(actual, expected[, message])

同樣也是測試預期值和實際值是否相等，使用的仍然是（==），但是與equal不同的是，【deepEqual()在對引用類型進行比較的時候，不是對值的引用進行比較，而是比較的物件的屬性值】

const a = 'Blue', b = 'Pink';
assert.deepEqual(a,a,'actual unequal to expected');
// 断言通过
assert.deepEqual(a,b,'actual unequal to expected');
// AssertionError [ERR_ASSERTION]: actual unequal to expected

上面是對值類型進行的比較，和equal ()沒有任何的差異

const obj1 = { name: "foo", gender: "men" },
 obj2 = { name: "foo", gender: "men" },
 obj3 = { name: "bar", gender: "men" }
assert.deepEqual(obj1, obj2, 'actual unequal to expected');
// 断言通过
assert.deepEqual(obj1, obj3, 'actual unequal to expected');
// AssertionError [ERR_ASSERTION]: actual unequal to expected

上面程式碼是對引用型別的比較，可以看出【deepEqual() 】比較的是屬性值，而非引用，這是與equal()不同的地方。

【注意！ ！ 】deepEqual()只測試可列舉的自身屬性，不測試物件的原型、連接符號、或不可列舉的屬性（這些情況使用assert.deepStrictEqual() ，稍後會總結到）

const son1 = Object.create(obj1),
 son2 = Object.create(obj2);

son1.name="Summer";
son2.name="Summer";

assert.deepEqual(son1,son2,"actual unequal to expected");
// 断言通过

上面程式碼中son1 和son2 分別繼承與兩個不同的對象，都擁有name 為「Summer」 的屬性，最後的的結果是通過，說明【deepEqual()不測試對象的原型】

const ena = {}, enb = {};
Object.defineProperties(ena,{
 name:{
 value:"Blue"
 },
 hobby:{
 value:"foo",
 enumerable:false //可枚举性设置为false
 }
});
Object.defineProperties(enb,{
 name:{
 value:"Blue"
 },
 hobby:{
 value:"bar",
 enumerable:false //可枚举性设置为false
 }
})
assert.deepEqual(ena,enb,"actual unequal to expected") 
//ok,actual equal to expected

上面程式碼中ena 和enb 用於相同的可枚舉屬性【name】，有著值不同的不可枚舉屬性【hobby】，說明【deepEqual()不測試物件的不可列舉的屬性】

四. 判斷預期值和實際值全等（===）

這組測試函數是用來判斷預期值和實際值是否深度相等的，內部使用的是（===） ，所以物件的原型也會進行比較，值得類型也是比較的範圍。這組也有兩個測試函數。

4.1 assert.deepStrictEqual(actual, expected[, message])

由於內部使用的是全等（===），所以物件的原型也計入比較的範圍

const obj1 = { name: "foo", gender: "men" },
 obj2 = { name: "bar", gender: "men" }
const son1 = Object.create(obj1),
 son2 = Object.create(obj2);
son1.name = "Summer";
son2.name = "Summer";
assert.deepEqual(son1, son2, "actual unequal to expected");
//断言通过
assert.deepStrictEqual(son1, son2, "actual unequal to expected")
//AssertionError [ERR_ASSERTION]: actual unequal to expected

上面程式碼使用了deepEqual()和deepStrictEqual()進行了斷言測試，son1 和son2 分別繼承與兩個不同的對象，但是擁有相同的屬性值。可以看出【deepEqual()是不會考慮物件的原型的，deepStrictEqual()將原型物件列入了比較物件】

4.2 assert.strictEqual(actual, expected[, message])

strictEqual()是equal()的加强，考虑了数据类型；如果actual === expected,则断言通过，否则抛出AssertionError，message?message:默认错误信息。

assert.strictEqual(1, 2);
// 抛出 AssertionError: 1 === 2

assert.strictEqual(1, 1);
// 测试通过。

assert.strictEqual(1, '1');
// 抛出 AssertionError: 1 === '1'

assert.equal(1, '1');
// 测试通过。

【提示！！】对引用类型还是永远通不过【strictEqual()】断言测试

五. 判断预期值和实际值不相等（!=）

上面总结到了判断预期值和实际值相等，这儿总结一下判断预期值和实际值不想等的两个测试函数，实际上就是上面 （三） 的逆运算。

5.1 assert.notEqual(actual, expected[, message])

【notEqual()】为 【equal() 】的逆运算，如果 actual!= expected 则断言通过，同样对于值类型是单纯对值进行比较，对应引用类型比较的是值得引用

assert.notEqual("1", "2");
// 断言通过

assert.notEqual("1", 2);
// 断言通过

assert.notEqual("1", 1);
// AssertionError [ERR_ASSERTION]: '1' != 1

上面代码是对值类型进行的比较，第三个表达式的默认信息可以看出内部使用的是（!=）

assert.notEqual({ a: "foo" }, { a: "foo" });

assert.notEqual(() => { }, () => { });

assert.notEqual([], []);

上面的代码是对引用类型进行的断言测试，【notEqual() 】对于两个对象的测试通过是一个【恒成立】的结果。

5.2 assert.notDeepEqual(actual, expected[, message])

【notDeepEqual() 】为 【deepEqual() 】的逆运算，如果 actual!= expected 则断言通过，不同于notEqual()的是对于引用类型是对值进行判断，不比对原型、不可枚举属性,只比对自有可枚举属性,断言通过。

const obj1 = { a: "foo" },
 obj2 = { b: "bar" },
 obj3 = Object.create(obj1);

assert.notDeepEqual(obj1,obj1,'actual equal to expected');
// AssertionError [ERR_ASSERTION]: actual equal to expected

assert.notDeepEqual(obj1,obj2,'actual equal to expected');
// 断言通过

assert.notDeepEqual(obj1,obj3,'actual equal to expected');
// 断言通过

上面代码中最后一个表达式断言通过，说明【不比对原型、不可枚举属性,只比对自有可枚举属性】

【注意！！】与notEqual的区别，也就是deepEqual和equal的区别，在引用数据类型的时候，deepEqual是比较的值而非引用，equal对比的是引用，所以引用类型在equal的时候是永远无法通过断言测试的，以此类推，引用类型在notEqual时是永远否可以通过断言测试的。

六. 判断预期值和实际值严格不相等（!==）

上面总结到了判断预期值和实际值严格相等，这儿总结一下判断预期值和实际值严格不相等的两个测试函数，实际上就是上面 （四） 的逆运算

6.1 assert.notStrictEqual(actual, expected[, message])

如果actual与expected不 !== 则断言通过， 与 assert.deepStrictEqual() 相反

assert.notStrictEqual("1", 1);
// 断言通过

assert.notStrictEqual("1", "1");
// AssertionError [ERR_ASSERTION]: '1' !== '1'

上面代码是对值类型进行的断言测试，可以看出【notStrictEqual() 】考虑了数据类型

assert.notStrictEqual({ a: "foo" }, { a: "foo" });
assert.notStrictEqual(() => { }, () => { });
assert.notStrictEqual([], []);

上面代码是对引用类型的测试，全部通过，以上表达式是恒通过的。

6.2 assert.notDeepStrictEqual(actual, expected[, message])

notDeepStrictEqual()就是deepStrictEqual()的逆运算，如果 actual ！== expected 则断言通过，否则抛出AssertionError。

assert.notDeepStrictEqual({ a: '1' }, { a: 1 });
//断言通过

assert.notDeepStrictEqual({ a: '1' }, { a: "1" });
//AssertionError [ERR_ASSERTION]: { a: '1' } notDeepStrictEqual { a: '1' }

七. 断言错误并抛出

这一组有 四 个（可以说是 三 个）测试函数，是对错误进行的处理。

7.1 assert.fail(message)

这个测试函数不多说，可以看错是下一个函数的重载，用于主动抛出带有【message】属性的【AssertionError】对象

assert.fail("自定义错误信息");
// AssertionError [ERR_ASSERTION]: 自定义错误信息

7.2 assert.fail(actual, expected[, message[, operator[, stackStartFunction]]])

该测试函数用于主动抛出自定义错误信息，抛出错误信息格式：【actual 参数 + operator 参数 + expected 参数】

assert.fail("BLUE","PINK");  
// AssertionError [ERR_ASSERTION]: 'BLUE' != 'PINK'

上面代码不提供【message】和【operator】,则【operator】默认为 【!=】

assert.fail("BLUE","PINK","自定义的错误信息");  
// AssertionError [ERR_ASSERTION]: 自定义的错误信息

assert.fail("BLUE","PINK","自定义的错误信息","?",()=>{
  console.log("hello");
 });
// AssertionError [ERR_ASSERTION]: 自定义的错误信息

上面代码提供【message】,这时候 【actual】、【operator】、【expected】等参数会被列入错误对象属性中

assert.fail("BLUE","PINK",undefined);
// AssertionError [ERR_ASSERTION]: 'BLUE' undefined 'PINK'

assert.fail("BLUE","PINK",undefined,"?");
// AssertionError [ERR_ASSERTION]: 'BLUE' ? 'PINK'

上面代码是【message】为 undefined 时，会检测【operator】参数，【operator?operator:undefined 】

7.3 assert.throws(block,error, message)

参数说明：

block | Function

error | RegExp | Function

message | any

【说明！！】如果block抛出的错误满足error参数,也就是抛出错误与期望一致,则断言通过，否则抛出block中的错误，如果block不抛出错误，则抛出【AssertionError 】。

【提示！！】error 参数可以是构造函数、正则表达式、或自定义函数。

assert.throws(
 () => {
  throw new Error('错误信息');
 },
 Error
);

上面代码中 error 参数为构造函数，【block】抛出的错误与预期的一致，所以断言通过。

assert.throws(
 () => {
  throw new Error('错误信息');
 },
 /错误/
);

上面代码中 error 参数为正则表达式，【block】抛出的错误满足正则表达式，所以断言通过。

【注意！！】error 参数不能是字符串。 如果第二个参数是字符串，则视为省略 error 参数，传入的字符串会被用于 【message】 参数，

// 这是错误的！不要这么做！
assert.throws(myFunction, '错误信息', '没有抛出期望的信息');

// 应该这么做。
assert.throws(myFunction, /错误信息/, '没有抛出期望的信息');

下面代码，【error】 参数为自定义函数

assert.throws(
 () => {
  throw new Error('错误信息');
 },
 function (err) {
  if ((err instanceof Error) && /错误/.test(err)) {
   return true;
  }
 },
 '不是期望的错误'
);

7.4 assert.doesNotThrow(block, error, message)

【说明！！】预期的错误和实际的错误一致时，不抛出实际错误，抛出AssertionError，不一致则抛出实际错误信息

assert.doesNotThrow(
 () => {
 throw new TypeError('错误信息');
 },
 SyntaxError
);

以上例子会抛出 TypeError，因为在断言中没有匹配的错误类型

assert.doesNotThrow(
 () => {
 throw new TypeError('错误信息');
 },
 TypeError
);

以上例子会抛出一个带有 Got unwanted exception (TypeError).. 信息的 AssertionError

assert.doesNotThrow(
 () => {
 throw new TypeError('错误信息');
 },
 TypeError,
 '抛出错误'
);
// 抛出 AssertionError: Got unwanted exception (TypeError). 抛出错误

上面代码说明：如果抛出了 AssertionError 且有给 message 参数传值，则 message 参数的值会被附加到 AssertionError 的信息中

八. 判断值是否为真

这儿只有一个测试函数了

8.1 assert.ifError(value)

如果value的值为真或者可以转换成true，则抛出value，否则断言通过。

assert.ifError(true); 
//抛出true

assert.ifError(false);
//断言通过

上面代码中是直接给出的 布尔 类型的值，如果值为 true 则会将该值抛出，否则什么也不做

assert.ifError(0);
//断言通过

assert.ifError("0");
//抛出 "0"

assert.ifError(1);
//抛出 1

assert.ifError(new Error());
//抛出 Error,对象名称

上面代码中全部是通过 Boolean(value) 转换之后再进行的测试，利用这个特性我们可以将此测试函数用于测试回调函数的 error 参数。

相关推荐：

关于console.assert的3篇课程推荐

以上是node.js之斷言assert的使用範例分享的詳細內容。更多資訊請關注PHP中文網其他相關文章！

陳述：
本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn
上一篇：javascript實作網頁相容各種瀏覽器詳解下一篇：javascript實作網頁相容各種瀏覽器詳解

相關文章

看更多