前端工程化-Node.js 内置模块（核心模块）

以下皆为拉勾教育课件内笔记

模块

Node.js 中的模块是具有特定功能的对象。按照模块的作者进行划分，可以分成三类：

• 内置模块：也叫核心模块，
  • 对应 Web 端 JS 的宿主对象，例如：window，localtion，history 等；
  • 无需单独安装 - 会随着Node.js一起安装；
  • 可以在官方API文档中查看：http://nodejs.cn/api/
• 自定义模块：程序员自己写的，具有一定功能的代码块。
  • 文件模块：单独的一个 JS 文件组成的模块
  • 目录模块：多个 JS 文件组合在一起，放在一个目录中形成的模块
• 第三方模块：既不是内置模块，也不是自定义模块。
  • 对应 Web 端 JS 的第三方库，例如：jQuery，Bootstrap 等。
  • 想要使用，必须先安装（ 如同使用 jQuery 之前，必须先通过 script 标签引入一样 ）
  • 在Node.js中，大量的第三方模块通过 npm 来管理。

内置模块

内置模块（也叫核心模块）是官方提供的，无需下载，可以直接使用的模块。

官网：http://nodejs.cn/api/

1. console

   console 模块提供了一个简单的调试控制台，类似于 Web 浏览器提供的 JavaScript 控制台。

   // 不同类型的数据，输出后颜色不同
   console.log('1');
   console.log(1);
   
   var obj = { name: 'Tom', age: 19 }
   console.log(obj)
   console.table(obj) // 以表格方式展示数据
   
   console.time('for');//开始计时
   for (var i = 1; i <= 100000; i++) {
   }
   console.timeEnd('for');//结束计时
   
   console.time('while');
   var i = 1;
   while (i <= 100000) {
     i++;
   }
   console.timeEnd('while');
   

2. process

   process 对象是一个全局变量，提供了有关当前 Node.js 进程的信息并对其进行控制。 作为全局变量，它始终可供 Node.js 应用程序使用，无需使用 require()。 它也可以使用 require() 显式地访问：

   // process 是全局变量，可以不写 require 引入
   const process = require('process');
   
   // 获取操作系统架构  x64
   console.log(process.arch)
   
   // 当前系统平台信息  win32
   console.log(process.platform)
   
   // 获取当前文件所在的目录 D:\cliu\Desktop\node
   console.log(process.cwd())  //  current working directory
   
   // 环境变量
   console.log(process.env)
   // 自定义环境变量
   process.env.NODE_ENV = 'develop'
   console.log(process.env)
   
   // 获取进程的编号
   console.log(process.pid)
   
   // 杀死进程  process.kill(进程编号)
   

3. path

   path 模块负责文件路径的

   • ./ 表示当前目录
   • ../ 表示上一级目录
   • __dirname 返回当前文件所在的目录
   • __filename 返回当前文件的完整路径（目录+文件）

   const path = require('path')
   
   // __dirname 获取当前文件所在的目录
   path.join(__dirname, 'dist') // directory name
   
   console.log('join用于拼接多个路径部分，并转化为正常格式');
   const temp = path.join(__dirname, '..', 'lyrics', './友谊之光.lrc');
   console.log(temp);
   
   console.log('获取路径中的文件名');
   console.log(path.basename(temp));
   
   console.log('获取一个路径中的目录部分');
   console.log(path.dirname(temp));
   
   console.log('获取一个路径中最后的扩展名');
   console.log(path.extname(temp));
   

4. fs

   fs （file system）模块主要负责文件基本操作，官方文档：fs 文件系统 (nodejs.cn)

• 文件操作

    // 使用 fs 之前先引入
    const fs = require('fs')
    
    // 写文件 （清空写入：写入之前会先将文件清空）
    # fs.writeFile('文件路径','写入内容',回调函数)
    fs.writeFile('./1.txt', '曾经有一首歌，她感动了我', (err) => {
        if (err) throw err
        console.log('写入成功')
    })
    
    // 读文件
    # fs.readFile('文件路径', 回调函数)
    fs.readFile('./1.txt', (err, data) => {
        if (err) throw err
        // data 是二进制数据，默认输出时，以十六进制的方式展示
        // 想要看到正常的效果，需要通过 toString() 转换
        console.log(data.toString())
    })
    
    // 删除文件
    # fs.unlink('文件路径', 回调函数)
    fs.unlink(__dirname+'/1.txt', (err) => {
        if (err) throw err
        console.log('删除成功')
    })
    
    // 追加写入（多次执行，文件中会有多条数据）
    # fs.appendFile('文件路径','写入内容',回调函数)
    fs.appendFile(__dirname+'/2.txt', '曾经有一首歌，她是这样唱的\n', (err) => {
        if (err) throw err
        console.log('追加写入成功') 
    })
  
  

• 目录操作

    // 创建目录
    fs.mkdir('./d1', (err) => {
      if (err) throw err
      console.log('创建成功')
    })
    
    // 删除目录（只能删除空目录）
    fs.rmdir('./d1', (err) => {
      if (err) throw err
      console.log('删除成功')
    })
    
    // 重命名目录（需要传入完整路径）
    // 语法：fs.rename(旧名称，新名称，回调函数)
    fs.rename(__dirname+'/d1', __dirname+'/d2', (err) => {
      if (err) throw err
      console.log('重命名成功')
    })
    
    // 读取目录
    fs.readdir(__dirname, (err, data) => {
      if (err) throw err
      // console.log(data) // data 是数组
      data.map((d) => { // map 方法遍历数组
        console.log(d)
      })
    })
    
    // 先判断目录是否存在，若不存在则同步创建目录
    if (!fs.existsSync('./d2')) {
      fs.mkdirSync('./d2')
    }
    
  

• fs.stat 查看状态

   // 查看文件信息
   fs.stat(__dirname+"/a.txt", (err, stat) => {
     if (err) throw err
     if (stat.isDirectory()) {
       // 判断当前文件是否是目录
       console.log('目录：', d)
     } else if (stat.isFile()) {
       // 判断当前文件是否是普通文件
       console.log('文件：', d)
     }
   })
  

Node.js 函数有同步与异步之分

5. http

   以前，我们使用 Apache 或 Nginx 来搭建服务器。Node.js 中，也有搭建服务器的模块。就是 http 模块。

   const http = require('http')
   
   // 1. 创建服务器
   /**
    * req = request  请求
    * res = response 响应
    */
   const server = http.createServer((req, res) => {
       res.statusCode = 200
       res.setHeader('Content-Type', 'text/plain; charset=utf-8')
       res.end('你好：Node.js')
   })
   
   // 2. 发布 web 服务
   const port = 3000
   const host = 'localhost'
   // 在浏览器中访问 http://localhost:3000 然后能看到效果
   server.listen(port, host, () => {
       console.log(`服务器运行在 http://${host}:${port}`)
   })
   

文件流

文件流方式读写文件的内存效率提高，无需加载大量数据。流把大数据切成小块，占用内存更少。时间效率有一定提高，接获数据后立即开始处理，无需等到内存缓冲填满。

const fs = require('fs')

// 1. 创建读取流
var readStream = fs.createReadStream('./file2.txt')

// 2. 创建写入流
var writeStream = fs.createWriteStream('./file_stream.txt')

// 3. 把读取流通过管道传给写入流
readStream.pipe(writeStream)