亚洲乱码中文字幕综合,中国熟女仑乱hd,亚洲精品乱拍国产一区二区三区,一本大道卡一卡二卡三乱码全集资源,又粗又黄又硬又爽的免费视频

dotenv源碼解讀從.env文件中讀取環(huán)境變量

 更新時間:2022年12月25日 09:11:20   作者:田八  
這篇文章主要為大家介紹了dotenv源碼解讀從.env文件中讀取環(huán)境變量示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪

引言

dotenv.env文件中讀取環(huán)境變量,然后將其添加到process.env中。這是一個非常簡單的庫,但是它在開發(fā)中非常有用,因為它允許你在.env文件中存儲敏感信息,而不是將其存儲在代碼中。

現(xiàn)在很多庫都支持.env文件,例如create-react-app,vue-clinext.js等。

源碼地址:github.com/motdotla/do…

使用

根據(jù)READMEdotenv只有兩個方法:

  • config:讀取.env文件并將其添加到process.env中。
  • parse:解析一段包含環(huán)境變量的字符串或Buffer,并返回一個對象。
const dotenv = require('dotenv')
// 讀取.env文件并將其添加到process.env中
dotenv.config()
// 解析一段包含環(huán)境變量的字符串或Buffer,返回一個對象
const config1 = dotenv.parse('FOO=bar\nBAR=foo')
console.log(config1) // { FOO: 'bar', BAR: 'foo' }
const buffer = Buffer.from('FOO=bar\nBAR=foo')
const config2 = dotenv.parse(buffer)
console.log(config2) // { FOO: 'bar', BAR: 'foo' }

可以看到,dotenv的使用非常簡單,通常我們只需要調(diào)用config方法即可。

還有一種方法是預(yù)加載,直接通過node -r dotenv/config來運行腳本,這樣就不需要在腳本中引入dotenv了。

源碼

源碼在lib/main.js中,先來看一下全部的代碼:

