首頁  >  文章  >  web前端  >  Node.js的套件詳細介紹_node.js

Node.js的套件詳細介紹_node.js

WBOY
WBOY原創
2016-05-16 16:20:031231瀏覽

在Node.js語言中,套件和模組並沒有本質的不同,包是在模組的基礎上更深一步的抽象,包將某個獨立的功能封裝起來,用於發布、更新、依賴管理和進行版本控制。 Node.js根據CommonJS規格實作了套件機制,開發了npm來解決套件的發布和取得需求。

Node.js的套件是一個目錄,其中包含JSON格式的套件說明檔package.json。 Node.js的套件基本上遵循CommonJS規範,因此具備以下特質:

CommonJS規範定義的套件特性:

1)頂層目錄包含package.json檔案;
2)bin目錄存放二進位檔案;
3)lib目錄存放JavaScript檔案;
4)doc目錄存放文件;
5)test目錄存放單元測試。

Node.js的模組與文件是一一對應的,文件不僅可以是JavaScript源碼文件或二進位文件,還可以是目錄。最簡單的包,就是一個目錄的模組。

Node.js的套件通常是一些模組的集合,在模組的基礎上提供了更高層的抽象,相當於提供了一些固定介面的函數庫。
透過客製化package.json,我們可以創建更複雜、更完善、更符合規範的套件用於發布。

Node.js在呼叫套件時,首先會檢查套件中的package.json檔案的main字段,將其作為套件的介面模組,如果package.json檔案的main字段不存在,那麼Node.js會嘗試尋找index.js或index.node作為包的介面。

package.json文件是CommonJS規格用於描述套件的文件,完全符合規範的package.json文件應該包含以下欄位:
1)name:包名。包名是唯一的,由小寫字母、數字和底線組成,不能含空格。
2)description:包說明。對包進行簡要描述。
3)version:版本號。滿足《語意化版本辨識》規範的版本字串。
4)keywords:關鍵字數組,通常用於搜尋。
5)maintainers:維護者陣列。每個元素包含name、email(可選)、web(可選)欄位。
6)contributors:貢獻者陣列。格式與maintainer陣列相同。包作者應該是貢獻者陣列的第一個元素。
7)bugs:提交bug的地址,可以是網址或電子郵件地址。
8)licenses:許可證數組。每個元素要包含type(許可證名稱)和url(連結到許可證文字的位址)欄位。
9)repositories:倉庫託管位址陣列。每個元素要包含type(倉庫的類型,如Git)、url(倉庫位址)和path(相對於倉庫的路徑,可選)欄位。
10)dependencies:套件依賴。是一個關聯數組,由包名和版本號組成。

註:《語意化版本辨識》規範是國外提出的一套版本命名規範,最初目的是解決各種各樣的版本號大小比較的問題,目前被許多套件管理系統所採用。

下面是一個完全符合CommonJS規範的package.json範例:

複製程式碼 程式碼如下:

{  
  “名稱”:“測試包”,
  "description": "我的 CommonJS 包。", 
  “版本”:“0.1.0”,
  “關鍵字”:[ 
     “測試包”,
     “liq”
  ],  
  「維修者」:[ 
     { 
        “名稱”:“liq”,
        “電子郵件”:“liq@hotmail.com”,
     } 
  ], 
  「貢獻者」:[ 
     { 
        “名稱”:“liq”,
        "web": "http://blog.csdn.net/chszs" 
     } 
  ], 
  「錯誤」:{ 
     “郵件”:“liq@hotmail.com”,
     "web": "http://blog.csdn.net/chszs" 
  }, 
  「許可證」:[ 
     { 
        “type”:"Apache 許可證 v2”,
        「url」:「http://www.apache.org/licenses/apache2.html」
     } 
  ], 
  「儲存庫」:[ 
     { 
        “類型”:“git”,
        "url": "http://github.com/chszs/packagetest.git" 
     } 
  ], 
  「依賴項」:{  
     “webkit”:"1.2”,
     「ssl」:{  
        “gnutls”:[“1.0”,”2.0”],
        「openssl」:「0.9.8」
     } 
  } 
}
陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn