Node.js学习笔记（二）——Node.js模块化、文件读写、环境变量

一、Node.js模块化

1.0、变量作用域

（1）、在浏览器端使用var或不使用关键字定义的变量属于全局作用域，也就是可以使用window对象访问。

    <script>
      var a = 100;

      (function () {
        b = 200;
      })();

      console.log(window.a, a);
      console.log(window.b, b);
    </script>

结果：

(2)、在Node.js中没有window对象

(3)、在Node.js的交互环境下，定义的变量属于global，global是类似浏览器端的window对象

(4)、在模块中（文件中）有global对象，使用关键字var,let,const定义的成员不属于global对象，仅在当前模块中有效，而不使用关键字定义的对象属于global对象。

var a=100;
b=200;
let c=300;
const d=400;
console.log(global);
console.log(global.a);
console.log(global.b);
console.log(global.c);
console.log(global.d);

终端输出：

1.1、模块概要

早期的javascript版本没有块级作用域、没有类、没有包、也没有模块，这样会带来一些问题，如复用、依赖、冲突、代码组织混乱等，随着前端的膨胀，模块化显得非常迫切。

前端模块化规范如下：

常见的的JavaScript模块规范有：CommonJS、AMD、CMD、UMD、原生模块化。

虽然我们学习过ES6的模块化但是ES6与NodeJS使用不同的模块化规范，单独学习NodeJS的模块化非常有必要。

模块化是指解决一个复杂问题时，自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说，模块是可组合、分解和更换的单元。

JavaScript在早期的设计中就没有模块、包、类的概念，开发者需要模拟出类似的功能，来隔离、组织复杂的JavaScript代码，我们称为模块化。

模块就是一个实现特定功能的文件，有了模块我们就可以更方便的使用别人的代码，要用什么功能就加载什么模块。

模块化开发的四点好处：

　　（1）、避免变量污染，命名冲突

　　（2）、提高代码复用率

　　（3）、提高了可维护性

　　（4）、方便依赖关系管理

nodejs中根据模块的来源不同，将模块分为了3大类，分别是：

内置模块（内置模块是由Node.js官方提供的，例如fs、path、http等）
自定义模块（用户创建的每个 .js文件，都是自定义模块）
第三方模块（由第三方开发出来的模块，并非官方提供的内置模块，也不是用户创建的自定义模块，使用前需要先下载）

模块作用域。

和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，这种模块级别的访问限制，叫做模块作用域。

模块作用域的好处：防止了全局变量污染的问题

1.2、CommonJS

CommonJS就是一个JavaScript模块化的规范，该规范最初是用在服务器端NodeJS中，前端的webpack也是对CommonJS原生支持的。

根据这个规范

（1）、每一个文件就是一个模块，其内部定义的变量是属于这个模块的，不会对外暴露，也就是说不会污染全局变量。

（2）、导入自定义的模块时路径需要以./或../开始，同一路径下也不能省略。

（3）、如果反复多次require模块，只加载一次。

（4）、require引入模块时，后缀名.js可以省略

（5）、每个模块文件都是一个独立的函数级作用域，在其它模块中不能直接访问

m1.js:

console.log("这是模块m1");
let a=100;
b=200;

m2.js

var m11=require("./m1");
console.log(a);
console.log(b);

结果：

从上面的示例可以看出a在模块2中是访问不到的，模块其实就是一个封闭的函数：

m1.js的代码如下：

console.log("这是模块m1");
let a=100;
b=200;
//输出当前函数
console.log(arguments.callee+"");

实际输出结果：

function (exports, require, module, __filename, __dirname) {
console.log("这是模块m1");
let a=100;
b=200;
//输出当前函数
console.log(arguments.callee+"");
}

（6）、每个模块中都包含如下5个对象：

exports:导出对象，默认为{}

require:导入函数，使用该函数可以实现模块的依赖

module:模块信息，用于记录当前模块的所有信息

__filename:当前模块的文件全路径，含文件名

__dirname:当前模块的文件路径不含文件名

（7）、使用exports或module.exports对象可以将当前模块中需要导出的内容暴露出去。

m1.js

let a=100;
let b=()=>{
    return 200;
};

exports.a=a;
exports.b=b;

m2.js

const m1=require("./m1");
console.log(m1);
console.log(m1.a);
console.log(m1.b());

结果：

（8）、导入模块内容可以结合解构语法

m1.js

exports.a=100;
exports.b=function(){
    return 200;
};

m2.js

const {a,b:fun}=require("./m1");
console.log(a);
console.log(fun());

结果：

1.3、NodeJS中使用CommonJS模块管理

CommonJS的核心思想就是通过 require 方法来同步加载所要依赖的其他模块，然后通过 exports 或者 module.exports 来导出需要暴露的接口。

