JavaScript API开发的良好实践

Question

设计JavaScript API的好方法是什么？

我对JavaScript还比较陌生，我学习了该语言的关键好特性，主要来自于"JavaScript: good Parts“。目前，我正在设计一个基于网络的工具来教统计。代码库变得不灵活了，部分原因是我不知道如何设计JavaScript API。

我的背景是Java和C++，并习惯于设计接口，然后独立实现这些接口。显然，这在JavaScript中不太管用。

谢谢您的帮助和建议。

更新：工具的最终版本：http://www.lock5stat.com/statkey/index.html

Answer 1

在我看来，如果使用jQuery，最好的解决方案是将应用程序划分为jQuery插件和UI小部件。插件是组织代码的好方法，您可以在其他应用程序中重用它们，也可以单独发布它们。

你可以把你的应用程序写成一个插件树。您可以考虑一些插件，比如C++/Java中的类，它们具有聚合而不是继承。

关于代码的注释:在MAIN.bootstrapPlot函数中，您应该使用document.createElement，就像在代码的其余部分一样，您应该使用jQuery，并检查Canto图书馆中的画布。

Answer 2

John对NodeIterator API进行了严厉的批评。虽然是对一个特定API的回顾，但它提供了一些见解(至少他认为)是一个很好的工具。

Answer 3

我认为这与开发任何API都是一样的，而不管语言是什么，记住语言特性。

1. 正如您所指出的，接口在javascript中没有多大意义，但它是面向对象的，因此您可以将您的功能划分为“类”、使用设计模式等等。
2. 文档。您可以记录一个javascript 'class‘，就像您记录任何API一样。
3. 尽管js中没有对接口或抽象类的原生支持，但仍然可以强制执行这些原则。例如，您可以通过使用抛出错误的方法定义对象来创建“抽象类”，这样，如果子类没有正确实现，子类就会出错。任何使用接口的东西都可以做一个简单的检查，看看init上是否有必要的方法。请注意，有些js人会对此皱眉，指出js是松散类型和动态的，应该以这种方式使用。

请注意，我在引号中添加了“class”，因为javascript本身没有任何概念。您可以做的另一件事是查看现有的API，如Sencha或jQuery，以获得一些想法。Sencha感觉就像服务器端开发人员会习惯的API (看看他们的文档)。