网+线下沙龙 | 移动APP模式创新:给你一个做APP的理由>>好的 API 设计:在自描述的同时,达到抽象的目标。设计良好的 API ,开发者可以快速上手,没必要经常抱着手册和文档,也没必要频繁光顾技术支持社区。流畅的接口方法链:流畅易读,更易理解//常见的 A ...
网+线下沙龙 | 移动APP模式创新:给你一个做APP的理由>>
好的 API 设计:在自描述的同时,达到抽象的目标。
设计良好的 API ,开发者可以快速上手,没必要经常抱着手册和文档,也没必要频繁光顾技术支持社区。
流畅的接口
方法链:流畅易读,更易理解
- //常见的 API 调用方式:改变一些颜色,添加事件监听
- var elem = document.getElementById("foobar");
- elem.style.background = "red";
- elem.style.color = "green";
- elem.addEventListener('click', function(event) {
- alert("hello world!");
- }, true);
-
- //(设想的)方法链 API
- DOMHelper.getElementById('foobar')
- .setStyle("background", "red")
- .setStyle("color", "green")
- .addEvent("click", function(event) {
- alert("hello world");
- });
设置和获取操作,可以合二为一;方法越多,文档可能越难写
- var $elem = jQuery("#foobar");
-
- //setter
- $elem.setCss("background", "green");
- //getter
- $elem.getCss("color") === "red";
-
- //getter, setter 合二为一
- $elem.css("background", "green");
- $elem.css("color") === "red";
一致性
相关的接口保持一致的风格,一整套 API 如果传递一种熟悉和舒适的感觉,会大大减轻开发者对新工具的适应性。
命名这点事:既要短,又要自描述,最重要的是保持一致性
“There are only two hard problems in computer science: cache-invalidation and naming things.”
原标题:JavaScript API 设计原则
关键词:JavaScript
*特别声明:以上内容来自于网络收集,著作权属原作者所有,如有侵权,请联系我们:
admin#shaoqun.com
(#换成@)。