NodeJS 模組開發及發布詳解分享

2021-07-06 09:09:08 字數 2584 閱讀 9540

比如前兩天我需要使用hmac和sha1來做簽名,就沒有找到乙個比較好用的模組,這時候就需要我們自己來實現相應的功能了。自己寫完之後,再把它打包成乙個模組分享給大家來用,即方便了其他人,又能讓自己有點小小的成就感,實在是一件一舉多得的好事情。接下來,我就為大家介紹一下如何封裝乙個nodejs模組並把它分享給其他人。 

npm (node package manager, ) 是 nodejs 的模組管理軟體,除 nodejs 內建的核心模組外,其他模組的安裝、解除安裝等管理操作都要通過 npm 來進行,我們自己寫的模組,就要發布到npm上來供其他人使用。 

接下來,我們做乙個非常簡單的模組 「hello」,這個模組的功能只有乙個:提供乙個引數 「name」 ,它在控制台輸出 「hello name」。在開始之前,我們首先要把node和npm裝好,安裝方法在其官方**都有介紹,這裡就不再多說了。 

首先,我們建立乙個名為」hello」的目錄,作為模組的主目錄。進入該目錄,開始我們的工作。 

然後,寫模組的核心**,很簡單,只有以下三行: 

複製**

**如下:

exports.hello = function ( name )  

把它儲存為 hello.js。 

nodejs每個擴充套件模組中都有乙個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) [email protected] //模組作者郵箱 

author url: (none) //模組作者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檔案內容預覽  , 

"main": "hello.js", 

"engines": , 

"dependencies": {}, 

"devdependencies": {}  } 

is this ok? (yes) //對以上內容確認無誤後,就可以直接回車確認了 

到此為止,我們這個模組就寫完了。這時hello目錄下應該有兩個檔案:hello.js和package.json。 

我們可以返回到hello的上級目錄,來測試安裝一下這個模組: 

複製**

**如下:

$ npm install hello/ 

[email protected] ./node_modules/hello 

顯示安裝成功。簡單的測試一下: 

複製**

**如下:

$ node 

> var hello = require('hello').hello; 

> hello('world'); 

hello world正確輸出了」hello world」。 

接下來我們把它發布到npm上。 

首先,我們需要有乙個npm帳號,可以使用npm adduser來註冊乙個: 

複製**

**如下:

$ npm adduser 

username: elmerzhang 

password: 

email: [email protected] 

簡單三步,乙個npm使用者註冊成功。 

最後回到 hello 根目錄,執行一下npm publish,如果沒有任何錯誤提示,那麼就發布成功了。去 上看一下吧,你的模組應該已經顯示在」latest updates」一欄裡了。 

至此,乙個nodejs模組成功發布到npm,以後就可以在任何能訪問npm庫的地方通過npm install來安裝你的模組了。

nodejs發布模組

nodejs安裝目錄 d soft nodejs 新建js檔案 例如 helloworld.js console.log hello world 1.建立乙個新的模組 d soft nodejs npm init生成乙個新的package.json 註冊所繫結的賬號 npm adduser 3.上傳...

NodeJs開發高階 發布自定義模組到NPM

注 最好不要用qq郵箱,不然可能會接收不到驗證郵件,實測谷歌郵箱是可以的 module.exports sub function a,b files index.js keywords author my name license isc npm initnpm loginnpm publish注 ...

NodeJS開發c 擴充套件模組

建立測試模組 facerecognition.cpp include using v8 functioncallbackinfo using v8 isolate using v8 local using v8 object using v8 string using v8 value void c...