better?sqlite3安裝node?gyp原生模塊編譯prebuild-install

更新時間：2022年11月02日 14:22:16 作者：zhangjr0575

這篇文章主要為大家介紹了Nodejs關于原生模塊編譯node-gyp?+?prebuild-install?(以安裝?better-sqlite3為例)詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

關于node-gyp

node-gyp是一個用 Node.js 編寫的跨平臺命令行工具，用于為 Node.js 編譯本機插件模塊。它包含之前由 Chromium 團隊使用的 gyp-next項目的供應副本，擴展以支持 Node.js 原生插件的開發(fā)。

node-gyp is a cross-platform command-line tool written in Node.js for compiling native addon modules for Node.js. It contains a vendored copy of the gyp-next project that was previously used by the Chromium team, extended to support the development of Node.js native addons.

node是跨平臺的，那么對于任何的node模塊理論也是應該是跨平臺的。然而，有些node模塊直接或間接使用原生C/C++代碼，這些東西要跨平臺，就需要使用源碼根據(jù)實際的操作平臺環(huán)境進行原生模塊編譯。通常我們開發(fā)環(huán)境為macOS或Windows，而生產環(huán)境為Linux的各種發(fā)行版，這將導致我們的開發(fā)工作變得沉重不堪。那我們是否可以跳過node-gyp的編譯過程?

prebuild-install

node-gyp的編譯是讓人難受的過程，所以社區(qū)出現(xiàn)了node-pre-gyp和prebuild-install，它們都會優(yōu)先下載插件作者預編譯的二進制文件，當二進制文件下載出現(xiàn)問題時，再使用node-gyp進行編譯兜底。但因為我們網絡環(huán)境的特殊性，這些二進制文件我們大概率是不會下載成功的，接下來一起來看看在better-sqlite3的安裝過程中prebuild-install干了什么事。

關于node-pre-gyp參考姊妹文【Nodejs】關于原生模塊編譯node-gyp + node-pre-gyp (以安裝canvas為例)

better-sqlite3安裝過程追蹤

better-sqlite3就使用了prebuild-install來優(yōu)化構建過程

1. 安裝 better-sqlite3

關于install我們需要了解一點東西, 通常基于表象我們都會認為npm下載解壓并釋放到node_modules后就完成了安裝過程，但實際上npm還會檢查package中是否配置了install命令，存在就會立即執(zhí)行。

npm install better-sqlite3

2. better-sqlite3的package的命令腳本

可以看到better-sqlite3配置了install命令，所以npm下載better-sqlite3后立即執(zhí)行了prebuild-install

{
    ...,
    "scripts": {
        "install": "prebuild-install || npm run build-release",
        "build-release": "node-gyp rebuild --release",
        "build-debug": "node-gyp rebuild --debug",
        "rebuild-release": "npm run lzz && npm run build-release",
        "rebuild-debug": "npm run lzz && npm run build-debug",
        "test": "mocha --exit --slow=75 --timeout=5000",
        "benchmark": "node benchmark",
        "download": "bash ./deps/download.sh",
        "lzz": "lzz -hx hpp -sx cpp -k BETTER_SQLITE3 -d -hl -sl -e ./src/better_sqlite3.lzz"
      },
}

3. prebuild-install的package.json

可以看到prebuild-install使用bin將prebuild-install命令鏈接到了bin.js

{
    ...,
    "bin": "./bin.js",
    ...
}

4. 下載預構建的二進制文件

可以看到bin.js中核心函數(shù)就是startDownload

const startDownload = function (downloadUrl) {
  download(downloadUrl, opts, function (err) {
    if (err) {
      log.warn('install', err.message)
      return process.exit(1)
    }
    log.info('install', 'Successfully installed prebuilt binary!')
  })
}
if (opts.token) {
  asset(opts, function (err, assetId) {
    if (err) {
      log.warn('install', err.message)
      return process.exit(1)
    }
    startDownload(util.getAssetUrl(opts, assetId))
  })
} else {
  startDownload(util.getDownloadUrl(opts))
}

其中opts的核心參數(shù)項如下。粘貼的代碼有刪減，完整的請自行查閱源碼

