JavaScript - 使用options objects构建函数

JavaScript - 使用options objects构建函数

在JavaScript语言中,options object 是一种常见的向一个函数传递参数的方式。这篇文章将会想你解释怎么使用它以及为什么使用它会提高你的代码的可读性。

本文翻译并改编Codereadability 上的一篇文章 - 查看原文

Options object 到底是个啥?

一个options object只是一个普通的Javascript对象,它包含了你要传递给某个函数的参数(key/value pairs)。

比如,jQuery.ajax函数就用了options object。这个函数最多可以接收34个参数,并且它们全都是可选的(非必须的)。

$.ajax({
    url: "http://date.jsontest.com/",
    success: function (data) {console.log(data);},
    cache: true,
    timeout: 500
});

如果不用options objects,将会使我们在理解每个参数的作用时变得非常困难。

$.ajax(
    "http://date.jsontest.com/",
    function (data) {console.log(data);},
    true,
    500
);

很多别的编程语言有一个特性叫做 "named arguments"(有名字的参数) 来达到和options objects相同的效果。

什么时候应该使用options objects呢?

当你写的某个函数有两个及以上参数时,你就应当考虑使用options object了。通常来说,在一个接收四个及以上参数的函数身上使用options object是一个好主意!

如果一个函数目前只需要一个参数,但将来会添加更多的参数,那么我建议你从一开始就使用option object而不是之后重写/重构代码。

决定了options objects比参数数组(argument list, 每个js函数都默认有一个arguments类数组对象,包含了传入这个函数的参数)好的最重要的原因是,options objects可以明确的表明每个参数的作用。比如,sum(4, 2)可以表明这个函数是干嘛的,而showDialog(true, false)不行。

Options objects是一个未被充分利用的JavaScript的一个特性,所以多多使用它并无坏处。

写一个使用options object来传递参数的函数

下面是一个传统的写js函数的方法,单独地传递每个参数。

function showDialog (showAlertIcon, showBackdrop) {
    if (showAlertIcon) {
        alertIcon.show();
    }
    if (showDarkBackdrop) {
        backdrop.show();
    }
    dialog.show();
}

这行代码是你将如何调用它:

showDialog(true, false);

上面这行调用方式并不能明确的表明每个参数的作用。相反,使用options object可以很好地解决这个问题。

function showDialog (options) {
    if (options.showAlertIcon) {
        alertIcon.show();
    }
    if (options.showDarkBackdrop) {
        backdrop.show();
    }
    dialog.show();
}

现在,showDialog这个函数被调用时,将会传入一个对象,对象里包含了每个key/value参数:

showDialog({
    showAlertIcon: true,
    showDarkBackdrop: false
});

通过这种方式,我们可以很明显的看出来这两个参数的作用,再也不用在每次调用时为了理解并正确使用这个函数,去看函数定义或源码了,简洁高效。

设置默认值

(原文里介绍了使用一个叫underscore的js库来设定默认值,我在这里不做推荐,因为如果只是为了这一个功能来引入一个库,得不偿失。相反,使用ES6的新语法可以完美解决。说句题外话,如果你还未听说或接触过ES6,也就是ECMAScript2015,那应该去做一些了解并使用起来了!)

ES6语法里的参数默认值,类似于C++里的参数缺省值的用法。

还以上面的showDialog函数为例:

function showDialog (
  options = {
    showAlertIcon = true,
    showDarkBackdrop = false
  }
) {
    if (options.showAlertIcon) {
        alertIcon.show();
    }
    if (options.showDarkBackdrop) {
        backdrop.show();
    }
    dialog.show();
}

上述的这种写法就给options里的参数设置了默认值,当函数被调用并且没有参数传入时,showAlertIcon为true,showDarkBackdrop为false。

这样定义函数的话,下面这两种调用函数的方式达到的效果是一样的:

/* 这两行的作用是一样的,所以为何不使用第一行这种呢? */
showDialog({ showDarkBackdrop: true }); 
showDialog({ showAlertIcon: true, showDarkBackdrop: true });

总结

总之啊,options object 是一个很好的特性,特别是在参数较多的时候(参考jQuery.ajax),可以提高你的开发效率,降低出bug的几率,赶紧用起来吧!

PS: 如果文章里出现了错误或不当之处,请在下方评论给我留言,谢谢!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • 原文: https://github.com/ecomfe/spec/blob/master/javascript...
    zock阅读 3,370评论 2 36
  • https://nodejs.org/api/documentation.html 工具模块 Assert 测试 ...
    KeKeMars阅读 6,305评论 0 6
  • 完成图 总结:画不出水晶的感觉 形状还可以 朋友看过后感觉看不出是熊的样子。
    星空画语阅读 176评论 0 0
  • 王小丫从小和外婆们一起生活,十岁的时候,爸妈把她接回了家,她对这个家很陌生,对爸妈也很陌生,但乐于接受现实...
    潺潺湲湲阅读 972评论 0 1