CommonJS API编写应用程序，然后这些应用可以运行在不同的JavaScript解释器和不同的主机环境中。

2009年，美国程序员Ryan Dahl创造了node.js项目，将javascript语言用于服务器端编程。这标志"Javascript模块化编程"正式诞生。因为老实说，在浏览器环境下，以前没有模块也不是特别大的问题，毕竟网页程序的复杂性有限；但是在服务器端，一定要有模块，与操作系统和其他应用程序互动，否则根本没法编程。NodeJS是CommonJS规范的实现，webpack 也是以CommonJS的形式来书写。

CommonJS定义的模块分为:{模块引用(require)} {模块定义(exports)} {模块标识(module)}
//require()用来引入外部模块；
//exports对象用于导出当前模块的方法或变量，唯一的导出口；
//module对象就代表模块本身。

Nodejs的模块是基于CommonJS规范实现的，通过转换也可以运行在浏览器端。

特点：

1、所有代码都运行在模块作用域，不会污染全局作用域。

2、模块可以多次加载，但是只会在第一次加载时运行一次，然后运行结果就被缓存了，以后再加载，就直接读取缓存结果。要想让模块再次运行，必须清除缓存。

3、模块加载的顺序，按照其在代码中出现的顺序。

1.3.1、模块定义

根据commonJS规范，一个单独的文件是一个模块，每一个模块都是一个单独的作用域，也就是说，在该模块内部定义的变量，无法被其他模块读取，除非为global对象的属性。

模块拥有像函数一样的函数级作用域：

每个模块内部，module变量代表当前模块
module变量是一个对象，它的exports属性（即module.exports）是对外的接口
加载某个模块，其实是加载该模块的module.exports属性。require()方法用于加载模块。

模块只有一个出口，module.exports对象，我们需要把模块希望输出的内容放入该对象。

mathLib.js模块定义

var message="Hello CommonJS!";

module.exports.message=message;
module.exports.add=(m,n)=>console.log(m+n);

在 Node.js 中，创建一个模块非常简单，如下我们创建一个 'main.js' 文件，代码如下:

var hello = require('./hello');
hello.world();

以上实例中，代码 require('./hello') 引入了当前目录下的hello.js文件（./ 为当前目录，node.js默认后缀为js）。

Node.js 提供了exports 和 require 两个对象，其中 exports 是模块公开的接口，require 用于从外部获取一个模块的接口，即所获取模块的 exports 对象。

接下来我们就来创建hello.js文件，代码如下：

exports.world = function() {
  console.log('Hello World');
}

在以上示例中，hello.js 通过 exports 对象把 world 作为模块的访问接口，在 main.js 中通过 require('./hello') 加载这个模块，然后就可以直接访问main.js 中 exports 对象的成员函数了。

有时候我们只是想把一个对象封装到模块中，格式如下：

module.exports = function() {
  // ...
}

例如:

//hello.js 
function Hello() { 
    varname; 
    this.setName = function(thyName) { 
        name = thyName; 
    }; 
    this.sayHello = function() { 
        console.log('Hello ' + name); 
    }; 
}; 
module.exports = Hello;

这样就可以直接获得这个对象了：

//main.js 
var Hello = require('./hello'); 
hello = new Hello(); 
hello.setName('BYVoid'); 
hello.sayHello();

模块接口的唯一变化是使用 module.exports = Hello 代替了exports.world = function(){}。在外部引用该模块时，其接口对象就是要输出的 Hello 对象本身，而不是原先的 exports。

1.3.2、模块依赖

加载模块用require方法，该方法读取一个文件并且执行，返回文件内部的module.exports对象。

在用require加载自定义模块期间，可以省略.js这个后缀名。

myApp.js 模块依赖

var math=require('./mathLib');
console.log(math.message);
math.add(333,888);

3、测试运行

安装好node.JS

打开控制台，可以使用cmd命令，也可以直接在开发工具中访问

运行

1.3.3、内置模块加载

也许你已经注意到，我们已经在代码中使用了模块了。像这样：

var http = require("http");

...

http.createServer(...);

Node.js中自带了一个叫做"http"的模块，我们在我们的代码中请求它并把返回值赋给一个本地变量。

这把我们的本地变量变成了一个拥有所有 http 模块所提供的公共方法的对象。

Node.js 的 require方法中的文件查找策略如下：

由于Node.js中存在4类模块（原生模块和3种文件模块），尽管require方法极其简单，但是内部的加载却是十分复杂的，其加载优先级也各自不同。如下图所示：

从文件模块缓存中加载

尽管原生模块与文件模块的优先级不同，但是都不会优先于从文件模块的缓存中加载已经存在的模块。

从原生模块加载

原生模块的优先级仅次于文件模块缓存的优先级。require方法在解析文件名之后，优先检查模块是否在原生模块列表中。以http模块为例，尽管在目录下存在一个http/http.js/http.node/http.json文件，require("http")都不会从这些文件中加载，而是从原生模块中加载。