const rc = require('rc')('prebuild-install', {
    target: pkgConf.target || env.npm_config_target || process.versions.node,
    runtime: pkgConf.runtime || env.npm_config_runtime || 'node',
    arch: pkgConf.arch || env.npm_config_arch || process.arch,
    libc: libc,
    platform: env.npm_config_platform || process.platform,
    debug: env.npm_config_debug === 'true',
    force: false,
    verbose: env.npm_config_verbose === 'true',
    buildFromSource: buildFromSource === pkg.name || buildFromSource === 'true',
    path: '.',
    proxy: env.npm_config_proxy || env.http_proxy || env.HTTP_PROXY,
    'https-proxy': env.npm_config_https_proxy || env.https_proxy || env.HTTPS_PROXY,
    'local-address': env.npm_config_local_address,
    'local-prebuilds': 'prebuilds',
    'tag-prefix': 'v',
    download: env.npm_config_download
})

opts中并沒有發(fā)現(xiàn)token的蹤跡，那程序將進入else分支，接下來我們進入getDownloadUrl查看于構建二進制文件下載地址的拼接邏輯。可以看到針對包名prebuild-install會移除包名以@組織開頭的部分

function getDownloadUrl (opts) {
  const pkgName = opts.pkg.name.replace(/^@[a-zA-Z0-9_\-.~]+\//, '')
  return expandTemplate(urlTemplate(opts), {
    name: pkgName,
    package_name: pkgName,
    version: opts.pkg.version,
    major: opts.pkg.version.split('.')[0],
    minor: opts.pkg.version.split('.')[1],
    patch: opts.pkg.version.split('.')[2],
    prerelease: opts.pkg.version.split('-')[1],
    build: opts.pkg.version.split('+')[1],
    abi: opts.abi || process.versions.modules,
    node_abi: process.versions.modules,
    runtime: opts.runtime || 'node',
    platform: opts.platform,
    arch: opts.arch,
    libc: opts.libc || '',
    configuration: (opts.debug ? 'Debug' : 'Release'),
    module_name: opts.pkg.binary && opts.pkg.binary.module_name,
    tag_prefix: opts['tag-prefix']
  })
}

接下來我們進入urlTemplate函數(shù)，函數(shù)內又調用了其他的函數(shù)，這里我們針對重要的代碼做說明不粘貼源碼

// 構建了二進制文件名的模板字符串, 在稍后`{}`中的內容將會被替換掉
const packageName = '{name}-v{version}-{runtime}-v{abi}-{platform}{libc}-{arch}.tar.gz'
// 獲取npmrc中的鏡像配置{包名}_binary_host(或{包名}_binary_host_mirror)
const hostMirrorUrl = getHostMirrorUrl(opts);
// 當hostMirrorUrl存在時, 在hostMirrorUrl拼接上版本號和包信息返回
if (hostMirrorUrl) {
    return hostMirrorUrl + '/{tag_prefix}{version}/' + packageName
}
// 當hostMirrorUrl不存在時, 將會檢查包中是否配置了binary以及binary.host, 存在時返回格式為
// '{binary.host}/{binary.remote_path}/{binary.package_name || packageName}'
// 當binary以及binary.host均不存在時, 將會返回二進制文件在github上的托管地址
return github(opts.pkg) + '/releases/download/{tag_prefix}{version}/' + packageName

接下來就是expandTemplate函數(shù)對urlTemplate返回的下載地址中的占位符做替換處理生成真正的預構建二進制文件地址，至此prebuild-install完成了二進制文件的下載，跳過了node-pyg的編譯過程

讓prebuild-install通過淘寶源下載預構建文件

npm提供了.npmrc配置文件并注入到進程的env環(huán)境變量中，從上面的urlTemplate源碼可知，prebuild-install會優(yōu)先讀取npm_config_{包名}_binary_host不存在時繼續(xù)讀取npm_config_{包名}_binary_host_mirror(.npmrc中的變量均會被npm添加npm_config_前綴, 所以我們配置時無需添加npm_config_前綴)，另外需要值得注意的是npm會將.npmrc中的鍵以下劃線的方式組織且任何非數(shù)字和字母的字符將會被替換為_。所以以better-sqlite3舉例來說，以下配置均可被prebuild-install正常讀取。

better_sqlite3_binary_host=https://registry.npmmirror.com/-/binary/better-sqlite3
better_sqlite3_binary_host_mirror=https://registry.npmmirror.com/-/binary/better-sqlite3
better-sqlite3_binary_host=https://registry.npmmirror.com/-/binary/better-sqlite3
better-sqlite3_binary_host_mirror=https://registry.npmmirror.com/-/binary/better-sqlite3

鑒于node-pre-gyp只讀取{包名}_binary_host_mirror，針對原生模塊我們在.npmrc中以{包名}_binary_host_mirror={mirror}的格式配置預構建文件下載鏡像

以上就是better sqlite3安裝node gyp原生模塊編譯prebuild-install的詳細內容，更多關于node 模塊編譯prebuild install的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: