[摘抄] 4.require命令

Posted wuxiaoyi

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了[摘抄] 4.require命令相关的知识,希望对你有一定的参考价值。

4.require命令

1. 基本用法

Node适用CommonJS模块规范,内置的require命令用于加载模块文件。

require命令的基本功能是,读入并执行一个javascript文件,然后返回该模块的exports对象。 如果没有发现指定模块,就会报错。

var invisible = function(){
    console.log('invisible');
}

exports.message = 'hi';

exports.say = function (){
    console.log(message);
}

运行下面的命令,可以输出exports对象。

var example = require('./example.js');

example{
    message:'hi',
    say:[Function]
}

如果模块输入的是一个函数,那就不能定义在exports对象上面,而要定义在module.exports变量上面。

module.exports = function (){
  console.log('hello world')
}
require('./example.js')()

上面代码中,require命令调用自身,等于是执行module.exports,因此会输出"hello world"。

4.2 加载规则

require命令用于加载文件,后缀名默认为.js

var foo = require('foo');
//  等同于
var foo = require('foo.js');

根据参数的不同格式,require命令去不同路径寻找模块文件。

(1)如果参数字符串以“/”开头,则表示加载的是一个位于绝对路径的模块文件。比如,require(‘/home/marco/foo.js‘)将加载/home/marco/foo.js

(2)如果参数字符串以“./”开头,则表示加载的是一个位于相对路径(跟当前执行脚本的位置相比)的模块文件。比如,require(‘./circle‘)将加载当前脚本同一目录的circle.js

(3)如果参数字符串不以“./“或”/“开头,则表示加载的是一个默认提供的核心模块(位于Node的系统安装目录中),或者一个位于各级node_modules目录的已安装模块(全局安装或局部安装)。

举例来说,脚本/home/user/projects/foo.js执行了require(‘bar.js‘)命令,Node会依次搜索以下文件。

  • /usr/local/lib/node/bar.js
  • /home/user/projects/node_modules/bar.js
  • /home/user/node_modules/bar.js
  • /home/node_modules/bar.js
  • /node_modules/bar.js

这样设计的目的是,使得不同的模块可以将所依赖的模块本地化。

(4)如果参数字符串不以“./“或”/“开头,而且是一个路径,比如require(‘example-module/path/to/file‘),则将先找到example-module的位置,然后再以它为参数,找到后续路径。

(5)如果指定的模块文件没有发现,Node会尝试为文件名添加.js.json.node后,再去搜索。.js件会以文本格式的JavaScript脚本文件解析,.json文件会以JSON格式的文本文件解析,.node文件会以编译后的二进制文件解析。

(6)如果想得到require命令加载的确切文件名,使用require.resolve()方法。

4.3 目录的加载机制

通常,我们会把相关的文件会放在一个目录里面,便于组织。这时,最好为该目录设置一个入口文件,让require方法可以通过这个入口文件,加载整个目录。

在目录中放置一个package.json文件,并且将入口文件写入main字段。下面是一个例子。

// package.json
{ "name" : "some-library",
  "main" : "./lib/some-library.js" }

require发现参数字符串指向一个目录以后,会自动查看该目录的package.json文件,然后加载main字段指定的入口文件。如果package.json文件没有main字段,或者根本就没有package.json文件,则会加载该目录下的index.js文件或index.node文件。

4.4 模块的缓存

第一次加载某个模块时,Node会缓存该模块。以后再加载该模块时就直接从缓存取出该模块的module.exports属性。

require('./example.js');
require('./example.js').mesage = 'hello';
require('./example.js').message;
// "hello"
  • 上面代码中,连续三次使用require命令,加载同一个模块。
  • 第二次加载的时候,为输出的对象添加了一个message属性。
  • 第三次加载的时候,这个message属性依然存在,这就证明require命令并没有被重新加载,而是输出了缓存。

如果想要多次执行某个模块,可以让该模块输出一个函数,然后每次require这个模块的时候,重新执行一下输出函数。

所有缓存的模块保存在require.cache之中,如果想删除模块的缓存,可以像下面这样写。

// 删除指定的模块缓存
delete require.cache[moduleName];
// 删除所有模块的缓存
Objcet.keys(require.cache).forEach(function(key){
    delete require.cache[key];
})

注意,缓存是根据绝对路径识别模块的,如果同的模块名,但是保存在不同的路径,require命令还是会重新加载该模块。

4.5 环境变量NODE_PATH

Node执行一个脚本时,会先查看环境变量NODE_PATH。他是一组以冒号分隔的绝对路径。在其他位置找不到指定模块时,Node会去这些路径查找。

可以将NODE_PATH添加到.bashrc

export NODE_PATH="/usr/local/lib/node"

所以,如果遇到复杂的相对路径,比如下面这样

var myModule = require('../../../../lib/myModule');

有两种解决方法,

  • 一是将该文件加入node_modules 目录
  • 二是修改NODE_PATH环境变量

package.json文件可以采用下面的写法

{
  "name": "node_path",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "start": "NODE_PATH=lib node index.js"
  },
  "author": "",
  "license": "ISC"
}

NODE_PATH是历史遗留下来的一个路径解决方案,通常不应该使用,而应该使用node_modules目录机制。

4.6 模块的循环加载

如果发生模块的循环加载,即A加载B,B又加载A,则B将加载A的不完整版本。

// a.js
// 【2】.文件a在exports中创建变量并赋值为`a1`
exports.x = 'a1';
// 【3】.导入文件b,文件b开始执行。
console.log('a.js ', require('./b.js').x); //b2
// 【7】.b文件执行完毕,a文件继续往下执行,赋值,require.cache中a文件的x值变为a2;
exports.x = 'a2';

// b.js
// 【4】.执行文件b,创建变量并赋值`b1`
exports.x = 'b1';
// 【5】.导入文件a,文件a已经被执行过,所以在[require.cache]中是有a文件的缓存,并且exports.x = a1,下面则不会再执行a文件而是从缓存中得到x值,为a1;
console.log('b.js ', require('./a.js').x); //a1
// 【6】.赋值,执行完毕
exports.x = 'b2';

// main.js
// 【1】.开始读取文件a
console.log('main.js ', require('./a.js').x); //a2
// 【8】.a文件读取完毕,往下执行读取b文件,b文件在a文件的执行过程中已经读取,则拿出缓存直接打印 
console.log('main.js ', require('./b.js').x); //b2

上面代码是三个JavaScript文件。其中,a.js加载了b.js,而b.js又加载a.js。这时,Node返回a.js的不完整版本,所以执行结果如下。

$ node main.js //开始执行
b.js  a1
a.js  b2
main.js  a2
main.js  b2

修改main.js,再次加载a.js和b.js。

// main.js
console.log('main.js ', require('./a.js').x);
console.log('main.js ', require('./b.js').x);
console.log('main.js ', require('./a.js').x);
console.log('main.js ', require('./b.js').x);

执行上面代码,结果如下。

$ node main.js
b.js  a1
a.js  b2
main.js  a2
main.js  b2
main.js  a2
main.js  b2

上面代码中,第二次加载a.js和b.js时,会直接从缓存读取exports属性,所以a.js和b.js内部的console.log语句都不会执行了。

4.7 require.main

require方法有一个main属性,可以用来判断模块是直接执行,还是被调用执行。

直接执行的时候(node module.js),require.main属性指向模块本身。

require.main === module
// true

调用执行的时候(通过require加载该脚本执行),上面的表达式返回false。

以上是关于[摘抄] 4.require命令的主要内容,如果未能解决你的问题,请参考以下文章

VSCode自定义代码片段——git命令操作一个完整流程

VSCode自定义代码片段——cli的终端命令大全

VSCode自定义代码片段4——cli的终端命令大全

VSCode自定义代码片段15——git命令操作一个完整流程

VSCode自定义代码片段15——git命令操作一个完整流程

composer常用命令(部分摘抄)