原生模块也有一个缓存区，同样也是优先从缓存区加载。如果缓存区没有被加载过，则调用原生模块的加载方式进行加载和执行。

从文件加载

当文件模块缓存中不存在，而且不是原生模块的时候，Node.js会解析require方法传入的参数，并从文件系统中加载实际的文件，加载过程中的包装和编译细节在前一节中已经介绍过，这里我们将详细描述查找文件模块的过程，其中，也有一些细节值得知晓。

require方法接受以下几种参数的传递：

http、fs、path等，原生模块。
./mod或../mod，相对路径的文件模块。
/pathtomodule/mod，绝对路径的文件模块。
mod，非原生模块的文件模块。

node_modules文件夹用来存放所有已安装到项目中的包。require()导入第三方包时，就是从这个目录中查找并加载包。

package-lock.json配置文件用来记录node_modules目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。

注意：不要手动修改node_modules或package-lock.json文件中的任何代码，npm包管理工具会自动维护它们。

1.3.4、module对象

在每个.js自定义模块中都有一个module对象，它里面存储了和当前模块有关的信息

每个模块内部，module变量代表当前模块
module变量是一个对象，它的exports属性（即module.exports）是对外的接口
加载某个模块，其实是加载该模块的module.exports属性。require()方法用于加载模块。

1.4、ESM与CJS

学习 JavaScript 语言，你会发现它有两种格式的模块。一种是 ES6 模块，简称 ESM；另一种是 Node.js 专用的 CommonJS 模块，简称 CJS。这两种模块不兼容。

很多人使用 Node.js，只会用require()加载模块，遇到 ES6 模块就不知道该怎么办。本文就来谈谈，ES6 模块在 Node.js 里面怎么使用。

1.4.1、两种模块的差异

ES6 模块和 CommonJS 模块有很大的差异。

语法上面，CommonJS 模块使用require()加载和module.exports输出，ES6 模块使用import和export。

用法上面，require()是同步加载，后面的代码必须等待这个命令执行完，才会执行。import命令则是异步加载，或者更准确地说，ES6 模块有一个独立的静态解析阶段，依赖关系的分析是在那个阶段完成的，最底层的模块第一个执行。

1.4.2、Node.js 的区分

Node.js 要求 ES6 模块采用.mjs后缀文件名。也就是说，只要脚本文件里面使用import或者export命令，那么就必须采用.mjs后缀名。Node.js 遇到.mjs文件，就认为它是 ES6 模块，默认启用严格模式，不必在每个模块文件顶部指定"use strict"。

如果不希望将后缀名改成.mjs，可以在项目的package.json文件中，指定type字段为module。

{
   "type": "module"
}

一旦设置了以后，该目录里面的 JS 脚本，就被解释用 ES6 模块。

# 解释成 ES6 模块
$ node my-app.js

如果这时还要使用 CommonJS 模块，那么需要将 CommonJS 脚本的后缀名都改成.cjs。如果没有type字段，或者type字段为commonjs，则.js脚本会被解释成 CommonJS 模块。

总结为一句话：.mjs文件总是以 ES6 模块加载，.cjs文件总是以 CommonJS 模块加载，.js文件的加载取决于package.json里面type字段的设置。

注意，ES6 模块与 CommonJS 模块尽量不要混用。require命令不能加载.mjs文件，会报错，只有import命令才可以加载.mjs文件。反过来，.mjs文件里面也不能使用require命令，必须使用import。

二、Node.js 文件系统

Node.js 提供一组类似 UNIX（POSIX）标准的文件操作API。 Node 导入文件系统模块(fs)语法如下所示：

var fs = require("fs")

2.1、异步和同步

Node.js 文件系统（fs 模块）模块中的方法均有异步和同步版本，例如读取文件内容的函数有异步的 fs.readFile() 和同步的 fs.readFileSync()。

异步的方法函数最后一个参数为回调函数，回调函数的第一个参数包含了错误信息(error)。

建议大家是用异步方法，比起同步，异步方法性能更高，速度更快，而且没有阻塞。

实例

创建 input.txt 文件，内容如下：

foo

创建 filereaddemo.js 文件, 代码如下：

const fs=require("fs");  //依赖内置模块fs,用于文件管理

//异步读取文件students.txt,设置读取成功时的回调函数,err表示错误信息,data表示数据
fs.readFile("students.txt",function(err,data){
    if(err) throw err;
    console.log("异步："+data+"");
});

console.log("---------------");

//同步读取
let data=fs.readFileSync("students.txt");
console.log("同步："+data+"");

以上代码执行结果如下：

接下来，让我们来具体了解下 Node.js 文件系统的方法。

2.2、获取文件信息

