nodejs中实现一个自定义的require方法

rookiefishs2025-03-25 16:41

1.前言

大家对nodejs中的require方法应该不会陌生,这个方法可以用来导入nodejs的内置模块,自定义模块,第三方模块等,使用频率非常高,那么这个方法内部是如何实现的呢?本篇文章就是从头到尾拆分实现流程,最终实现一个自定义的require方法的

2.前置操作

导入所需的nodejs内置库,分别为fs库用来加载文件内容,path库用于操作路径,vm模块执行js代码

js 复制代码 
const fs = require('fs')
const path = require('path')
const vm = require('vm')

3.操作步骤拆分

  1. 路径分析,解析出绝对路径
  2. 缓存优先原则,加载文件的时候优先从缓存中加载
  3. 文件定位,确定当前模块的文件类型(js,json等等文件,方便后续调用对应的编译函数)
  4. 编译执行,将加载模块的内容变为可以在当前模块中直接使用的数据

4.开始创建自定义的require方法

1.创建customRequire方法

js 复制代码 
function customRequire(moduleName){}

2.创建一个Module类,用于存储模块信息,以及挂载一些辅助方法

js 复制代码 
class Module {
  constructor(id) {
    this.id = id
    this.exports = {}
  }
}

3.执行第一步路径分析,解析出绝对路径操作

js 复制代码 
// 给module类添加一个静态属性,用于表示模块的加载函数以及模块后缀的加载顺序
Module._extensions = {
  '.js'(module) {},
  '.json'(module) {},
  // ...
}

// 创建辅助方法,用于解析导入模块的绝对路径
Module._resolveFilename = (moduleName) => {
  // 获取当前模块的绝对路径
  let filePath = path.resolve(__dirname, moduleName)
  // 获取当前模块的后缀名
  const extName = path.extname(moduleName)

  // 判断文件是否存在
  if (!fs.existsSync(filePath)) {
    // 如果文件不存在,则按照顺序查找后缀名
    const keys = Object.keys(Module._extensions)
    // 文件是否存在标识
    let flag = false
    for (let i = 0; i < keys.length; i++) {
      // 获取当前循环的后缀名
      const currentExtName = keys[i]
      // 拼接后缀名
      const currentFilePath = filePath + currentExtName
      // 判断拼接后缀名之后的文件路径是否存在
      if (fs.existsSync(currentFilePath)) {
        // 如果存在,则将当前文件路径赋值给filePath
        filePath = currentFilePath
        // 将文件是否存在标识设置为true
        flag = true
        // 终止循环
        break
      }
    }
    // 如果不存在,则进行报错
    if (!flag) {
      throw new Error(`${moduleName} is not exists`)
    }
  }

  // 返回处理后得到的文件的绝对路径
  return filePath
}

// 创建自定义的require方法
function customRequire(moduleName) {
  // 路径分析,解析出模块的绝对路径
  const absPath = Module._resolveFilename(moduleName)
}

4.执行缓存优先原则,加载文件的时候优先从缓存中加载

js 复制代码 
// 创建自定义的require方法
function customRequire(moduleName) {
  // 路径分析,解析出模块的绝对路径
  const absPath = Module._resolveFilename(moduleName)
  // 缓存优先原则,加载文件的时候优先从缓存中加载
  const cacheModel = Module._cache[absPath]
  if (cacheModel) return cacheModel.exports
}

5.执行创建空对象目标加载模块操作(使用绝对路径作为模块的id)

js 复制代码 
// 定义空对象,用于存储缓存的模块
Module._cache = {}

// 创建自定义的require方法
function customRequire(moduleName) {
  // 路径分析,解析出模块的绝对路径
  const absPath = Module._resolveFilename(moduleName)
  // 缓存优先原则,加载文件的时候优先从缓存中加载
  const cacheModel = Module._cache[absPath]
  if (cacheModel) return cacheModel.exports
  
  // 创建空对象目标加载模块(使用绝对路径作为模块的id)
  let module = new Module(absPath)
  
  // 将已加载的模块缓存起来
  Module._cache[absPath] = module
}

6.执行模块的执行加载(编译执行)

js 复制代码 
// 在module类的原型链上新增load方法,用于加载模块
Module.prototype.load = function () {
  // 获取当前模块的后缀名
  const extName = path.extname(this.id)
  // 根据后缀名调用对应的加载函数
  Module._extensions[extName](this)
}