const fs = require('fs')
const path = require('path')
const os = require('os')
const packageJson = require('../package.json')
const version = packageJson.version
const LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\'|[^'])*'|\s*"(?:\"|[^"])*"|\s*`(?:\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
// Parser src into an Object
function parse (src) {
  const obj = {}
  // Convert buffer to string
  let lines = src.toString()
  // Convert line breaks to same format
  lines = lines.replace(/\r\n?/mg, '\n')
  let match
  while ((match = LINE.exec(lines)) != null) {
    const key = match[1]
    // Default undefined or null to empty string
    let value = (match[2] || '')
    // Remove whitespace
    value = value.trim()
    // Check if double quoted
    const maybeQuote = value[0]
    // Remove surrounding quotes
    value = value.replace(/^(['"`])([\s\S]*)\1$/mg, '$2')
    // Expand newlines if double quoted
    if (maybeQuote === '"') {
      value = value.replace(/\n/g, '\n')
      value = value.replace(/\r/g, '\r')
    }
    // Add to object
    obj[key] = value
  }
  return obj
}
function _log (message) {
  console.log(`[dotenv@${version}][DEBUG] ${message}`)
}
function _resolveHome (envPath) {
  return envPath[0] === '~' ? path.join(os.homedir(), envPath.slice(1)) : envPath
}
// Populates process.env from .env file
function config (options) {
  let dotenvPath = path.resolve(process.cwd(), '.env')
  let encoding = 'utf8'
  const debug = Boolean(options && options.debug)
  const override = Boolean(options && options.override)
  if (options) {
    if (options.path != null) {
      dotenvPath = _resolveHome(options.path)
    }
    if (options.encoding != null) {
      encoding = options.encoding
    }
  }
  try {
    // Specifying an encoding returns a string instead of a buffer
    const parsed = DotenvModule.parse(fs.readFileSync(dotenvPath, { encoding }))
    Object.keys(parsed).forEach(function (key) {
      if (!Object.prototype.hasOwnProperty.call(process.env, key)) {
        process.env[key] = parsed[key]
      } else {
        if (override === true) {
          process.env[key] = parsed[key]
        }
        if (debug) {
          if (override === true) {
            _log(`"${key}" is already defined in `process.env` and WAS overwritten`)
          } else {
            _log(`"${key}" is already defined in `process.env` and was NOT overwritten`)
          }
        }
      }
    })
    return { parsed }
  } catch (e) {
    if (debug) {
      _log(`Failed to load ${dotenvPath} ${e.message}`)
    }
    return { error: e }
  }
}
const DotenvModule = {
  config,
  parse
}
module.exports.config = DotenvModule.config
module.exports.parse = DotenvModule.parse
module.exports = DotenvModule

可以看到最后導(dǎo)出的是一個對象,包含了configparse兩個方法。

config

config方法的作用是讀取.env文件,并將其添加到process.env中。

function config (options) {
  let dotenvPath = path.resolve(process.cwd(), '.env')
  let encoding = 'utf8'
  const debug = Boolean(options && options.debug)
  const override = Boolean(options && options.override)
}

首先定義了一些變量:

  • dotenvPath.env文件的路徑
  • encoding是文件的編碼
  • debugoverride分別表示是否開啟調(diào)試模式和是否覆蓋已有的環(huán)境變量。
if (options) {
  if (options.path != null) {
    dotenvPath = _resolveHome(options.path)
  }
  if (options.encoding != null) {
    encoding = options.encoding
  }
}

然后判斷了一下options是否存在,如果存在的話,就會根據(jù)options的值來修改dotenvPathencoding的值。

const parsed = DotenvModule.parse(fs.readFileSync(dotenvPath, { encoding }))

然后是調(diào)用parse方法來解析.env文件,parse方法的實現(xiàn)在下面會講到。

這里是只用fs.readFileSync來讀取.env文件,然后將其傳入parse方法中,接著往下:

Object.keys(parsed).forEach(function (key) {
    if (!Object.prototype.hasOwnProperty.call(process.env, key)) {
        process.env[key] = parsed[key]
    } else {
        if (override === true) {
            process.env[key] = parsed[key]
        }
        if (debug) {
            if (override === true) {
                _log(`"${key}" is already defined in `process.env` and WAS overwritten`)
            } else {
                _log(`"${key}" is already defined in `process.env` and was NOT overwritten`)
            }
        }
    }
})

這里是遍歷parsed對象,然后將其添加到process.env中,如果process.env中已經(jīng)存在了該環(huán)境變量,那么就會根據(jù)override的值來決定是否覆蓋。

debug的值表示是否開啟調(diào)試模式,如果開啟了調(diào)試模式,那么就會打印一些日志。

最后就是直接返回parsed對象。

parse

parse方法的作用是解析.env文件,將其轉(zhuǎn)換為一個對象。

const LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\'|[^'])*'|\s*"(?:\"|[^"])*"|\s*`(?:\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
function parse (src) {
  const obj = {}
  // Convert buffer to string
  let lines = src.toString()
  // Convert line breaks to same format
  lines = lines.replace(/\r\n?/mg, '\n')
  let match
  while ((match = LINE.exec(lines)) != null) {
    const key = match[1]
    // Default undefined or null to empty string
    let value = (match[2] || '')
    // Remove whitespace
    value = value.trim()
    // Check if double quoted
    const maybeQuote = value[0]
    // Remove surrounding quotes
    value = value.replace(/^(['"`])([\s\S]*)\1$/mg, '$2')
    // Expand newlines if double quoted
    if (maybeQuote === '"') {
      value = value.replace(/\n/g, '\n')
      value = value.replace(/\r/g, '\r')
    }
    // Add to object
    obj[key] = value
  }
  return obj
}

首先定義了一個正則表達式LINE,用來匹配.env文件中的每一行。

然后是將src轉(zhuǎn)換為字符串,然后將換行符統(tǒng)一為\n。

接著就是核心,通過正則表達式的特性通過while循環(huán)來匹配每一行。

這個正則著實有點復(fù)雜,我是正則渣渣,可以在regex101查看一下。

這個正則上面標出了三種顏色,和下面的匹配的值的顏色相互對應(yīng),然后右邊會展示匹配的值。

這里我不過多解讀,可以自己去看一下,然后輸入不同的值對比一下結(jié)果。

通過上面的截圖可以看到匹配會捕獲兩個值,第一個是環(huán)境變量的名稱,第二個是環(huán)境變量的值。

然后對值進行處理,首先去掉首尾的空格,然后通過正則去掉首尾的引號,最后再將轉(zhuǎn)義的換行符轉(zhuǎn)換還原。

經(jīng)過上面的處理,就可以將每一行的環(huán)境變量添加到obj對象中了,最后返回obj對象。

總結(jié)

dotenv真的是非常驚艷的一個庫,沒有任何依賴,只有一個文件,而且功能也非常強大。

如果你將README中的內(nèi)容全部看完,你還會發(fā)現(xiàn)dotenv還有很多其他的功能,都是一些很實用的功能,并且還有很多引導(dǎo)你如何使用的例子。

以上就是dotenv源碼解讀從.env文件中讀取環(huán)境變量的詳細內(nèi)容,更多關(guān)于dotenv .env文件讀取環(huán)境變量的資料請關(guān)注腳本之家其它相關(guān)文章!

相關(guān)文章

  • 微信小程序 參數(shù)傳遞詳解

    微信小程序 參數(shù)傳遞詳解

    這篇文章主要介紹了微信小程序 參數(shù)傳遞詳解的相關(guān)資料,需要的朋友可以參考下
    2016-10-10
  • 詳解微信小程序 登錄獲取unionid

    詳解微信小程序 登錄獲取unionid

    這篇文章主要介紹了詳解微信小程序 登錄獲取unionid的相關(guān)資料,需要的朋友可以參考下
    2017-06-06
  • 微信小程序 Record API詳解及實例代碼

    微信小程序 Record API詳解及實例代碼

    這篇文章主要介紹了微信小程序 Record API詳解及實例代碼的相關(guān)資料,需要的朋友可以參考下
    2016-09-09
  • 總結(jié)JavaScript中BigIn函數(shù)常見的屬性

    總結(jié)JavaScript中BigIn函數(shù)常見的屬性

    本文基于JavaScript基礎(chǔ),介紹了 BigInt 函數(shù),常見的屬性,通過 BigInt 函數(shù)進行數(shù)字運算符的比較。布爾運算等等,通過按案例的分析進行詳細的講解,需要的朋友可以參考一下
    2021-10-10
  • RxJS中的Observable和Observer示例詳解

    RxJS中的Observable和Observer示例詳解

    這篇文章主要為大家介紹了RxJS中的Observable和Observer使用示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
    2022-08-08
  • JS輕量級函數(shù)式編程實現(xiàn)XDM二

    JS輕量級函數(shù)式編程實現(xiàn)XDM二

    這篇文章主要為大家介紹了JS函數(shù)式編程實現(xiàn)XDM示例詳解第2/3篇,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
    2022-06-06
  • JS輕量級函數(shù)式編程實現(xiàn)XDM一

    JS輕量級函數(shù)式編程實現(xiàn)XDM一

    這篇文章主要為大家介紹了JS輕量級函數(shù)式編程實現(xiàn)XDM示例詳解第1/3篇,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
    2022-06-06
  • 微信公眾號 客服接口的開發(fā)實例詳解

    微信公眾號 客服接口的開發(fā)實例詳解

    這篇文章主要介紹了微信公眾號 客服接口的開發(fā)實例詳解的相關(guān)資料,需要的朋友可以參考下
    2016-09-09
  • JavaScript 條件判斷使用技巧詳解

    JavaScript 條件判斷使用技巧詳解

    這篇文章主要為大家介紹了JavaScript 條件判斷使用技巧詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
    2022-09-09
  • 前端JS實現(xiàn)太極圖案圖文示例

    前端JS實現(xiàn)太極圖案圖文示例

    這篇文章主要為大家介紹了前端JS實現(xiàn)太極圖案圖文示例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
    2022-09-09

最新評論