以下为通过异步模式获取文件信息的语法格式：

fs.stat(path, callback)

参数使用说明如下：

path - 文件路径。
callback - 回调函数，带有两个参数如：(err, stats), stats 是 fs.Stats 对象。

fs.stat(path)执行后，会将stats类的实例返回给其回调函数。可以通过stats类中的提供方法判断文件的相关属性。例如判断是否为文件：

const fs=require("fs");

fs.stat("students.txt",(err,stats)=>{
    console.log("是文件吗？"+stats.isFile());
    console.log("是目录吗？"+stats.isDirectory());
    console.log(stats);
});

结果：

stats类中的方法有：

方法	描述
stats.isFile()	如果是文件返回 true，否则返回 false。
stats.isDirectory()	如果是目录返回 true，否则返回 false。
stats.isBlockDevice()	如果是块设备返回 true，否则返回 false。
stats.isCharacterDevice()	如果是字符设备返回 true，否则返回 false。
stats.isSymbolicLink()	如果是软链接返回 true，否则返回 false。
stats.isFIFO()	如果是FIFO，返回true，否则返回 false。FIFO是UNIX中的一种特殊类型的命令管道。
stats.isSocket()	如果是 Socket 返回 true，否则返回 false。

接下来我们创建 file.js 文件，代码如下所示：

var fs = require("fs");

console.log("准备打开文件！");
fs.stat('input.txt', function (err, stats) {
   if (err) {
       return console.error(err);
   }
   console.log(stats);
   console.log("读取文件信息成功！");

   // 检测文件类型
   console.log("是否为文件(isFile) ? " + stats.isFile());
   console.log("是否为目录(isDirectory) ? " + stats.isDirectory());    
});

以上代码执行结果如下：

$ node file.js
准备打开文件！
{ dev: 16777220,
  mode: 33188,
  nlink: 1,
  uid: 501,
  gid: 20,
  rdev: 0,
  blksize: 4096,
  ino: 40333161,
  size: 61,
  blocks: 8,
  atime: Mon Sep 07 2015 17:43:55 GMT+0800 (CST),
  mtime: Mon Sep 07 2015 17:22:35 GMT+0800 (CST),
  ctime: Mon Sep 07 2015 17:22:35 GMT+0800 (CST) }
读取文件信息成功！
是否为文件(isFile) ? true
是否为目录(isDirectory) ? false

2.3、写入文件

以下为异步模式下写入文件的语法格式：

fs.writeFile(filename, data[, options], callback)

如果文件存在，该方法写入的内容会覆盖旧的文件内容。

参数使用说明如下：

path - 文件路径。
data - 要写入文件的数据，可以是 String(字符串) 或 Buffer(流) 对象。
options - 该参数是一个对象，包含 {encoding, mode, flag}。默认编码为 utf8, 模式为 0666 ， flag 为 'w'
callback - 回调函数，回调函数只包含错误信息参数(err)，在写入失败时返回。

接下来我们创建 file.js 文件，代码如下所示：

const fs=require("fs");

fs.writeFile("output1.txt","异步hello","utf-8",function(err){
    if(!err){
        console.log("异步文件写入成功！");
    }
    else{
        throw err;
    }
});
console.log("---------------");
fs.writeFileSync("output2.txt","同步hello","utf-8");
console.log("同步文件写入成功");

以上代码执行结果如下：

2.4、删除文件

以下为删除文件的语法格式：

fs.unlink(path, callback)

参数使用说明如下：

path - 文件路径。
callback - 回调函数，没有参数。

接下来我们创建 file.js 文件，代码如下所示：

const fs=require("fs");

fs.unlink("output1.txt",function(err){
    if(err){
        throw err;
    }
    else{
        console.log("异步删除文件成功！");
    }
});
console.log("--------------------");
fs.unlinkSync("output2.txt");
console.log("同步删除文件成功！");

以上代码执行结果如下：

2.5、创建目录

以下为创建目录的语法格式：

fs.mkdir(path[, mode], callback)

参数使用说明如下：

path - 文件路径。
mode - 设置目录权限，默认为 0777。
callback - 回调函数，没有参数。

接下来我们创建mkdirfile.js 文件，代码如下所示：

const fs=require("fs");

fs.mkdir("dir1",function(err){
    if(err){
        throw err;
    }
    else{
        console.log("异步创建目录成功！");
    }
});
console.log("---------------------");
fs.mkdirSync("dir2");
console.log("同步创建目录成功！");

以上代码执行结果如下：

2.6、读取目录

以下为读取目录的语法格式：

fs.readdir(path, callback)

参数使用说明如下：

path - 文件路径。
callback - 回调函数，回调函数带有两个参数err, files，err 为错误信息，files 为目录下的文件数组列表。

接下来我们创建 file.js 文件，代码如下所示：

const fs=require("fs");

fs.readdir("dir1",(err,files)=>{
    if(err) 
    {throw err;}
    else{
        console.log("异步获取目录下的文件成功！");
        files.forEach(file=>console.log(file));
    }
});
console.log("-----------------------");
let files=fs.readdirSync("dir2");
console.log("同步获取目录下的文件成功！");
files.forEach(file=>console.log(file));

以上代码执行结果如下：

2.7、删除目录

以下为删除目录的语法格式：

fs.rmdir(path, callback)

参数使用说明如下：

path - 文件路径。
callback - 回调函数，没有参数。

接下来我们创建 file.js 文件，代码如下所示：

var fs = require("fs");

console.log("准备删除目录 /tmp/test");
fs.rmdir("/tmp/test",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("读取 /tmp 目录");
   fs.readdir("/tmp/",function(err, files){
      if (err) {
          return console.error(err);
      }
      files.forEach( function (file){
          console.log( file );
      });
   });
});

以上代码执行结果如下：

$ node file.js
准备删除目录 /tmp/test
input.out
output.out
test
test.txt
读取 /tmp 目录
……

2.8、文件模块方法参考手册

以下为 Node.js 文件模块相同的方法列表：

方法	描述
fs.rename(oldPath, newPath, callback)	异步 rename().回调函数没有参数，但可能抛出异常。
fs.ftruncate(fd, len, callback)	异步 ftruncate().回调函数没有参数，但可能抛出异常。
fs.ftruncateSync(fd, len)	同步 ftruncate()
fs.truncate(path, len, callback)	异步 truncate().回调函数没有参数，但可能抛出异常。
fs.truncateSync(path, len)	同步 truncate()
fs.chown(path, uid, gid, callback)	异步 chown().回调函数没有参数，但可能抛出异常。
fs.chownSync(path, uid, gid)	同步 chown()
fs.fchown(fd, uid, gid, callback)	异步 fchown().回调函数没有参数，但可能抛出异常。
fs.fchownSync(fd, uid, gid)	同步 fchown()
fs.lchown(path, uid, gid, callback)	异步 lchown().回调函数没有参数，但可能抛出异常。
fs.lchownSync(path, uid, gid)	同步 lchown()
fs.chmod(path, mode, callback)	异步 chmod().回调函数没有参数，但可能抛出异常。
fs.chmodSync(path, mode)	同步 chmod().
fs.fchmod(fd, mode, callback)	异步 fchmod().回调函数没有参数，但可能抛出异常。
fs.fchmodSync(fd, mode)	同步 fchmod().
fs.lchmod(path, mode, callback)	异步 lchmod().回调函数没有参数，但可能抛出异常。Only available on Mac OS X.
fs.lchmodSync(path, mode)	同步 lchmod().
fs.stat(path, callback)	异步 stat(). 回调函数有两个参数 err, stats，stats 是 fs.Stats 对象。
fs.lstat(path, callback)	异步 lstat(). 回调函数有两个参数 err, stats，stats 是 fs.Stats 对象。
fs.fstat(fd, callback)	异步 fstat(). 回调函数有两个参数 err, stats，stats 是 fs.Stats 对象。
fs.statSync(path)	同步 stat(). 返回 fs.Stats 的实例。
fs.lstatSync(path)	同步 lstat(). 返回 fs.Stats 的实例。
fs.fstatSync(fd)	同步 fstat(). 返回 fs.Stats 的实例。
fs.link(srcpath, dstpath, callback)	异步 link().回调函数没有参数，但可能抛出异常。
fs.linkSync(srcpath, dstpath)	同步 link().
fs.symlink(srcpath, dstpath[, type], callback)	异步 symlink().回调函数没有参数，但可能抛出异常。 type 参数可以设置为 'dir', 'file', 或 'junction' (默认为 'file') 。
fs.symlinkSync(srcpath, dstpath[, type])	同步 symlink().
fs.readlink(path, callback)	异步 readlink(). 回调函数有两个参数 err, linkString。
fs.realpath(path[, cache], callback)	异步 realpath(). 回调函数有两个参数 err, resolvedPath。
fs.realpathSync(path[, cache])	同步 realpath()。返回绝对路径。
fs.unlink(path, callback)	异步 unlink().回调函数没有参数，但可能抛出异常。
fs.unlinkSync(path)	同步 unlink().
fs.rmdir(path, callback)	异步 rmdir().回调函数没有参数，但可能抛出异常。
fs.rmdirSync(path)	同步 rmdir().
fs.mkdir(path[, mode], callback)	S异步 mkdir(2).回调函数没有参数，但可能抛出异常。 mode defaults to 0777.
fs.mkdirSync(path[, mode])	同步 mkdir().
fs.readdir(path, callback)	异步 readdir(3). 读取目录的内容。
fs.readdirSync(path)	同步 readdir().返回文件数组列表。
fs.close(fd, callback)	异步 close().回调函数没有参数，但可能抛出异常。
fs.closeSync(fd)	同步 close().
fs.open(path, flags[, mode], callback)	异步打开文件。
fs.openSync(path, flags[, mode])	同步 version of fs.open().
fs.utimes(path, atime, mtime, callback)	?
fs.utimesSync(path, atime, mtime)	修改文件时间戳，文件通过指定的文件路径。
fs.futimes(fd, atime, mtime, callback)	?
fs.futimesSync(fd, atime, mtime)	修改文件时间戳，通过文件描述符指定。
fs.fsync(fd, callback)	异步 fsync.回调函数没有参数，但可能抛出异常。
fs.fsyncSync(fd)	同步 fsync.
fs.write(fd, buffer, offset, length[, position], callback)	将缓冲区内容写入到通过文件描述符指定的文件。
fs.write(fd, data[, position[, encoding]], callback)	通过文件描述符 fd 写入文件内容。
fs.writeSync(fd, buffer, offset, length[, position])	同步版的 fs.write()。
fs.writeSync(fd, data[, position[, encoding]])	同步版的 fs.write().
fs.read(fd, buffer, offset, length, position, callback)	通过文件描述符 fd 读取文件内容。
fs.readSync(fd, buffer, offset, length, position)	同步版的 fs.read.
fs.readFile(filename[, options], callback)	异步读取文件内容。
fs.readFileSync(filename[, options])
fs.writeFile(filename, data[, options], callback)	异步写入文件内容。
fs.writeFileSync(filename, data[, options])	同步版的 fs.writeFile。
fs.appendFile(filename, data[, options], callback)	异步追加文件内容。
fs.appendFileSync(filename, data[, options])	The 同步 version of fs.appendFile.
fs.watchFile(filename[, options], listener)	查看文件的修改。
fs.unwatchFile(filename[, listener])	停止查看 filename 的修改。
fs.watch(filename[, options][, listener])	查看 filename 的修改，filename 可以是文件或目录。返回 fs.FSWatcher 对象。
fs.exists(path, callback)	检测给定的路径是否存在。
fs.existsSync(path)	同步版的 fs.exists.
fs.access(path[, mode], callback)	测试指定路径用户权限。
fs.accessSync(path[, mode])	同步版的 fs.access。
fs.createReadStream(path[, options])	返回ReadStream 对象。
fs.createWriteStream(path[, options])	返回 WriteStream 对象。
fs.symlink(srcpath, dstpath[, type], callback)	异步 symlink().回调函数没有参数，但可能抛出异常。

更多内容，请查看官网文件模块描述：File System。

三、参数与环境变量

3.0、读取自定义配置文件数据

创立一个 config 目录并向其中增加一个 config/default.json 文件。这将是默认配置文件，并将蕴含所有默认环境变量。

在咱们的示例应用程序中它应该是这样的：

config/default.json

{
    "student":{
        "name":"tom",
        "age":19
    }
}

先依赖模块config,

npm i config

咱们将在咱们的应用程序中通过导入 config 和应用 get 办法拜访变量来访问它。

const config=require("config");
console.log(config.get("student.name"));
console.log(config.get("student.age"));

运行结果：

3.1、读取package.json配置参数

用于添加命令行的环境变量

package.json 可以配置config
脚本中 (see npm-scripts) package.json “config” 字段会被环境变量覆盖
<name>[@<version>]:<key>
例如,下面的package.json:
代码中使用 process.env['npm_package_config_xxxxxx'] 获取配置的内容

package.json

{
  "name": "demo06",
  "config": {
    "foo": "123456"
  },
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start":"node configtest.js"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "config": "^3.3.7"
  }
}

configtest.js

console.log(process.env.npm_package_config_foo);

直接运行(node configtest.js)结果：

直接在命令行执行 node configtest,会输出undefined

使用 npm run start,会输出 123456

npm 设置包的config

npm config set foo = 3000 就可以修改默认的配置内容

然后再执行 npm test 会输出 3000

3.2、环境变量的设置与读取

文件.env

USER_ID="239482"
USER_KEY="foobar"
NODE_ENV="development"

m3.js

npm i dotenv //依赖模块

require("dotenv").config();
console.log(process.env.USER_ID);

输出结果：

239482

3.3、获取系统中的环境变量

命令行下操作环境变量

3.3.1、查看当前所有可用的环境变量

输入 set 即可查看。

3.3.2、查看某个环境变量

输入 “set 变量名”即可。比如想查看path变量的值，即输入 set path

3.3.3、修改环境变量

注意：所有的在cmd命令行下对环境变量的修改只对当前窗口有效，不是永久性的修改。也就是说当关闭此cmd命令行窗口后，将不再起作用。

永久性修改环境变量的方法有两种：一种是直接修改注册表，另一种是通过我的电脑-〉属性-〉高级，来设置系统的环境变量（查看详细）。

1、修改环境变量

输入 “set 变量名=变量内容”即可。比如将path设置为“d:\nmake.exe”，只要输入set path="d:\nmake.exe"。

注意，此修改环境变量是指用现在的内容去覆盖以前的内容，并不是追加。比如当我设置了上面的path路径之后，如果我再重新输入set path="c"，再次查看path路径的时候，其值为“c:”，而不是“d:\nmake.exe”；“c”。

2、设置为空：

如果想将某一变量设置为空，输入“set 变量名=”即可。

如“set path=” 那么查看path的时候就为空。注意，上面已经说了，只在当前命令行窗口起作用。因此查看path的时候不要去右击“我的电脑”——“属性”........

3、给变量追加内容

输入“set 变量名=%变量名%;变量内容”。（不同于3，那个是覆盖）。如，为path添加一个新的路径，输入“ set path=%path%;d:\nmake.exe”即可将d:\nmake.exe添加到path中，再次执行"set path=%path%;c:"，那么，使用set path语句来查看的时候，将会有：d:\nmake.exe;c:，而不是像第3步中的只有c:。

3.3.4、一些常用的环境变量

%AllUsersProfile%: 局部返回所有“用户配置文件”的位置。 {所有用户文件目录 – C:\Documents and Settings\All Users}
%AppData%: 局部返回默认情况下应用程序存储数据的位置。 {当前用户数据文件夹 – C:\Documents and Settings\wy\Application Data}
%Cd%: 局部返回当前目录字符串。
%CmdCmdLine%: 局部返回用来启动当前的 Cmd.exe 的准确命令行。
%CmdExtVersion%: 系统返回当前的“命令处理程序扩展”的版本号。
%CommonProgramFiles%: {文件通用目录 – C:\Program Files\Common Files}
%ComputerName%: 系统返回计算机的名称。 {计算机名 – IBM-B63851E95C9}
%ComSpec%: 系统返回命令行解释器可执行程序的准确路径。 C:\WINDOWS\system32\cmd.exe
%Date%: 系统返回当前日期。使用与 date /t 命令相同的格式。由 Cmd.exe 生成。有关 date 命令的详细信息，请参阅 Date。
%ErrorLevel%: 系统返回最近使用过的命令的错误代码。通常用非零值表示错误。
%HomeDrive%: 系统返回连接到用户主目录的本地工作站驱动器号。基于主目录值的设置。用户主目录是在“本地用户和组”中指定的。 {当前用户根目录 – C:}
%HomePath%: 系统返回用户主目录的完整路径。基于主目录值的设置。用户主目录是在“本地用户和组”中指定的。 {当前用户路径 – \Documents and Settings\wy}
%HomeShare%: 系统返回用户的共享主目录的网络路径。基于主目录值的设置。用户主目录是在“本地用户和组”中指定的。
%LogonSever%: 局部返回验证当前登录会话的域控制器的名称。
%Number_Of_Processors%: 系统指定安装在计算机上的处理器的数目。 {处理器个数 – 1}
%Os%: 系统返回操作系统的名称。Windows 2000 将操作系统显示为 Windows_NT。 {操作系统名 – Windows_NT}
%Path%: 系统指定可执行文件的搜索路径。
%PathExt%: 系统返回操作系统认为可执行的文件扩展名的列表。
%Processor_Architecture%: 系统返回处理器的芯片体系结构。值: x86，IA64。 {处理器芯片架构 – x86}
%Processor_Identfier%: 系统返回处理器说明。
%Processor_Level%: 系统返回计算机上安装的处理器的型号。 {处理器型号 – 6}
%Processor_Revision%: 系统返回处理器修订号的系统变量。 {处理器修订号 – 0905}
%ProgramFiles%: {程序默认安装目录 – C:\Program Files}
%Prompt%: 局部返回当前解释程序的命令提示符设置。由 Cmd.exe 生成。 $P$G
%Random%: 系统返回 0 到 32767 之间的任意十进制数字。由 Cmd.exe 生成。
%SystemDrive%: 系统返回包含 Windows XP 根目录（即系统根目录）的驱动器。 {系统根目录 – C:}
%SystemRoot%: 系统返回 Windows XP 根目录的位置。 {系统目录 – C:\WINDOWS}
%Temp%: 系统和用户返回对当前登录用户可用的应用程序所使用的默认临时目录。有些应用程序需要 TEMP，而其它应用程序则需要 TMP。 {当前用户临时文件夹 – C:\DOCUME~1\wy\LOCALS~1\Temp}
%Time%: 系统返回当前时间。使用与 time /t 命令相同的格式。由 Cmd.exe 生成。9:16:25.05
%UserDomain%: 局部返回包含用户帐户的域的名称。 {包含用户帐号的域 – IBM-B63851E95C9}
%UserName%: 局部返回当前登录的用户的名称。 {当前用户名 – wy}
%UserProfile%: 局部返回当前用户的配置文件的位置。 {当前用户目录 – C:\Documents and Settings\wy}
%WinDir%: 系统返回操作系统目录的位置。 {系统目录 – C:\WINDOWS}