// 这里定义不同文件的不同加载与处理方法
Module._extensions = {
  '.js'(module) {
    // 读取module.id对应的文件内容(这里的id对应的是需要读取的文件的绝对路径)
    let content = fs.readFileSync(module.id, 'utf8')

    // 包装内容,使其成为一个函数,主要作用就是为了让加载的模块中可以使用一些全局变量
    content = Module.wrapper[0] + content + Module.wrapper[1]

    // 使用VM模块,将字符串内容变为一个函数
    const compileFn = vm.runInThisContext(content)

    // 定义上方创建的函数的形参对应的实参
    let exports = module.exports // 这里的module.exports就是接收到的形参,Module的实例化对象对exports静态属性
    let filename = module.id
    let dirname = path.dirname(module.id)

    // 调用函数,这里使用call方法,
    // 1.将this指向module.exports,call方法的第一个值就是重新指向的this
    // 2.此时被加载的模块中就可以使用module.exports,所以被加载模块中的变量就可以存储到module.exports中
    // 3.然后将其他的参数传递给函数
    // 4.基于call的特性,会立即执行此函数
    compileFn.call(exports, exports, customRequire, module, filename, dirname)

    // 返回被改动后的module.exports
    return module.exports
  },
  '.json'(module) {
    // 读取module.id对应的文件内容(这里的id对应的是需要读取的文件的绝对路径)
    let content = fs.readFileSync(module.id, 'utf8')

    // 将读取到的内容变为一个对象
    content = JSON.parse(content)

    // 将读取到的内容赋值给module.exports
    module.exports = content
  },
  // ...
}

// 定义空对象,用于存储缓存的模块
Module._cache = {}

// 创建自定义的require方法
function customRequire(moduleName) {
  // 路径分析,解析出模块的绝对路径
  const absPath = Module._resolveFilename(moduleName)
  // 缓存优先原则,加载文件的时候优先从缓存中加载
  const cacheModel = Module._cache[absPath]
  if (cacheModel) return cacheModel.exports
  
  // 创建空对象目标加载模块(使用绝对路径作为模块的id)
  let module = new Module(absPath)
  
  // 将已加载的模块缓存起来
  Module._cache[absPath] = module
  
  // 执行加载(编译执行)
  module.load()
  
  // 返回模块加载后的结果(注意,不能将id也返回出去)
  return module.exports
}

7.测试自定义require方法的效果如何

js 复制代码 
// ...上方代码
// 使用自定义模块加载js文件
const obj1 = customRequire('./测试使用文件/测试使用js')
console.log('接收到使用customRequire模块导入的js文件中导出的内容', obj1)

// 使用自定义模块加载json文件
const obj2 = customRequire('./测试使用文件/测试使用json')
console.log('接收到使用customRequire模块导入的json文件中导出的内容', obj2)

// 重复加载相同文件内容,观察是否从缓存中读取
const obj3 = customRequire('./测试使用文件/测试使用js')
console.log('接收到使用customRequire模块导入的js文件中导出的内容', obj3)

5.整体代码

js 复制代码 
// 导入所需的模块
const fs = require('fs')
const path = require('path')
const vm = require('vm')

// 创建一个Module类,用于存储模块信息,以及挂载一些辅助方法
class Module {
  constructor(id) {
    this.id = id
    this.exports = {}
  }
}

// 在module类的原型链上新增load方法,用于加载模块
Module.prototype.load = function () {
  // 获取当前模块的后缀名
  const extName = path.extname(this.id)
  // 根据后缀名调用对应的加载函数
  Module._extensions[extName](this)
}

// 给module类添加一个静态属性,用于表示模块的加载函数以及模块后缀的加载顺序
Module._extensions = {
  '.js'(module) {
    // 读取module.id对应的文件内容(这里的id对应的是需要读取的文件的绝对路径)
    let content = fs.readFileSync(module.id, 'utf8')

    // 包装内容,使其成为一个函数,主要作用就是为了让加载的模块中可以使用一些全局变量
    content = Module.wrapper[0] + content + Module.wrapper[1]

    // 使用VM模块,将字符串内容变为一个函数
    const compileFn = vm.runInThisContext(content)

    // 定义上方创建的函数的形参对应的实参
    let exports = module.exports // 这里的module.exports就是接收到的形参,Module的实例化对象对exports静态属性
    let filename = module.id
    let dirname = path.dirname(module.id)

    // 调用函数,这里使用call方法,
    // 1.将this指向module.exports,call方法的第一个值就是重新指向的this
    // 2.此时被加载的模块中就可以使用module.exports,所以被加载模块中的变量就可以存储到module.exports中
    // 3.然后将其他的参数传递给函数
    // 4.基于call的特性,会立即执行此函数
    compileFn.call(exports, exports, customRequire, module, filename, dirname)

    // 返回被改动后的module.exports
    return module.exports
  },
  '.json'(module) {
    // 读取module.id对应的文件内容(这里的id对应的是需要读取的文件的绝对路径)
    let content = fs.readFileSync(module.id, 'utf8')

    // 将读取到的内容变为一个对象
    content = JSON.parse(content)

    // 将读取到的内容赋值给module.exports
    module.exports = content
  },
  // ...
}

