DIV CSS 佈局教程網

Node.js 的套件(Package)機制與 package.json 解析
編輯:關於JavaScript     

在 Node.js 中,套件(package)與模組(module)並沒有本質差異——套件是在模組基礎上更進一步的抽象:它把某個獨立功能封裝起來,用於發布、更新、依賴管理與版本控制。Node.js 依 CommonJS 規範實作了套件機制,並開發了 npm 來滿足套件發布與取得的兩端需求。

套件的目錄結構

Node.js 的套件本質上是一個目錄,其中包含 JSON 格式的套件說明檔 package.json。由於基本遵循 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 欄位,把它作為套件的介面模組;若 main 不存在,則會嘗試尋找 index.js 或 index.node 作為介面。

package.json 的欄位

完全符合規範的 package.json 應包含以下欄位:

  1. name:套件名稱。必須唯一,由小寫字母、數字與底線組成,不能含空格。
  2. description:套件說明,簡要描述用途。
  3. version:版本號,需符合《語義化版本識別》規範的版本字串。
  4. keywords:關鍵字陣列,通常用於搜尋。
  5. maintainers:維護者陣列,每個元素包含 name、email(選填)、web(選填)。
  6. contributors:貢獻者陣列,格式同上。套件作者應是貢獻者陣列的第一個元素。
  7. bugs:提交 bug 的位址,可以是網址或電郵。
  8. licenses:許可證陣列,每個元素需含 type(許可證名稱)與 url(許可證文字連結)。
  9. repositories:倉庫托管位址陣列,每個元素需含 type(如 git)、url,以及 path(相對於倉庫的路徑,選填)。
  10. dependencies:套件依賴,是一個由套件名稱與版本號組成的關聯陣列。

補充:《語義化版本識別》(Semantic Versioning)是一套國外提出的版本命名規範,最初目的是解決形形色色版本號大小比較的問題,目前已被許多套件管理系統採用。格式為 主版本.次版本.修訂版本。

完整範例

{
  "name": "testpackage",
  "description": "My package for CommonJS.",
  "version": "0.1.0",
  "keywords": [
      "testpackage",
      "liq"
  ],
  "maintainers": [
      {
          "name": "liq",
          "email": "liq@hotmail.com"
      }
  ],
  "contributors": [
      {
          "name": "liq",
          "web": "https://blog.csdn.net/chszs"
      }
  ],
  "bugs": {
      "mail": "liq@hotmail.com",
      "web": "https://blog.csdn.net/chszs"
  },
  "licenses": [
      {
          "type": "Apache License v2",
          "url": "https://www.apache.org/licenses/apache2.html"
      }
  ],
  "repositories": [
      {
          "type": "git",
          "url": "https://github.com/chszs/packagetest.git"
      }
  ],
  "dependencies": {
      "webkit": "1.2",
      "ssl": {
          "gnutls": ["1.0", "2.0"],
          "openssl": "0.9.8"
      }
  }
}

現代 npm 的補充

值得留意的是,npm 在實務上演進後有幾個欄位變得更常用,可一併納入:

  • main / module / exports:決定套件入口,exports 是目前最靈活的方案。
  • scripts:定義 test、build、start 等指令捷徑。
  • devDependencies:僅開發與建置時需要的依賴,不會安裝給使用者。
  • peerDependencies:宣告「需由宿主專案提供」的依賴,常見於外掛與函式庫。
  • engines:限定可執行的 Node 版本範圍。
  • bin:對應 CommonJS 規範的 bin 目錄概念,讓套件能註冊成命令列工具。
  • files 與 .npmignore:控制發布時實際打包的內容。

而 author、contributors、licenses(單數 license 亦支援)等欄位,npm 也提供了 npm init 互動式精靈來輔助填寫,不必手寫全部內容。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved