NPM 使用介紹

NPM是隨同NodeJS一起安裝的包管理工具，能解決NodeJS代碼部署上的很多問題，常見的使用場景有以下幾種：

• 允許用戶從NPM服務器下載別人編寫的第三方包到本地使用。
• 允許用戶從NPM服務器下載並安裝別人編寫的命令行程序到本地使用。
• 允許用戶將自己編寫的包或命令行程序上傳到NPM服務器供別人使用。

由於新版的nodejs已經集成了npm，所以之前npm也一並安裝好了。同樣可以使用cmd命令行輸入"npm -v"來測試是否成功安裝。如下圖，出現版本提示表示安裝成功:

---

NPM 應用

NPM建立了一個NodeJS生態圈，NodeJS開發者和用戶可以在里邊互通有無。以下介紹NPM應用的三種場景：

下載第三方包

我們可以使用以下命令來下載第三方包。

$ npm install argv
...
argv@0.0.2 node_modules\argv

下載好之后，argv包就放在了工程目錄下的node_modules目錄中，因此在代碼中只需要通過require('argv')的方式就好，無需指定第三方包路徑。

以上命令默認下載最新版第三方包，如果想要下載指定版本的話，可以在包名后邊加上@<version>，例如通過以下命令可下載0.0.1版的argv。

$ npm install argv@0.0.1
...
argv@0.0.1 node_modules\argv

NPM對package.json的字段做了擴展，允許在其中申明第三方包依賴。因此，上邊例子中的package.json可以改寫如下：

{
    "name": "node-echo",
    "main": "./lib/echo.js",
    "dependencies": {
        "argv": "0.0.2"
    }
}

這樣處理后，在工程目錄下就可以使用npm install命令批量安裝第三方包了。

更重要的是，當以后node-echo也上傳到了NPM服務器，別人下載這個包時，NPM會根據包中申明的第三方包依賴自動下載進一步依賴的第三方包。

例如，使用npm install node-echo命令時，NPM會自動創建以下目錄結構。

- project/
    - node_modules/
        - node-echo/
            - node_modules/
                + argv/
            ...
    ...

如此一來，用戶只需關心自己直接使用的第三方包，不需要自己去解決所有包的依賴關系。

安裝命令行程序

從NPM服務上下載安裝一個命令行程序的方法與第三方包類似。

例如上例中的node-echo提供了命令行使用方式，只要node-echo自己配置好了相關的package.json字段，對於用戶而言，只需要使用以下命令安裝程序。

$ npm install node-echo -g

參數中的-g表示全局安裝，因此node-echo會默認安裝到以下位置，並且NPM會自動創建好Linux系統下需要的軟鏈文件或Windows系統下需要的.cmd文件。

- /usr/local/               # Linux系統下
    - lib/node_modules/
        + node-echo/
        ...
    - bin/
        node-echo
        ...
    ...

- %APPDATA%\npm\            # Windows系統下
    - node_modules\
        + node-echo\
        ...
    node-echo.cmd
    ...

發布代碼

第一次使用NPM發布代碼前需要注冊一個賬號。終端下運行npm adduser，之后按照提示做即可。

賬號注冊完成后，接着我們需要編輯package.json文件，加入NPM必需的字段。接着上邊node-echo的例子，package.json里必要的字段如下。

{
    "name": "node-echo",           # 包名，在NPM服務器上須要保持唯一
    "version": "1.0.0",            # 當前版本號
    "dependencies": {              # 第三方包依賴，需要指定包名和版本號
        "argv": "0.0.2"
      },
    "main": "./lib/echo.js",       # 入口模塊位置
    "bin" : {
        "node-echo": "./bin/node-echo"      # 命令行程序名和主模塊位置
    }
}

之后，我們就可以在package.json所在目錄下運行npm publish發布代碼了。

版本號

使用NPM下載和發布代碼時都會接觸到版本號。NPM使用語義版本號來管理代碼，這里簡單介紹一下。

語義版本號分為X.Y.Z三位，分別代表主版本號、次版本號和補丁版本號。當代碼變更時，版本號按以下原則更新。

• 如果只是修復bug，需要更新Z位。
• 如果是新增了功能，但是向下兼容，需要更新Y位。
• 如果有大變動，向下不兼容，需要更新X位。

版本號有了這個保證后，在申明第三方包依賴時，除了可依賴於一個固定版本號外，還可依賴於某個范圍的版本號。例如"argv": "0.0.x"表示依賴於0.0.x系列的最新版argv。

NPM支持的所有版本號范圍指定方式可以查看官方文檔。

---

NPM常用命令

除了本章介紹的部分外，NPM還提供了很多功能，package.json里也有很多其它有用的字段。

除了可以在npmjs.org/doc/查看官方文檔外，這里再介紹一些NPM常用命令。

NPM提供了很多命令，例如install和publish，使用npm help可查看所有命令。

• NPM提供了很多命令，例如install和publish，使用npm help可查看所有命令。

• 使用npm help <command>可查看某條命令的詳細幫助，例如npm help install。

• 在package.json所在目錄下使用npm install . -g可先在本地安裝當前命令行程序，可用於發布前的本地測試。

• 使用npm update <package>可以把當前目錄下node_modules子目錄里邊的對應模塊更新至最新版本。

• 使用npm update <package> -g可以把全局安裝的對應命令行程序更新至最新版。

• 使用npm cache clear可以清空NPM本地緩存，用於對付使用相同版本號發布新版本代碼的人。

• 使用npm unpublish <package>@<version>可以撤銷發布自己發布過的某個版本代碼。