快捷導(dǎo)航

NodeJS 模塊開(kāi)發(fā)及發(fā)布詳解分享

更新時(shí)間：2012年03月07日 07:58:33 作者：

NodeJS 是一門(mén)年輕的語(yǔ)言，擴(kuò)展模塊并不太全，經(jīng)常我們想用某個(gè)模塊但是卻找不到合適的

比如前兩天我需要使用hmac和sha1來(lái)做簽名，就沒(méi)有找到一個(gè)比較好用的模塊，這時(shí)候就需要我們自己來(lái)實(shí)現(xiàn)相應(yīng)的功能了。自己寫(xiě)完之后，再把它打包成一個(gè)模塊分享給大家來(lái)用，即方便了其他人，又能讓自己有點(diǎn)小小的成就感，實(shí)在是一件一舉多得的好事情。接下來(lái)，我就為大家介紹一下如何封裝一個(gè)NodeJS模塊并把它分享給其他人。

NPM (Node Package Manager, http://npmjs.org ) 是 NodeJS 的模塊管理軟件，除 NodeJS 內(nèi)置的核心模塊外，其他模塊的安裝、卸載等管理操作都要通過(guò) NPM 來(lái)進(jìn)行，我們自己寫(xiě)的模塊，就要發(fā)布到NPM上來(lái)供其他人使用。

接下來(lái)，我們做一個(gè)非常簡(jiǎn)單的模塊 “hello”，這個(gè)模塊的功能只有一個(gè)：提供一個(gè)參數(shù) “name” ，它在控制臺(tái)輸出 “Hello name”。在開(kāi)始之前，我們首先要把node和npm裝好，安裝方法在其官方網(wǎng)站都有介紹，這里就不再多說(shuō)了。

首先，我們創(chuàng)建一個(gè)名為”hello”的目錄，作為模塊的主目錄。進(jìn)入該目錄，開(kāi)始我們的工作。

然后，寫(xiě)模塊的核心代碼，很簡(jiǎn)單，只有以下三行：

復(fù)制代碼代碼如下:

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

把它保存為 hello.js。

NodeJS每個(gè)擴(kuò)展模塊中都有一個(gè)package.json文件，用來(lái)描述模塊的一些基本屬性，比如模塊名稱(chēng)、作者、版本號(hào)等等。關(guān)于package.json寫(xiě)法的詳細(xì)說(shuō)明，可以使用 “npm help json” 命令來(lái)查看。

我們可以在模塊主目錄下執(zhí)行 npm init 來(lái)生成一個(gè)最基本的package.json。按照命令的提示依次輸入信息即可。以下是在 hello 目錄下執(zhí)行 npm init 并填入相關(guān)信息后的結(jié)果：

復(fù)制代碼代碼如下:

 
$ npm init 
Package name: (hello) //模塊名字，npm init會(huì)自動(dòng)取當(dāng)前目錄名作為默認(rèn)名字，這里不需要改，直接確認(rèn)即可 
Description: A example for write a module //模塊說(shuō)明 
Package version: (0.0.0) 0.0.1 //模塊版本號(hào)，這個(gè)大家按自己習(xí)慣來(lái)定就可以 
Project homepage: (none) //模塊的主頁(yè)，如果有的話(huà)可以填在這里，也可以不填 
Project git repository: (none) //模塊的git倉(cāng)庫(kù)，選填。npm的用戶(hù)一般都使用github做為自己的git倉(cāng)庫(kù) 
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) //測(cè)試腳本，選填 
What versions of node does it run on? (~v0.5.7) * //依賴(lài)的node版本號(hào)，我們這個(gè)腳本可以運(yùn)行在任何版本的node上，因此填 * 
About to write to /home/elmer/hello/package.json 
// 以下是生成的package.json文件內(nèi)容預(yù)覽 
{ 
"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) //對(duì)以上內(nèi)容確認(rèn)無(wú)誤后，就可以直接回車(chē)確認(rèn)了 

到此為止，我們這個(gè)模塊就寫(xiě)完了。這時(shí)hello目錄下應(yīng)該有兩個(gè)文件：hello.js和package.json。

我們可以返回到hello的上級(jí)目錄，來(lái)測(cè)試安裝一下這個(gè)模塊：

復(fù)制代碼代碼如下:

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

顯示安裝成功。簡(jiǎn)單的測(cè)試一下：

復(fù)制代碼代碼如下:

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

Hello world正確輸出了”Hello world”。

接下來(lái)我們把它發(fā)布到NPM上。

首先，我們需要有一個(gè)NPM帳號(hào)，可以使用npm adduser來(lái)注冊(cè)一個(gè)：

復(fù)制代碼代碼如下:

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

簡(jiǎn)單三步，一個(gè)NPM用戶(hù)注冊(cè)成功。

最后回到 hello 根目錄，執(zhí)行一下npm publish，如果沒(méi)有任何錯(cuò)誤提示，那么就發(fā)布成功了。去 http://search.npmjs.org/上看一下吧，你的模塊應(yīng)該已經(jīng)顯示在”Latest Updates”一欄里了。

至此，一個(gè)NodeJS模塊成功發(fā)布到NPM，以后就可以在任何能訪(fǎng)問(wèn)npm庫(kù)的地方通過(guò)npm install來(lái)安裝你的模塊了。

您可能感興趣的文章: