import...from... 和 require 如何找到模块位置?

简介: 昨天写了一篇文章,是关于 Vite 的,基于 Vite 从 0 到 1 启动一个 Vue2 项目,文章后面留下了几个问题是关于模块寻址问题,举个 Vue 项目里比较常用的 Vue 模块导入例子 import Vue from "vue"; 为什么不用写相对地址和绝对地址就能够导出 Vue 呢?似乎也没有配置路径?也没有配置映射,那么究竟 from "vue"; 对应的究竟是那个路径呢?

昨天写了一篇文章,是关于 Vite 的,基于 Vite 从 0 到 1 启动一个 Vue2 项目,文章后面留下了几个问题是关于模块寻址问题,举个 Vue 项目里比较常用的 Vue 模块导入例子

import Vue from "vue";

为什么不用写相对地址和绝对地址就能够导出 Vue 呢?似乎也没有配置路径?也没有配置映射,那么究竟 from "vue"; 对应的究竟是那个路径呢?

先提出两个可能的方案

  1. VS Code/WebStorm 这些 IDE 自己编撰的映射,并缓存了
  2. Webpack/Vite 这些开发工具自带的映射

关于上面这两个方案其实很容易验证,基于终端/命令行去运行项目并且不使用 WebpackVite 这两个库

  1. 第一步,执行以下语句
npm init
# shelljs 是一个可以使用 node 执行 shell 脚本的库
# 例子中使用 shelljs 测试输出
npm install shelljs
  1. 第二步,在 package.json 同目录下创建 index.js,内容如下
const shelljs = require("shelljs");

shelljs.exec("echo Hello World");
  1. 第三步,测试运行 node index.js,输出如下

IMG

即证与 IDEWebpack/Vite 无关

那究竟是怎么找到的呢?

node 模块

仔细观察 node index.js 是通过 node 执行的,所以有没有可能是通过 node 去找到的模块呢?

那么 node 执行 .js 文件时是按照什么规则来寻找的呢?

假设在 Y 路径执行 index.js

// index.js
const module = require(X)

X 以 或 './' 或 '../' 开头

判断 Y + X 是文件还是目录

Y + X 是文件

  1. 如果 X 是一个文件,加载 X 作为 JavaScript 文本。结束
  2. 如果 X.js 是一个文件,加载 X.js 作为 JavaScript 文本。结束
  3. 如果 X.json 是一个文件,解析 X.json 成一个 JavaScript 对象。结束
  4. 如果 X.node 是一个文件,加载 X.node 作为二进制插件。结束

例子

// index.js
const shelljs = require("./X");

shelljs.exec("echo Hello World");
// X.js
module.exports = {
  exec: () => {
    console.log("Hello World");
  }
}
├── index.js
└── X.js

IMG

注意,有文档称,require(/X) 这种方式也可以找到对于的模块,但在 node@16.15.1 的版本中已经不行,是无法找到的

Y + X 是目录

判断是否有名称为 index 的文件

Y + X 目录下有名为 index 的文件

  1. 如果 X/index.js 是一个文件,加载 X/index.js 作为 JavaScript 文本。结束
  2. 如果 X/index.json 是一个文件,解析 X/index.json 成一个 JavaScript 对象。结束
  3. 如果 X/index.node 是一个文件,加载 X/index.node 作为二进制插件。结束

Y + X 目录下没有名为 index 的文件

根据 Y + X 目录下的 package.json"main" 字段找到对应的文件

没有 package.json 怎么办?当然是报错咯

X 是模块名称

  1. 先去系统模块寻找
  2. 系统模块没有找到就去执行环境的同目录下找 node_modules,查看有无同名的 .js 文件

    1. 没有同名的 .js 文件就去找同名目录

      1. 如果找到了,就查看文件夹里有没有 index.js
      2. 没有找到就查看 package.json"main" 属性来确定
    2. 没有同名目录,抛出错误
  3. 同目录找不到 node_modules 就去父目录找,父目录找不到就找父目录的父目录,直至找到全局 node_modules

关于 node 更加详细的‘寻模块’规则,可以去查阅这个文档,里面有一个伪代码,非常详细和清晰

ES Module

上面讲了 require 的寻找规则,但是没讲 ES Module 的寻找规则(即 import),其实它们的寻址方式是一致的,不过 ES Module 需要在 package.json 设置 "type" 字段为 module 才可以开启,而且找的是package.json"module" 字段对应的文件

// package.json
{
  "type": "module"
}

那么回到文章一开始提到的 import Vue from "vue";,它最终找到的模块是什么呢?因为 Vue 本身提供多种打包文件(Commen.jsES Module

IMG

如上图所示 import Vue from "vue"; 最终找的是 vue.runtime.esm.js,这也就解释了为什么导出来的 Vue 是不带编译时只有运行时的了

相关文章
|
20天前
小技巧分享:如何使用动态断点快速找到成对的 ABAP 内存 IMPORT 和 EXPORT 的代码位置
小技巧分享:如何使用动态断点快速找到成对的 ABAP 内存 IMPORT 和 EXPORT 的代码位置
27 0
|
6月前
|
Python
无法导入名为'index'的模块
无法导入名为'index'的模块
32 2
|
8月前
|
JavaScript 前端开发 关系型数据库
.net core + vue + elementui 删除指定日期段、指定路径下的所有文件
# 1、呈现效果 ![image.png](https://ucc.alicdn.com/pic/developer-ecology/j2ygdazy447va_0782583bbc894c33a079db9e44385acd.png) # 2、后端 ## 1)服务层 ```csharp /// <summary> /// 删除指定修改日期段及指定路径下的所有文件 /// </summary> /// <param name="filepath">指定路径</param> /// <returns>返回删除结果提示</returns> public string DeleteSpecif
48 0
|
7月前
|
PHP C语言 Python
import方法引入模块详解
import方法引入模块详解
|
9月前
|
JavaScript
js文件中的require以及import 等语句中的{ }的作用
js文件中的require以及import 等语句中的{ }的作用
|
10月前
|
JavaScript
Vue找到package.json中没有用到依赖并删除
Vue找到package.json中没有用到依赖并删除
353 0
|
12月前
ts解决依赖引入报错:无法找到模块“xxxxxx”的声明文件的报错问题
ts解决依赖引入报错:无法找到模块“xxxxxx”的声明文件的报错问题
1516 0
|
12月前
|
JavaScript
Node.js——文件模块和路径模块(读写文件,处理路径)
Node.js——文件模块和路径模块(读写文件,处理路径)
134 0
|
前端开发 文件存储
v-for循环中使用require或import关键字引入本地图片
v-for循环中使用require或import关键字引入本地图片
127 0
|
Python
python使用import引用不了configparse模块等问题解决办法
python使用import引用不了configparse模块等问题解决办法
142 0