// 定义一个数组,用于存储包装内容
Module.wrapper = [
  "(function(exports, require, module, __filename, __dirname) {\n",
  "\n});"
]

// 创建辅助方法,用于解析导入模块的绝对路径
Module._resolveFilename = (moduleName) => {
  // 获取当前模块的绝对路径
  let filePath = path.resolve(__dirname, moduleName)
  // 获取当前模块的后缀名
  const extName = path.extname(moduleName)

  // 判断文件是否存在
  if (!fs.existsSync(filePath)) {
    // 如果文件不存在,则按照顺序查找后缀名
    const keys = Object.keys(Module._extensions)
    // 文件是否存在标识
    let flag = false
    for (let i = 0; i < keys.length; i++) {
      // 获取当前循环的后缀名
      const currentExtName = keys[i]
      // 拼接后缀名
      const currentFilePath = filePath + currentExtName
      // 判断拼接后缀名之后的文件路径是否存在
      if (fs.existsSync(currentFilePath)) {
        // 如果存在,则将当前文件路径赋值给filePath
        filePath = currentFilePath
        // 将文件是否存在标识设置为true
        flag = true
        // 终止循环
        break
      }
    }
    // 如果不存在,则进行报错
    if (!flag) {
      throw new Error(`${moduleName} is not exists`)
    }
  }

  // 返回处理后得到的文件的绝对路径
  return filePath
}

// 定义空对象,用于存储缓存的模块
Module._cache = {}

// 创建自定义的require方法
function customRequire(moduleName) {
  // 1.路径分析,解析出模块的绝对路径
  const absPath = Module._resolveFilename(moduleName)

  // 2.缓存优先原则,加载文件的时候优先从缓存中加载
  const cacheModel = Module._cache[absPath]
  if (cacheModel) return cacheModel.exports

  // 3.创建空对象目标加载模块(使用绝对路径作为模块的id)
  let module = new Module(absPath)

  // 4.将已加载的模块缓存起来
  Module._cache[absPath] = module

  // 5.执行加载(编译执行)
  module.load()

  // 6.返回模块加载后的结果(注意,不能将id也返回出去)
  return module.exports
}

// 使用自定义模块加载js文件
const obj1 = customRequire('./测试使用文件/测试使用js')
console.log('接收到使用customRequire模块导入的js文件中导出的内容', obj1)

// 使用自定义模块加载json文件
const obj2 = customRequire('./测试使用文件/测试使用json')
console.log('接收到使用customRequire模块导入的json文件中导出的内容', obj2)

// 重复加载相同文件内容,观察是否从缓存中读取
const obj3 = customRequire('./测试使用文件/测试使用js')
console.log('接收到使用customRequire模块导入的js文件中导出的内容', obj3)

6.总结

本篇文章解析了require的大致流程(原require肯定不止这么多代码与功能的,复杂度要多的多,这里只是大致实现效果),主要用到了fs,path,vm模块,如果有什么问题或者好的建议,欢迎私信或评论提出!😁

相关推荐
江湖行骗老中医7 分钟前
js闭包概念和使用
开发语言·javascript·ecmascript
king1999010210 分钟前
小程序Npm package entry file not found？
前端·npm·node.js
weixin_4565881516 分钟前
【Spring Boot 注解】@ConfigurationProperties
spring boot·后端
程序猿阿伟20 分钟前
《解锁CSS Flex布局：重塑现代网页布局的底层逻辑》
前端·css
生产队队长20 分钟前
CSS：选择器-复合选择器
前端·css
黄同学real1 小时前
前端安全中的XSS（跨站脚本攻击）
前端·安全·xss
楠奕1 小时前
Neo4j多关系或多路径
前端·javascript·neo4j
VcB之殇1 小时前
three.js中使用canvas生成动态纹理贴图
javascript·three.js
chunfeng—1 小时前
纯C协程框架NtyCo
linux·c++·后端·协程·ntyco
biubiubiu07061 小时前
ElaticSearch
spring boot·后端·jenkins
热门推荐
01KGG转MP3工具|非KGM文件|解密音频02从零安装 LLaMA-Factory 微调 Qwen 大模型成功及所有的坑03西电B测-计算机网络综合实验(含验收问题)04利用STM32实现语音识别功能05Coze扣子平台完整体验和实践（附国内和国际版对比）06DeepSeek各版本说明与优缺点分析07【SpeedAI科研小助手】2分钟极速解决知网维普重复率、AIGC率过高，一键全文降！文件格式不变，公式都保留的！08YOLOv8入门 | 重要性能衡量指标、训练结果评价及分析及影响mAP的因素【发论文关注的指标】09我决定放弃搞 Java 了10通达信神奇九转指标原理及选股公式，无未来函数，数字不消失