由于javascript
开始被设计成一种辅助网页进行状态改变、交互验证等边缘功能的语言,因此很多时候大家不会将它与模式这种典型的软件解决方法关联,但随着JS语言自身的发展和运行环境的改变(Server Side JavaScript by Nodejs),模式以及语言惯用法在JS中也逐渐被强调出来。
本主题先借着openlayers ol.map
介绍一个JS惯用法——选项模式。
通过 ol.Map
的在线文档我们可以看到Map
对象在5x版本中已经只剩下一个参数了,Map(options)
,options
中有很多可选的参数, 回顾一下历史openlayers Map
在2x版本中Map
对象的构造函数是这样的 OpenLayers.Map(div,options)
。其实在openlayers3,Map就已经去掉了div必选参数,作为options选项的一个可选参数 target
,如果在构造期间没有设置,还可通过setTarget
方法设置在页面中显示的位置。
上面介绍的openlayers Map
对象构造函数其实就是一种JS中非常常见的惯用法——选项模式。通常一个有着很多参数的方法对二次开发用户十分不友好,用户需要记住参数的意义与顺序,这对于没有静态类型检查的JS代码来说简直就是灾难。人的短时记忆通常都超不过7个,因此一个超过7个参数(稳妥点5个参数)的方法有可能需要查看几次方法的说明才能正确调用该方法。而作为一种面向原型的语言,JS语言提供了对象object {}
,在对象中我们可以存储多个 key
及对应的value
,在获取相应值时我们可以使用 obj.key
或 obj[key]
,而且可以判断一个对象中是否拥有某个值,这就为我们传递参数带来了便利:
- 我们可以基于名称初始化参数,而无需要考虑参数的顺序(方法内部是基于key获取值的),增加代码的可读性;
- 用户可以无视他不关心的参数(在创建ol.Map对象时如果没有覆盖层,直接无视
options
中的overlays
选项); - 我们可以在不改变接口的情况下为方法增加新的控制参数。
想象一下如果Map对象参数如果不使用options选项参数对象,那么创建一个Map对象的参数将会有Map(controls,pixelRatio,interactions,keyboardEventTarget,layers,maxTilesLoading,loadTilesWhileAnimating,loadTilesWhileInteracting,moveTolerance,overlays,target,view)
12个之多,我们还要记住参数的传递次序,如果不想设置的参数不在方法的末尾,我们还要依次给填上 null
或者undefine
(同样的情况,在C++中一般是把选填的参数放在后面,并为其置上默认值,如果希望设置最后一个可选参数,则中间那些给出的默认值都要粘贴一遍,而且可怕的是C++中没有语言一级的 选项对象
支持来解救 小猿们 orz,在这里为JS窃喜吧:-) )。
伤害
不要只看贼吃肉,也要看到贼挨揍。选项参数带来便利的同时如果不能正确使用,也会给接口带来很大伤害。选项参数的组合爆炸(设置了选项A,则需要同时设置选项B...,不详细的接口文档,很有可能造成用户错误传递必要的选项参数),此时最好的方法就是将必填参数从options中分裂出来形成新的方法。
原则
在options 选项参数对象中仅放置 可选和互不相关的参数,openlayers 2x --> 3x 中 Map
构造函数参数的变化就体现了这一点,target:div
不再是对象构造时的必须参数。