No.56、避免不必要的状态
Tips:
无状态的API简洁,更容易学习和使用,也不需要考虑其他的状态。如:
'test'.toUpperCase(); // 'TEST'
有状态的API往往会导致额外的声明,并增加复杂度。
Tips:
直接上代码:
function Wiki(format){ this.format = format; } Wiki.prototype.show = function(source){ var page = this.format(source); return { title: page.getTitle(), author: page.getAuthor(), content: page.getContent() } }
将format设计为结构类型,可以极大的增加设计的灵活性。
Tips:
API绝不应该重载与其他类型有重叠的类型
最简单的判断数组与类数组,代码如下:
x instanceof Array
但是,在一些允许多个全局对象的环境中可能会有标准的Array构造函数和原型对象的多份副本。那么就有可能导致以上的测试结果不可信,所以在ES5引入了Array.isArray函数来判断是否是Array对象,通过检查对象内部[[Class]]属性值是否为Array来判定。在不支持ES5的环境中,可以使用标准的Object.prototype.toString方法测试一个对象是否为数组。
function isArray(x){ return toString.call(x) === '[object Array]'; }
Tips:
看以下的函数:
function square(x){ return x*x; } console.log(square('3')); // 9
强制转换无疑是很方便的。但很多时候却会导致含糊不清。
function fun(x){ x = Number(x); if(typeof x === 'number'){ return x-1; }else{ return x; } }
由于进行了Number(x),那么后面的else是无法执行到的。如果不知道这个函数的细节,那么使用该函数则具有一定的模糊性。 事实上,如果我们要更小心的设计API,我们可以强制只接受数字和对象。
function fun(x){ if(typeof x === 'number'){ return x-1; }else if(typeof x === 'object' && x){ return x; }else{ throw new TypeError('expected number or array-like.'); } }
这种风格更加谨慎的示例,被称为防御性编程。
Tips:
无状态的API部分能力是讲复杂操作分解为更小的操作。如replace:
function escapeHtml(str){ return str.replace(/&/g, '&') .replace(/</g, '<'); }
如果不采用方法链方式,代码应该是以下这样:
function escapeHtml(str){ var str1 = str.replace(/&/g, '&'); var str2 = str1.replace(/</g, '<'); return str2; }
同样的功能,将会产生多个临时变量。消除临时变量使得代码更加可读,中间结果只是得到最终结果中的一个重要步骤而已。
在有状态的API中设置方法链也是可行的。技巧是方法在更新对象时返回this,而不是undefined。如:
element.setBackgroundColor('gray') .setColor('red') .setFontweight('bold');