Node.js入门:包结构

    JavaScript缺少包结构。CommonJS致力于改变这种现状,于是定义了包的结构规范(http://wiki.commonjs.org/wiki/Packages/1.0 )。而NPM的出现则是为了在CommonJS规范的基础上,实现解决包的安装卸载,依赖管理,版本管理等问题。require的查找机制明了之后,我们来看一下包的细节。
    一个符合CommonJS规范的包应该是如下这种结构:
  • 一个package.json文件应该存在于包顶级目录下 
  • 二进制文件应该包含在bin目录下。 
  • JavaScript代码应该包含在lib目录下。 
  • 文档应该在doc目录下。 
  • 单元测试应该在test目录下。
    Node.js在没有找到目标文件时,会将当前目录当作一个包来尝试加载,所以在package.json文件中最重要的一个字段就是main。而实际上,这一处是Node.js的扩展,标准定义中并不包含此字段,对于require,只需要main属性即可。但是在除此之外包需要接受安装、卸载、依赖管理,版本管理等流程,所以CommonJS为package.json文件定义了如下一些必须的字段:
  • name:包名,需要在NPM上是唯一的。不能带有空格。 
  • description:包简介。通常会显示在一些列表中。 
  • version:版本号。一个语义化的版本号(http://semver.org/ ),通常为x.y.z。该版本号十分重要,常常用于一些版本控制的场合。 
  • keywords:关键字数组。用于NPM中的分类搜索。 
  • maintainers:包维护者的数组。数组元素是一个包含name、email、web三个属性的JSON对象。 
  • contributors:包贡献者的数组。第一个就是包的作者本人。在开源社区,如果提交的patch被merge进master分支的话,就应当加上这个贡献patch的人。格式包含name和email。
  • bugs:一个可以提交bug的URL地址。可以是邮件地址(mailto:mailxx@domain),也可以是网页地址(http://url)。 
  • licenses:包所使用的许可证。
  • repositories:托管源代码的地址数组。 
  • dependencies:当前包需要的依赖。这个属性十分重要,NPM会通过这个属性,帮你自动加载依赖的包。
    以下是Express框架的package.json文件,值得参考。
1 "name": "express", 
2 "description": "Sinatra inspired web development framework", 
3 "version": "3.0.0alpha1-pre", 
4 "author": "TJ Holowaychuk",

    除了前面提到的几个必选字段外,我们还发现了一些额外的字段,如bin、scripts、engines、devDependencies、author。这里可以重点提及一下scripts字段。包管理器(NPM)在对包进行安装或者卸载的时候需要进行一些编译或者清除的工作,scripts字段的对象指明了在进行操作时运行哪个文件,或者执行拿条命令。如下为一个较全面的scripts案例:

1 "scripts": { 
2     "install": "install.js", 
3     "uninstall": "uninstall.js", 
4     "build": "build.js", 
5     "doc": "make-doc.js", 
6     "test": "test.js", 
7 }

    如果你完善了自己的JavaScript库,使之实现了CommonJS的包规范,那么你可以通过NPM来发布自己的包。

npm publish <folder>
    命令十分简单。但是在这之前你需要通过npm adduser命令在NPM上注册一个帐户,以便后续包的维护。NPM会分析该文件夹下的package.json文件,然后上传目录到NPM的站点上。
    用户在使用你的包时,也十分简明:
npm install <package>
    甚至对于NPM无法安装的包(因为某些奇怪的网络原因),可以通过github手动下载其稳定版本,解压之后通过以下命令进行安装:
npm install <package.json folder>
    只需将路径指向package.json存在的目录即可。然后在代码中require('package')即可使用。
    Node.js中的require内部流程之复杂,而方法调用之简单,实在值得叹为观止。
posted @ 2014-05-18 18:14 M守护神 阅读(...) 评论(...) 编辑 收藏