OpenSCA技術(shù)原理npm依賴示例解析

更新時(shí)間：2023年02月17日 11:35:51 作者：OpenSCA社區(qū)

這篇文章主要為大家介紹了OpenSCA技術(shù)原理npm依賴示例解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

npm介紹

本文主要介紹基于npm包管理器的組件成分解析原理。

npm(全稱Node Package Manager)是Node.js標(biāo)準(zhǔn)的軟件包管理器。

npm的依賴管理文件是package.json，開發(fā)者可以在package.json中指定每個(gè)依賴項(xiàng)的版本范圍。

如果一個(gè)項(xiàng)目中存在package.json文件，便可以執(zhí)行npm install命令自動(dòng)安裝和維護(hù)當(dāng)前項(xiàng)目所需的所有模塊并生成package-lock.json文件。

package.json完整文件結(jié)構(gòu)如下：

{
  "name": "screeps",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "push": "rollup -cw --environment DEST:main",
    "build": "rollup -cw --environment DEST:local",
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@rollup/plugin-commonjs": "^21.0.1",
    "@rollup/plugin-node-resolve": "^13.1.1",
    "@types/lodash": "^3.10.1",
    "@types/screeps": "^3.2.4",
    "rollup": "^2.61.1",
    "rollup-plugin-clear": "^2.0.7",
    "rollup-plugin-copy": "^3.4.0",
    "rollup-plugin-screeps": "^1.0.1",
    "rollup-plugin-typescript2": "^0.31.1",
    "typescript": "^4.5.4"
  },
  "dependencies": {
    "source-map": "^0.6.1"
  }
}

其中name為項(xiàng)目名，version為項(xiàng)目版本，license為項(xiàng)目聲明的許可證，devDependencies為開發(fā)環(huán)境使用的依賴，dependencies為生產(chǎn)環(huán)境使用的依賴。

依賴寫法為"name":"version"，版本可以指定準(zhǔn)確版本或一個(gè)范圍，范圍需遵循semver語義化版本規(guī)范

解析算法

package-lock.json

package-lock.json是在npm install時(shí)自動(dòng)生成的文件，用以記錄當(dāng)前狀態(tài)下實(shí)際安裝的各個(gè)npm package的具體來源和版本號，通過該文件可以準(zhǔn)確定位到npm項(xiàng)目的依賴及版本。所以優(yōu)先解析package-lock.json文件。

package-lock.json文件結(jié)構(gòu)如下：

{
  "name": "foo",
  "version": "1.0.0",
  "dependencies": {
    "b": {
      "version": "1.2.1"
    },
    "a": {
      "version": "2.1.5",
      "requires": {
        "b": "^1.1.9"
      }
    },
    "c": {
      "version": "1.3.1",
      "requires": {
        "b": "^1.2.0"
      }
    }
  }
}

其中name字段為項(xiàng)目名稱，version字段為項(xiàng)目版本。dependencies字段中包含項(xiàng)目使用的所有直接和間接依賴，而且記錄了組件間的依賴關(guān)系。

例如：

"b": {
  "version": "1.2.1"
},

代表組件b的版本號為1.2.1。

"a": {
  "version": "2.1.5",
  "requires": {
    "b": "^1.1.9"
  }
},

代表項(xiàng)目依賴2.1.5版本的組件a，該組件依賴版本約束為^1.1.9的組件b。

同理可知項(xiàng)目依賴1.3.1版本的組件c，該組件依賴版本約束為^1.2.0的組件b。

從 <package-lock.json文件結(jié)構(gòu)> 可看出組件a和組件c都沒有被其他組件所依賴，所以可知這兩個(gè)組件是項(xiàng)目的直接依賴。

僅通過package-lock.json無法確定組件b是否是直接依賴，可以結(jié)合package.json文件進(jìn)一步確定，沒有package.json時(shí)，將b當(dāng)作間接依賴處理。若一個(gè)組件同時(shí)為直接和間接依賴，按直接依賴處理。

注：

^1.1.9代表版本號需要>=1.1.9且<2.0.0；
^1.2.0代表版本號需要>=1.2.0且<2.0.0；
更多約束格式請參閱semver官網(wǎng)

由此可以構(gòu)建出當(dāng)前項(xiàng)目的依賴結(jié)構(gòu)：

實(shí)線代表直接依賴，虛線代表間接依賴。

package.json

package.json為開發(fā)者編寫管理的依賴管理文件，在未找到package-lock.json文件時(shí)將解析該文件。

package.json僅包含直接依賴，在項(xiàng)目構(gòu)建時(shí)會(huì)從npm倉庫下載需要的間接依賴并構(gòu)建為package-lock.json文件，因此可以模擬npm構(gòu)建流程來獲取項(xiàng)目引用的組件依賴。

package.json文件結(jié)構(gòu)如下：

{
  "name": "foo",
  "version": "1.0.0",
  "devDependencies": {
    "a": "^2.0.0"
  },
  "dependencies": {
    "c": "^1.1.0"
  }
}

dependencies為項(xiàng)目實(shí)際使用的直接依賴，devDependencies為項(xiàng)目開發(fā)時(shí)使用的直接依賴。

例如：

"devDependencies": {
  "a": "^2.0.0"
}

代表項(xiàng)目開發(fā)過程中依賴版本約束為^2.0.0的組件a。

"dependencies": {
  "c": "^1.1.0"
}

代表項(xiàng)目直接依賴版本約束為^1.1.0組件c。

分析到這里我們可以總結(jié)出如下圖依賴關(guān)系：

通過該依賴關(guān)系可以看出項(xiàng)目組件的直接依賴及組件的版本范圍，但無法得知組件依賴的具體版本。

在沒有package-lock.json文件的情況下，為了進(jìn)一步獲取依賴的準(zhǔn)確版本及間接依賴，需要從npm倉庫下載對應(yīng)組件的詳細(xì)信息。

例如組件a的詳細(xì)信息結(jié)構(gòu)為：

{
  "time": {
    "2.1.5": "2011-02-16T22:31:02.088Z",
    "3.1.1": "2011-04-10T12:23:22.088Z"
  },
  "versions": {
    "2.1.5": {
      "dependencies": {
        "b": "^1.1.9"
      }
    },
    "3.1.1": {
      "dependencies": {
        "b": "^2.2.0"
      }
    }
  }
}

其中time字段為組件所有版本及發(fā)布日期，根據(jù)約束從這里獲取約束范圍內(nèi)的最大版本。

versions字段為組件各個(gè)版本對應(yīng)的詳細(xì)信息，其中dependencies字段為組件的依賴信息。

對于本例來說，組件a的約束為^2.0.0，要求版本號>=2.0.0且<3.0.0，所以選擇2.1.5版本。因此組件依賴結(jié)構(gòu)就變成了：