假定当前的系统环境变量定义如下，注意JAVA_HOME:

m3.js

console.log(process.env.JAVA_HOME);

输出：

a,b在系统中已定义好

注意当前的终端是cmd，不是powershell

这里a输出123的原因是修改成888后没有重启电脑。

3.3.5、设置永久环境变量

set命令

set命令用于设置当前cmd窗口中的环境变量，只在当前cmd窗口有效，cmd窗口关闭后将会失效,而其不会影响到系统中保存的用户环境变量。

setx命令
setx设置永久用户环境变量

setx env_name env_value

注意:有的路径中会带有空格,所以最好用双引号把变量和值都包裹起来,也就是写成如下形式:

setx "env_name" "env_value"

例，追加一个路径到用户path环境变量中:

setx "path" "D:\test;%path%"

setx设置永久系统环境变量

setx加上/m参数表示设置的是系统的环境变量，格式如下所示:

setx env_name env_value /m

注意:有的路径中会带有空格,所以最好用双引号把变量和值都包裹起来,也就是写成如下形式:

setx "env_name" "env_value" /m

例如，设置当前路径%cd%到系统环境环境变量中:

setx "Path" "%cd%;%path%" /m

注意:setx设置环境变量后，将在新打开的终端中生效，当前终端不会立即生效。
注意:setx可能会在环境变量中设置多个相同的值，例如，在当前cmd窗口中运行:

setx "Path" "D:\test;%path%" /m

然后再重新打开cmd窗口,进入D:\test路径,然后再次运行:

setx "Path" "D:\test;%path%" /m

这样D:\test将会在path环境变量中出现两次.

用setx设置永久环境变量及注意事项

设置用户环境变量

setx ENV_NAME env_value

设置系统环境变量

setx ENV_NAME env_value /m

注意1.
在某些情况下会出现“setx 无效语法默认选项不能超过'2'次”的错误，据信是因为原先的环境变量中存在空格导致的，可使用双引号进行避免。

注意2.

setx设置环境变量后，将在新打开的终端中生效，当前终端不会立即生效。所以当设置path这样内容较为丰富的环境变量时，要一次到位，而不要针对同一变量反复调用setx。例如：

正确做法：

set path_=%Path%
setx “Path” “%path_%;newpath1;newpath2” /m

错误做法：

set path_=%Path%
setx “Path” “%path_%;newpath1” /m
setx “Path” “%path_%;newpath2” /m

上述错误的做法将会漏掉newpath1。

四、作业

4.1、根据视频完成每一个上课示例。

4.2、定义一个模块circle.js，中模块中定义两个方法一个用于计算圆的周长，一个用于计算圆的面积，再定义一个模块main.js依赖模块circle.js，并调用模块中的两个方法用于计算。

分别使用CJS与ESM完成。

4.3、在配置文件package.json中定义好端口port与主机地址host，创建一个web服务器，引用配置信息，实现端口与主机地址的切换功能。

4.4、使用config的方式完成4.3

4.5、使用.env，dotenv的方式完成4.3

4.6、使用系统环境变量完成4.3

五、视频

https://www.bilibili.com/video/BV1WW411B78S

posted @ 2022-09-05 08:25 张果阅读(1257) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

笔记

Node.js学习笔记（二）——Node.js模块化、文件读写、环境变量

一、Node.js模块化

1.0、变量作用域

1.1、模块概要

1.2、CommonJS

1.3、NodeJS中使用CommonJS模块管理

1.3.1、模块定义

1.3.2、模块依赖

1.3.3、内置模块加载

1.3.4、module对象

1.4、ESM与CJS

1.4.1、两种模块的差异

1.4.2、Node.js 的区分

二、Node.js 文件系统

2.1、异步和同步

2.2、获取文件信息

2.3、写入文件

2.5、创建目录

2.6、读取目录

2.7、删除目录

2.8、文件模块方法参考手册

三、参数与环境变量

3.0、读取自定义配置文件数据

3.1、读取package.json配置参数

3.2、环境变量的设置与读取

3.3、获取系统中的环境变量

3.3.1、查看当前所有可用的环境变量

3.3.2、查看某个环境变量

3.3.3、修改环境变量

1、修改环境变量

2、设置为空：

3、给变量追加内容

3.3.4、一些常用的环境变量

3.3.5、设置永久环境变量

用setx设置永久环境变量及注意事项

四、作业

五、视频

公告