你的位置:首页 > 软件开发 > 网页设计 > JavaScript API 设计原则

JavaScript API 设计原则

发布时间:2016-04-27 22:00:06
网+线下沙龙 | 移动APP模式创新:给你一个做APP的理由>>好的 API 设计:在自描述的同时,达到抽象的目标。设计良好的 API ,开发者可以快速上手,没必要经常抱着手册和文档,也没必要频繁光顾技术支持社区。流畅的接口方法链:流畅易读,更易理解//常见的 A ...

网+线下沙龙 | 移动APP模式创新:给你一个做APP的理由>>

JavaScript API 设计原则

好的 API 设计:在自描述的同时,达到抽象的目标。

设计良好的 API ,开发者可以快速上手,没必要经常抱着手册和文档,也没必要频繁光顾技术支持社区。

流畅的接口

方法链:流畅易读,更易理解

  1. //常见的 API 调用方式:改变一些颜色,添加事件监听 
  2. var elem = document.getElementById("foobar"); 
  3. elem.style.background = "red"; 
  4. elem.style.color = "green"; 
  5. elem.addEventListener('click', function(event) { 
  6.   alert("hello world!"); 
  7. }, true); 
  8.  
  9. //(设想的)方法链 API 
  10. DOMHelper.getElementById('foobar') 
  11.   .setStyle("background", "red") 
  12.   .setStyle("color", "green") 
  13.   .addEvent("click", function(event) { 
  14.     alert("hello world"); 
  15.   }); 

设置和获取操作,可以合二为一;方法越多,文档可能越难写

  1. var $elem = jQuery("#foobar"); 
  2.  
  3. //setter 
  4. $elem.setCss("background", "green"); 
  5. //getter 
  6. $elem.getCss("color") === "red"; 
  7.  
  8. //getter, setter 合二为一 
  9. $elem.css("background", "green"); 
  10. $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 (#换成@)。