Node.js 模块开发与发布完整指南

Node.js 模块开发与发布概述

例如，当需要利用 hmac 和 sha1 算法进行签名时，若未找到合适的现有模块，则需自行实现相关功能。完成开发后，将其封装为模块并发布，既能方便他人使用，也能带来成就感，可谓一举多得。下文将介绍封装 Node.js 模块并分享给社区的具体步骤。

NPM（Node Package Manager，官网 http://npmjs.org）是 Node.js 的包管理工具。除 Node.js 内置的核心模块外，其他模块的安装、卸载等管理操作均需通过 NPM 进行。因此，自行开发的模块需发布至 NPM 平台，以便他人获取使用。

接下来，我们将构建一个名为“hello”的简单模块，其功能仅为接收参数“name”，并在控制台输出“Hello name”。在动手之前，请确保已安装 Node.js 和 NPM，具体安装方法可参考官方网站文档，此处不再赘述。

创建模块目录与核心代码

首先，创建一个名为“hello”的目录作为模块的主目录，并进入该目录开始后续工作。

接着编写模块的核心代码，逻辑非常简单，仅包含以下三行内容：

 
exports.Hello = function ( name ) {
console.log( "Hello " + name );
} 

将上述代码保存为 hello.js 文件。

配置 package.json 文件

每个 Node.js 扩展模块都包含一个 package.json 文件，用于描述模块的基本属性，如模块名称、作者、版本号等。关于 package.json 的具体写法，可执行“npm help json”命令查看详细文档。

在模块主目录下执行 npm init 命令，即可生成基础的 package.json 文件。根据提示依次填写相关信息即可。以下展示了在 hello 目录下执行 npm init 并填入信息后的结果：

 
$ npm init
Package name: (hello) //模块名字，npm init会自动取当前目录名作为默认名字，这里不需要改，直接确认即可
Description: A example for write a module //模块说明
Package version: (0.0.0) 0.0.1 //模块版本号，这个大家按自己习惯来定就可以
Project homepage: (none) //模块的主页，如果有的话可以填在这里，也可以不填
Project git repository: (none) //模块的git仓库，选填。npm的用户一般都使用github做为自己的git仓库
Author name: Elmer Zhang //模块作者名字
Author email: (none) freeboy6716@gmail.com //模块作者邮箱
Author url: (none) http://www.elmerzhang.com //模块作者URL
Main module/entry point: (none) hello.js //模块的入口文件，我们这里是hello.js
Test command: (none) //测试脚本，选填
What versions of node does it run on? (~v0.5.7) * //依赖的node版本号，我们这个脚本可以运行在任何版本的node上，因此填 *
About to write to /home/elmer/hello/package.json
// 以下是生成的package.json文件内容预览
{ 
"author": "Elmer Zhang <freeboy6716@gmail.com> (http://www.elmerzhang.com)",
"name": "hello",
"description": "A example for write a module",
"version": "0.0.1",
"repository": {
"url": ""
}, 
"main": "hello.js",
"engines": {
"node": "*"
}, 
"dependencies": {},
"devDependencies": {}
} 
Is this ok? (yes) //对以上内容确认无误后，就可以直接回车确认了

至此，模块编写完成。此时 hello 目录下应包含两个文件：hello.js 和 package.json。

本地测试与安装验证

我们可以返回到 hello 目录的上级目录，以测试该模块的安装：

 
$ npm install hello/
hello@0.0.1 ./node_modules/hello

上述输出显示安装成功。接下来进行简单测试：

 
$ node
> var Hello = require('hello').Hello;
> Hello('world');

控制台正确输出了“Hello world”。

注册账号与发布至 NPM

接下来，我们将模块发布到 NPM 仓库。

首先，需要拥有一个 NPM 账号，可通过执行 npm adduser 命令进行注册：

 
$ npm adduser
Username: elmerzhang
Password:
Email: freeboy6716@gmail.com

经过简单三步，NPM 用户注册成功。

最后回到 hello 根目录，执行 npm publish 命令。若无错误提示，则发布成功。访问 http://search.npmjs.org/ 查看，你的模块应已显示在“Latest Updates”列表中。

至此，Node.js 模块已成功发布至 NPM。此后，在任何能访问 npm 库的环境中，均可通过 npm install 命令安装并使用你的模块。