nodejs

fs文件系统模块

在安装node.js时就已经安装了这些模块。fs 模块是 Node.js 官方提供的、用来操作文件的模块。它提供了一系列的方法和属性，用来满足用户对文件的操作需求。
例如：

  • fs.readFile() 方法，用来读取指定文件中的内容
  • fs.writeFile() 方法，用来向指定的文件中写入内容

如果要在 JavaScript 代码中，使用 fs 模块来操作文件，则需要使用如下的方式先导入它：
const fs=require("fs")

读取指定文件中的内容

  1. fs.readFile() 的语法格式
    使用 fs.readFile() 方法，可以读取指定文件中的内容，语法格式如下：
    image
    参数解读：
  • 参数1：必选参数，字符串，表示文件的路径。
  • 参数2：可选参数，表示以什么编码格式来读取文件。
  • 参数3：必选参数，文件读取完成后，通过回调函数拿到读取的结果。

以 utf8 的编码格式，读取指定文件的内容，并打印 err 和 dataStr 的值：
image

// 1. 导入 fs 模块，来操作文件
const fs = require('fs')
// 2. 调用 fs.readFile() 方法读取文件
//    参数1：读取文件的存放路径
//    参数2：读取文件时候采用的编码格式，一般默认指定 utf8
//    参数3：回调函数，拿到读取失败和成功的结果  err  dataStr
fs.readFile('./files/11.txt', 'utf8', function(err, dataStr) {
  // 2.1 打印失败的结果
  // 如果读取成功，则 err 的值为 null
  // 如果读取失败，则 err 的值为 错误对象，dataStr 的值为 undefined
  console.log(err)
  console.log('-------')
  // 2.2 打印成功的结果
  console.log(dataStr)
})

读取成功
image
读取失败
image

  1. 判断文件是否读取成功
const fs = require('fs')
 
fs.readFile('./files/11.txt', 'utf8', function(err, dataStr) {
//读取失败时，err就不为空了
  if (err) {
    return console.log('读取文件失败！' + err.message)
  }
  console.log('读取文件成功！' + dataStr)
})

向指定的文件中写入内容

使用 fs.writeFile() 方法，可以向指定的文件中写入内容，语法格式如下：
image
参数解读：

  • 参数1：必选参数，需要指定一个文件路径的字符串，表示文件的存放路径。
  • 参数2：必选参数，表示要写入的内容。
  • 参数3：可选参数，表示以什么格式写入文件内容，默认值是 utf8。
  • 参数4：必选参数，文件写入完成后的回调函数。

向指定的文件路径中，写入文件内容：
image

// 1. 导入 fs 文件系统模块
const fs = require('fs')
 
// 2. 调用 fs.writeFile() 方法，写入文件的内容
//    参数1：表示文件的存放路径
//    参数2：表示要写入的内容
//    参数3：回调函数
fs.writeFile('./files/3.txt', 'ok123', function(err) {
  // 2.1 如果文件写入成功，则 err 的值等于 null
  // 2.2 如果文件写入失败，则 err 的值等于一个 错误对象
  // console.log(err)
 
  if (err) {
    return console.log('文件写入失败！' + err.message)
  }
  console.log('文件写入成功！')
})

判断文件是否写入成功

const fs = require('fs')
fs.writeFile('./files/3.txt', 'ok123', function(err) {
  // 2.1 如果文件写入成功，则 err 的值等于 null
  // 2.2 如果文件写入失败，则 err 的值等于一个 错误对象
  if (err) {
    return console.log('文件写入失败！' + err.message)
  }
  console.log('文件写入成功！')
})

练习
考试成绩整理
使用 fs 文件系统模块，将素材目录下成绩.txt文件中的考试数据，整理到成绩-ok.txt文件中。
整理前，成绩.txt文件中的数据格式如下：
image
整理完成之后，希望得到的成绩-ok.txt文件中的数据格式如下：
image
核心实现步骤

  1. 导入需要的 fs 文件系统模块
  2. 使用 fs.readFile() 方法，读取素材目录下的 成绩.txt 文件
  3. 判断文件是否读取失败
  4. 文件读取成功后，处理成绩数据
  5. 将处理完成的成绩数据，调用 fs.writeFile() 方法，写入到新文件 成绩-ok.txt 中

自己写的（更简单）

const fs =require('fs')
fs.readFile('../素材/成绩.txt','utf8',function(err,data){
    if(err){
        return console.log("读取文件失败！"+err.message);
    }
    console.log("读取文件成功！"+data);
    // 注意不要写成data.replace(' ','\r\n')，这样一是没有将修改后的值赋给data，二是replace()只是修改第一个匹配的字符，不会修改全部
    // Windows系统里面，每行结尾是“<回车><换行>”，即“\r\n”
    // 注意以下2行的先后次序不能颠倒
    data=data.replaceAll(' ','\r\n')
    data=data.replaceAll('=',': ')
    // 将结果写入
    fs.writeFile('files/成绩-ok.txt',data,'utf8',function(){
        if(err){
            return console.log("写入文件失败！"+err.message);
        }
        console.log("写入文件成功！\r\n"+data);
    })
 
})

回车\r换行\n区别详见https://www.cnblogs.com/road2code/p/17192269.html

路径动态拼接的问题

在使用 fs 模块操作文件时，如果提供的操作路径是以 ./ 或 ../ 开头的相对路径时，很容易出现路径动态拼接错误的问题。
原因：代码在运行的时候，会以执行 node 命令时所处的目录，动态拼接出被操作文件的完整路径。

const fs = require('fs')
 
fs.readFile('./files/1.txt', 'utf8', function(err, dataStr) {
  if (err) {
    return console.log('读取文件失败！' + err.message)
  }
  console.log('读取文件成功！' + dataStr)
})

image
当node命令执行的路径与要执行的文件的路径不一致时就会出现拼接错误
解决办法

  1. 用绝对路径(不推荐)
    在使用 fs 模块操作文件时，直接提供完整的路径，不要提供 ./ 或 ../ 开头的相对路径
// windows中的路径是反斜杠，所以需要‘\\’转义成'\'
fs.readFile('C:\\Users\\escook\\Desktop\\Node.js基础\\day1\\code\\files\\1.txt', 'utf8', function(err, dataStr) {
  if (err) {
    return console.log('读取文件失败！' + err.message)
  }
  console.log('读取文件成功！' + dataStr)
})

image
缺点：

  • 移植性差，当将要执行的文件放到其他路径时，需要执行文件中的修改该绝对路径
  • 书写不方便，不简洁
  1. 利用内置变量__dirname（推荐）
    __dirname 表示当前文件所处的目录，它不会因node命令执行的路径而改变。这样就不用因为执行文件的路径的更改而更改了
console.log(__dirname)
fs.readFile(__dirname + '/files/1.txt', 'utf8', function(err, dataStr) {
  if (err) {
    return console.log('读取文件失败！' + err.message)
  }
  console.log('读取文件成功！' + dataStr)
})

image

path 路径模块

path 模块是 Node.js 官方提供的、用来处理路径的模块。它提供了一系列的方法和属性，用来满足用户对路径的处理
需求。
如果要在 JavaScript 代码中，使用 path 模块来处理路径，则需要使用如下的方式先导入它：
const path=require('path')
下面是一部分path 路径模块的方法

  1. 路径拼接-path.join()
    使用 path.join() 方法，可以把多个路径片段拼接为完整的路径字符串
    image
    参数解读：
    ⚫ ...paths, string类型， 路径片段的序列
    ⚫ 返回值: string类型
    用path.join()时，路径中'../' 会抵消一层前面的路径，'./'则忽略
const path = require('path')
const fs = require('fs')
 
// '../' 会抵消一层前面的路径，'./'则忽略
// const pathStr = path.join('/a', '/b/c', '../../', './d', 'e')
// console.log(pathStr)  // \a\d\e
//‘+’无法识别相对路径符号'../'和'./'
// fs.readFile(__dirname + '.././/files/1.txt')//路径=当前文件路径+.././/files/1.txt，会报错
 
fs.readFile(path.join(__dirname, './files/1.txt'), 'utf8', function(err, dataStr) {
  if (err) {
    return console.log(err.message)
  }
  console.log(dataStr)
})
const path = require('path')
const fs = require('fs')
fs.readFile(__dirname+'.././files/1.txt', 'utf8', function(err, dataStr) {
  console.log(__dirname+'.././files/1.txt')
  if (err) {
    return console.log(err.message)
  }
  console.log(dataStr)
})

image

注意：今后凡是涉及到路径拼接的操作，都要使用 path.join() 方法进行处理。不要直接使用 + 进行字符串的拼接，因为用‘+’无法识别相对路径符号'../'和'./'

  1. 获取路径中的文件名-path.basename()
    使用 path.basename() 方法，可以获取路径中的最后一部分，经常通过这个方法获取路径中的文件名，语法格式如下：
    image
    参数解读：
    ⚫ path :string, 必选参数，表示一个路径的字符串
    ⚫ ext :string, 可选参数，表示文件扩展名
    ⚫ 返回: string ,表示路径中的最后一部分
const path = require('path')
// 定义文件的存放路径
const fpath = '/a/b/c/index.html'
// 输出文件名（包含扩展名）
const fullName = path.basename(fpath)
console.log(fullName)
// 输出不带扩展名的文件名
const nameWithoutExt = path.basename(fpath, '.html')
console.log(nameWithoutExt)

image

  1. 获取路径中的文件扩展名-path.extname()
    使用 path.extname() 方法，可以获取路径中的扩展名部分，语法格式如下：
    path.extname(path)
    参数解读：
    ⚫ path：string，必选参数，表示一个路径的字符串
    ⚫ 返回: string， 返回得到的扩展名字符串
const path = require('path')
// 这是文件的存放路径
const fpath = '/a/b/c/index.html'
const fext = path.extname(fpath)
console.log(fext)

image

练习
时钟案例
将素材目录下的 index.html 页面，拆分成三个文件，分别是：
⚫ index.css
⚫ index.js
⚫ index.html
并且将拆分出来的 3 个文件，存放到 clock 目录中
原html文件如下

点击查看代码 
<!DOCTYPE html>
<html lang="en">
 
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>index首页</title>
  <style>
    html,
    body {
      margin: 0;
      padding: 0;
      height: 100%;
      background-image: linear-gradient(to bottom right, red, gold);
    }
 
    .box {
      width: 400px;
      height: 250px;
      background-color: rgba(255, 255, 255, 0.6);
      border-radius: 6px;
      position: absolute;
      left: 50%;
      top: 40%;
      transform: translate(-50%, -50%);
      box-shadow: 1px 1px 10px #fff;
      text-shadow: 0px 1px 30px white;
 
      display: flex;
      justify-content: space-around;
      align-items: center;
      font-size: 70px;
      user-select: none;
      padding: 0 20px;
 
      /* 盒子投影 */
      -webkit-box-reflect: below 0px -webkit-gradient(linear, left top, left bottom, from(transparent), color-stop(0%, transparent), to(rgba(250, 250, 250, .2)));
    }
  </style>
</head>
 
<body>
  <div class="box">
    <div id="HH">00</div>
    <div>:</div>
    <div id="mm">00</div>
    <div>:</div>
    <div id="ss">00</div>
  </div>
 
  <script>
    window.onload = function () {
      // 定时器，每隔 1 秒执行 1 次
      setInterval(() => {
        var dt = new Date()
        var HH = dt.getHours()
        var mm = dt.getMinutes()
        var ss = dt.getSeconds()
 
        // 为页面上的元素赋值
        document.querySelector('#HH').innerHTML = padZero(HH)
        document.querySelector('#mm').innerHTML = padZero(mm)
        document.querySelector('#ss').innerHTML = padZero(ss)
      }, 1000)
    }
 
    // 补零函数
    function padZero(n) {
      return n > 9 ? n : '0' + n
    }
  </script>
</body>
 
</html>

实现步骤
① 创建两个正则表达式，分别用来匹配 <style> 和 <script> 标签
② 使用 fs 模块，读取需要被处理的 HTML 文件
③ 将匹配并修改好的css写入 index.css 样式文件
④ 将匹配并修改好的js写入 index.js 脚本文件
⑤ 将修改好的html来写入 index.html 文件
参考答案

const fs=require('fs')
const path=require('path')
// 匹配CSS样式的正则表达式，*表示0或多个，+表示1个及以上，？表示0或1个
// [\s\S]*表示匹配0个及以上的空格或非空格
const regCSS=/<style>[\s\S]*<\/style>/g;
// 匹配JS的正则表达式
const regJS=/<script>[\s\S]*<\/script>/g;
// 读入原始html文件
fs.readFile('../素材/index.html','utf8',function(err,dataStr){
    if(err){
        return console.log("读取文件失败! "+err.message);
    }
    console.log("读取文件成功!");
    // 提取出css与js，并去除标签
    // 因为调用的是replaceAll()，所以正则表达式要加上g，表示全局匹配
    // 注意exec()返回的是一个字符串类型的数组，所以别忘了写下标[0]
	// 正则表达式作为函数参数时不要加引号，加引号就变成了字符串
    const css=(regCSS.exec(dataStr))[0].replaceAll(/<\/?style>/g,'')
    const js=(regJS.exec(dataStr))[0].replaceAll(/<\/?script>/g,'')
    // 去除原文件中的css和JS，并替代为外链引入的方式
    const html=dataStr.replaceAll(regCSS,'<link rel="stylesheet" href="index.css">').replaceAll(regJS,'<script src="index.js"></script>')
    // 将CSS单独写入一个文件中
    fs.writeFile(path.join(__dirname,'clock/index.css'),css,'utf8',function(err,dataStr){
        if(err){
            return console.log("CSS写入失败! "+err.message);
        }
        console.log("CSS写入成功！");
    })
    // 将JS单独写入一个文件中
    fs.writeFile(path.join(__dirname,'clock/index.js'),js,'utf8',function(err,dataStr){
        if(err){
            return console.log("JS写入失败! "+err.message);
        }
        console.log("JS写入成功！");
    })
    // 将新的html单独写入一个文件中
    fs.writeFile(path.join(__dirname,'clock/index.html'),html,'utf8',function(err,dataStr){
        if(err){
            return console.log("HTML写入失败! "+err.message);
        }
        console.log("HTML写入成功！");
    })
})

image

注意点

  • fs.writeFile() 方法只能用来创建文件，不能用来创建路径，如果路径没有事先创建好（不包括文件），则会导致写入失败
  • 重复调用 fs.writeFile() 写入同一个文件，新写入的内容会覆盖之前的旧内容
  • 书写字符串里面的内容时不要拼写错误，因为编辑器不会检查字符串里面的内容，拼写错了不容易发现

http 模块

在网络节点中，负责消费资源的电脑，叫做客户端；负责对外提供网络资源的电脑，叫做服务器。
http 模块是 Node.js 官方提供的、用来创建 web 服务器的模块。通过 http 模块提供的 http.createServer() 方法，就
能方便的把一台普通的电脑，变成一台 Web 服务器，从而对外提供 Web 资源服务。
如果要希望使用 http 模块创建 Web 服务器，则需要先导入它：
const http = require('http')
服务器和普通电脑的区别在于，服务器上安装了 web 服务器软件，例如：IIS（用aspx、.net）、Apache（用php） 等。通过安装这些服务器软件，就能把一台普通的电脑变成一台 web 服务器。
在 Node.js 中，我们不需要使用 IIS、Apache 等这些第三方 web 服务器软件。因为我们可以基于 Node.js 提供的http 模块，通过几行简单的代码，就能轻松的手写一个服务器软件，从而对外提供 web 服务

服务器相关的概念

  1. IP 地址
    IP 地址就是互联网上每台计算机的唯一地址，因此 IP 地址具有唯一性。如果把“个人电脑”比作“一台电话”，那么“IP地址”就相当于“电话号码”，只有在知道对方 IP 地址的前提下，才能与对应的电脑之间进行数据通信。
    IP 地址的格式：通常用“点分十进制”表示成（a.b.c.d）的形式，其中，a,b,c,d 都是 0~255 之间的十进制整数。例如：用点分十进表示的 IP地址（192.168.1.1）
    注意：
    ① 互联网中每台 Web 服务器，都有自己的 IP 地址，例如：大家可以在 Windows 的终端中运行 ping www.baidu.com 命令，即可查看到百度服务器的 IP 地址。
    image
    ② 在开发期间，自己的电脑既是一台服务器，也是一个客户端，为了方便测试，可以在自己的浏览器中输入 127.0.0.1 这个IP 地址，就能把自己的电脑当做一台服务器进行访问了。

  2. 域名和域名服务器
    尽管 IP 地址能够唯一地标记网络上的计算机，但IP地址是一长串数字，不直观，而且不便于记忆，于是人们又发明了另一套字符型的地址方案，即所谓的域名（Domain Name）地址。
    IP地址和域名是一一对应的关系，这份对应关系存放在一种叫做域名服务器(DNS，Domain name server)的电脑中。使用者只需通过好记的域名访问对应的服务器即可，对应的转换工作由域名服务器实现。因此，域名服务器就是提供 IP 地址和域名之间的转换服务的服务器。
    注意：
    ① 单纯使用 IP 地址，互联网中的电脑也能够正常工作。但是有了域名的加持，能让互联网的世界变得更加方便。网站的IP地址可能会更改，但域名不会更改
    ② 在开发测试期间， 127.0.0.1 对应的域名是 localhost，它们都代表我们自己的这台电脑，在使用效果上没有任何区别。

  3. 端口号
    计算机中的端口号，就好像是现实生活中的门牌号一样。通过门牌号，外卖小哥可以在整栋大楼众多的房间中，准确把外卖送到你的手中。
    同样的道理，在一台电脑中，可以运行成百上千个 web 服务。每个 web 服务都对应一个唯一的端口号。客户端发送过来的网络请求，通过端口号，可以被准确地交给对应的 web 服务进行处理。
    注意：
    ① 每个端口号不能同时被多个 web 服务占用。
    ② 在实际应用中，URL 中的 80 端口可以被省略。
    image

创建最基本的 web 服务器

  1. 创建 web 服务器的基本步骤
    ① 导入 http 模块：如果希望在自己的电脑上创建一个 web 服务器，从而对外提供 web 服务，则需要导入 http 模块
    image
    ② 创建 web 服务器实例：调用 http.createServer() 方法，即可快速创建一个 web 服务器实例
    image
    ③ 为服务器实例绑定 request 事件，监听客户端发送过来的网络请求
    image
    ④ 启动服务器：调用服务器实例的 .listen() 方法，即可启动当前的 web 服务器实例
    image
// 1. 导入 http 模块
const http = require('http')
// 2. 创建 web 服务器实例
const server = http.createServer()
// 3. 为服务器实例绑定 request 事件，监听客户端的请求
// 这个绑定方法类似于jQuery中的$("xx").on("事件","触发事件的对象",function(){})
server.on('request', function (req, res) {
  console.log('Someone visit our web server.')
})
// 4. 启动服务器
server.listen(8080, function () {  
  console.log('server running at http://127.0.0.1:8080')
})

image
在终端停止服务：Ctrl+C

  1. req 请求对象
    req.url
    只要服务器接收到了客户端的请求，就会调用通过 server.on() 为服务器绑定的 request 事件处理函数。
    如果想在事件处理函数中，访问与客户端相关的数据或属性，可以使用如下的方式：
    image
    req.url不包含固定前缀

  2. res 响应对象
    在服务器的 request 事件处理函数中，如果想访问与服务器相关的数据或属性，可以使用如下的方式：
    image
    当调用 res.end() 方法，向客户端发送中文内容的时候，会出现乱码问题，此时，需要手动设置内容的编码格式：
    res.setHeader('Content-Type', 'text/html; charset=utf-8')这是固定的内容
    image

image

根据不同的 url 响应不同的 html 内容

  1. 核心实现步骤
    ① 获取请求的 url 地址
    ② 设置 Content-Type 响应头，防止中文乱码
    ③ 判断用户请求的是否为 / 或 /index.html 首页，是则返回相应内容
    ④ 判断用户请求的是否为 /about.html 关于页面，是则返回相应内容
    ⑤ 如果请求的是其他内容则显示 404 Not found
const http = require('http')
const server = http.createServer()
server.on('request', (req, res) => {
    // 注意 Content-Type 响应头要在res.end()之前设置
    res.setHeader("Content-Type", "text/html;charset=utf-8;")
    if(req.url === '/' || req.url === '/index.html'){
        res.end("<h1>首页</h1>")
    }
    else if (req.url === '/about.html') {
        res.end("<h1>关于</h1>")
    }
    else {
        res.end("<h1>404 Not found!</h1>")
    }
})
 
server.listen(8080, () => {
    console.log('Server running at http://127.0.0.1:8080');
})

练习
实现 clock 时钟的 web 服务器

  1. 核心思路
    把文件的实际存放路径，作为每个资源的请求 url 地址
    image
  2. 实现步骤
    ① 导入需要的模块
    ② 创建基本的 web 服务器
    ③ 将资源的请求 url 地址映射为文件的存放路径
    ④ 读取文件内容并响应给客户端
const fs =require('fs')
const path=require('path')
const http=require('http')
const server=http.createServer()
server.on('request',(req,res)=>{
    // res.setHeader("Content-Type","text/html;charset=utf-8")// 不知道为什么加上这行后读取index.html就渲染不了css样式，但是删除这行中文就会乱码
    let fpath
    if(req.url==='/'){
        fpath=path.join(__dirname,'./clock/index.html')
    }else{
        fpath= path.join(__dirname,'./clock',req.url)
    }
    fs.readFile(fpath,'utf8',(err,data)=>{
        if(err) return res.end("<h1>404 Not found! </h1>")
        res.end(data)
    })
})
server.listen(8080,()=>{
    console.log('Server running at http://127.0.0.1:8080');
})

模块化

模块化的基本概念

模块化是指解决一个复杂问题时，自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说，模块是可组合、分解和更换的单元
编程领域中的模块化，就是遵守固定的规则，把一个大文件拆成独立并互相依赖的多个小模块
把代码进行模块化拆分的好处：
① 提高了代码的复用性
② 提高了代码的可维护性
③ 可以实现按需加载
模块化规范就是对代码进行模块化的拆分与组合时，需要遵守的那些规则。
例如：
⚫ 使用什么样的语法格式来引用模块
⚫ 在模块中使用什么样的语法格式向外暴露成员
模块化规范的好处：大家都遵守同样的模块化规范写代码，降低了沟通的成本，极大方便了各个模块之间的相互调用，
利人利己。

Node.js 中模块化

  1. Node.js 中模块的分类
    Node.js 中根据模块来源的不同，将模块分为了 3 大类，分别是：
    ⚫ 内置模块（内置模块是由 Node.js 官方提供的，例如 fs、path、http 等）
    ⚫ 自定义模块（用户创建的每个 .js 文件，都是自定义模块）
    ⚫ 第三方模块（由第三方开发出来的模块，并非官方提供的内置模块，也不是用户创建的自定义模块，使用前需要先下载）
    使用强大的 require() 方法，可以加载需要的内置模块、用户自定义模块、第三方模块进行使用
    image
    注意：使用 require() 方法加载模块时，会执行被加载模块中的代码

  2. Node.js 中的模块作用域
    和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，这种模块级别的访问限制，叫做模块作用域
    image
    模块作用域的好处：防止了全局变量污染的问题
    image

  3. Node.js 中的模块化规范
    Node.js 遵循了 CommonJS 模块化规范，CommonJS 规定了模块的特性和各模块之间如何相互依赖。
    CommonJS 规定：
    ① 每个模块内部，module 变量代表当前模块。
    ② module 变量是一个对象，它的 exports 属性（即 module.exports）是对外的接口。
    ③ 加载某个模块，其实是加载该模块的 module.exports 属性。require() 方法用于加载模块。

向外共享模块作用域中的成员

  1. module 对象
    在每个 .js 自定义模块中都有一个 module 对象，它里面存储了和当前模块有关的信息，打印如下：
    image
  2. module.exports 对象
    在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。外界用 require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象
  3. exports 对象
    由于 module.exports 单词写起来比较复杂，为了简化向外共享成员的代码，Node 提供了 exports 对象。默认情况下，exports 和 module.exports 指向同一个内容为空的对象。最终共享的结果，还是以 module.exports 指向的对象为准。
    image
    exports 对象只是为了书写方便
  4. 共享成员时的注意点
    使用 require() 方法导入模块时，导入的结果，永远以 module.exports 指向的对象为准
    image
  5. exports 和 module.exports 的使用误区
    案例1
exports.username = 'zs'
module.exports = {
  gender:'男',
  age:22
}

{ gender: '男', age: 22 }
因为module.exports后来指向了其他对象
image

案例2

module.exports.username = 'zs'
exports = {
  gender:'男',
  age:22
}

{ username: 'zs' }
exports指向了其他对象，但用 require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象
image

案例3

exports.username = 'zs'
module.exports.gender='男'

{ username: 'zs', gender: '男' }
exports和module.exports没有指向其他对象，他们指向的是同一个对象，所做的更改会互相影响，所以有2个属性
image

案例4

exports = {
  username:'zs',
  gender:'男'
}
// 让module.exports指向exports指向的新对象
module.exports= exports
module.exports.age='22'

{ username: 'zs', gender: '男', age: '22' }
exports先指向创建的新对象，然后把exports指向的新对象的地址赋给module.exports，然后通过module.exports给这个新对象添加age属性
image

如果删除module.exports= exports该语句，那么结果将会是{ age: '22' }，因为module.exports还是指向原来的对象，module.exports.age='22'给原来对象添加了age属性

exports = {
  username:'zs',
  gender:'男'
}
// 让module.exports指向exports指向的新对象
// module.exports= exports
module.exports.age='22'

注意：为了防止混乱，建议要在同一个模块中同时使用 exports 和 module.exports，以防exports和module.exports指向的不是同一个对象。为了方便在模块中只使用exports

npm与包

包简述

  1. 什么是包
    Node.js 中的第三方模块又叫做包。
    就像电脑和计算机指的是相同的东西，第三方模块和包指的是同一个概念，只不过叫法不同。
  2. 包的来源
    不同于 Node.js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用。
    注意：Node.js 中的包都是免费且开源的，不需要付费即可免费下载使用。
  3. 为什么需要包
    由于 Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发的时，效率很低。
    包是基于内置模块封装出来的，提供了更高级、更方便的 API，极大的提高了开发效率。
    包和内置模块之间的关系，类似于 jQuery 和 浏览器内置 API 之间的关系。
  4. 从哪里下载包
    国外有一家 IT 公司，叫做 npm, Inc. 这家公司旗下有一个非常著名的网站： https://www.npmjs.com/ ，它是全球最大的包共享平台，你可以从这个网站上搜索到任何你需要的包，只要你有足够的耐心！
    到目前为止，全球约 1100 多万的开发人员，通过这个包共享平台，开发并共享了超过 120 多万个包 供我们使用。
    npm, Inc. 公司提供了一个地址为 https://registry.npmjs.org/ 的服务器，来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。
    注意：
    ⚫ 从 https://www.npmjs.com/ 网站上搜索自己所需要的包
    ⚫ 从 https://registry.npmjs.org/ 服务器上下载自己需要的包
  5. 如何下载包
    npm, Inc. 公司提供了一个包管理工具，我们可以使用这个包管理工具，从 https://registry.npmjs.org/ 服务器把需要的包下载到本地使用。
    这个包管理工具的名字叫做 Node Package Manager（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。
    大家可以在终端中执行 npm -v 命令，来查看自己电脑上所安装的 npm 包管理工具的版本号：
    image

安装npm包

如果想在项目中安装指定名称的包，需要运行如下的命令：
npm install 包名称
也可以简写成
npm i 包名称
初次装包完成后，在项目文件夹下多一个叫做 node_modules 的文件夹和 package-lock.json 的配置文件。
其中：
node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时，就是从这个目录中查找并加载包。
package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。
注意：不要手动修改 node_modules 或 package-lock.json 文件中的任何代码，npm 包管理工具会自动维护它们

  1. 安装指定版本的包
    默认情况下，使用 npm install 命令安装包的时候，会自动安装最新版本的包。如果需要安装指定版本的包，可以在包名之后，通过 @ 符号指定具体的版本，例如
    npm i moment@2.22.2
    如果安装的是同一个包（指包名称相同，只是版本号不同），不用卸载之前安装的包，后面安装的包会覆盖之前的

  2. 更新包
    再安装一次即可，因为默认安装最新版本的包，新安装的会覆盖之前的版本
    image

  3. 包的语义化版本规范
    包的版本号是以“点分十进制”形式进行定义的，总共有三位数字，例如 2.24.0
    其中每一位数字所代表的的含义如下：
    第1位数字：大版本, 从底层进行了重新设计，有较大的更改
    第2位数字：功能版本，增添或更改了功能
    第3位数字：Bug修复版本
    版本号提升的规则：只要前面的版本号增长了，则后面的版本号归零。

引入并使用npm包

  1. 格式化时间的传统做法
    思路：
    ① 创建格式化时间的自定义模块
    ② 定义格式化时间的方法
    ③ 创建补零函数
    ④ 从自定义模块中导出格式化时间的函数
    ⑤ 导入格式化时间的自定义模块
    ⑥ 调用格式化时间的函数

文件名：myOwn_15.js

// 定义格式化时间的方法
function dateFormat(date) {
    // 以下Date实例方法返回值类型均为number
    let y = date.getFullYear()
    let m = zero(date.getMonth() + 1)
    let d = zero(date.getDate())
    let h = zero(date.getHours())
    let mi = zero(date.getMinutes())
    let s = zero(date.getSeconds())
    // 别忘了写return, 不是console.log(`${y}-${m}-${d} ${h}:${mi}:${s}`)
    return `${y}-${m}-${d} ${h}:${mi}:${s}`;
}
// 定义补零的函数
function zero(t) {
    return t = t < 9 ? '0' + t : t;
}
// 从自定义模块中导出格式化时间的函数, 即暴露接口
module.exports = {
    dateFormat
}

文件名: 16.test.js

// 导入自定义的格式化时间的模块
const TIME = require('./myOwn_15.js')
// 调用方法，进行时间的格式化
const dt = new Date()
console.log(dt)
const newDT = TIME.dateFormat(dt)
console.log(newDT)

image
2. 引入对时间格式化的npm包
① 使用 npm 包管理工具，在项目中安装格式化时间的包 moment
② 使用 require() 导入格式化时间的包
③ 参考 moment 的官方 API 文档对时间进行格式化

var moment = require('moment'); // require
console.log(moment().format("YYYY-MM-DD HH:mm:ss"));

包管理配置文件

npm 规定，在项目根目录中，必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置信息。例如：
⚫ 项目的名称、版本号、描述等
⚫ 项目中都用到了哪些包
⚫ 哪些包只在开发期间会用到
⚫ 那些包在开发和部署时都需要用到

  1. 多人协作的问题
    image
    整个项目的体积是 30.4M，第三方包的体积是 28.8M，项目源代码的体积 1.6M
    遇到的问题：第三方包的体积过大，不方便团队成员之间共享项目源代码。
    解决方案：共享时剔除node_modules

  2. 记录项目中安装的包
    在项目根目录中，创建一个叫做 package.json 的配置文件，即可用来记录项目中安装了哪些包。从而方便剔除node_modules 目录之后，在团队成员之间共享项目的源代码。
    注意：今后在项目开发中，一定要把 node_modules 文件夹，添加到 .gitignore 忽略文件中。

  3. 快速创建 package.json
    npm 包管理工具提供了一个快捷命令，可以在执行命令时所处的目录中，快速创建 package.json 这个包管理配置文件：
    npm init -y
    注意：
    ① 上述命令只能在英文目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格
    ② 运行 npm install 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中。

  4. dependencies 节点
    package.json 文件中，有一个 dependencies 节点，专门用来记录您使用 npm install命令安装了哪些包。
    image

  5. 一次性安装所有的包
    当我们拿到一个剔除了 node_modules 的项目之后，需要先把所有的包下载到项目中，才能将项目运行起来。
    否则会报类似于下面的错误：
    image
    可以运行 npm install 命令（或 npm i）一次性安装所有的依赖包：
    image

  6. 卸载包
    可以运行 npm uninstall 命令，来卸载指定的包：
    image
    npm uninstall 命令执行成功后，会把卸载的包，自动从 package.json 的 dependencies 中移除掉。

  7. devDependencies 节点
    如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到 devDependencies 节点中。
    与之对应的，如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到 dependencies 节点中。
    您可以使用如下的命令，将包记录到 devDependencies 节点中
    可以使用如下的命令，将包记录到 devDependencies 节点中：（不要求包名与-D的顺序）
    image

解决包下载速度慢的问题

为什么下包速度慢?
在使用 npm 下包的时候，默认从国外的 https://registry.npmjs.org/ 服务器进行下载，此时，网络数据的传输需要经过漫长的海底光缆，因此下包速度会很慢。
解决办法

  1. 切换 npm 的下包镜像源
    下载包的镜像源，指的就是下包的服务器地址。
    淘宝 NPM 镜像服务器
    淘宝在国内搭建了一个服务器，专门把国外官方服务器上的包同步到国内的服务器，然后在国内提供下包的服务。从而极大的提高了下包的速度。
    镜像/.iso文件：镜像（Mirroring）是一种文件存储形式，一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本即为镜像。
    image

image

image

# 查看当前的下包镜像源
npm config get registry
# 将下包镜像源切换为淘宝镜像源，注意网址不要写错
npm config set registry=https://registry.npm.taobao.org/
# 检查新的下包镜像源是否设置成功
npm config get registry

image

使用nrm工具方便镜像源的切换
为了更方便的切换下包的镜像源，我们可以安装 nrm 这个小工具，利用 nrm 提供的终端命令，可以快速查看和切换下包的镜像源
参数-g表示安装到全局
image
有*号的表示当前使用的下包镜像源
image
image
可能遇到的问题：
在Windows系统中，在VSCode的终端里运行nrm命令可能失败，因为Windows系统上禁止以这种方式运行脚本。而在Windows的cmd终端中可以运行。要想在VSCode里的终端运行nrm命令，解决办法是在nrm命令前加上npx
image

  1. 使用cnpm命令代替npm
    cnpm install 包下载地址

包的分类

使用 npm 包管理工具下载的包，共分为两大类，分别是：
⚫ 项目包
⚫ 全局包

  1. 项目包
    那些被安装到项目的 node_modules 目录中的包，都是项目包。
    项目包又分为两类，分别是：
    ⚫ 开发依赖包（被记录到 devDependencies 节点中的包，只在开发期间会用到）
    ⚫ 核心依赖包（被记录到 dependencies 节点中的包，在开发期间和项目上线之后都会用到）
    下载包时使用以下2个命令，会记录到不同的依赖中
    image
  2. 全局包
    在执行 npm install 命令时，如果提供了 -g 参数（表示安装到全局），则会把包安装为全局包。
    全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下。
    image

image
注意：
① 只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。
② 判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。

工具i5ting_toc
i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具，-o表示转换后自动用默认浏览器打开，使用步骤如下：
image

包结构

在清楚了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。
一个规范的包，它的组成结构，必须符合以下 3 点要求：
① 包必须以单独的目录而存在
② 包的顶级目录下要必须包含 package.json 这个包管理配置文件
image
③ package.json 中必须包含 name，version，main 这三个属性，分别代表包的名字、版本号、包的入口（即导入模块时执行的js文件）
image
注意：以上 3 点要求是一个规范的包结构必须遵守的格式，关于更多的约束，可以参考如下网址：
https://yarnpkg.com/zh-Hans/docs/package-json

开发属于自己的包

  1. 需要实现的功能
    ① 格式化日期
    ② 转义 HTML 中的特殊字符
    ③ 还原 HTML 中的特殊字符
  2. 初始化包的基本结构
    去官网https://www.npmjs.com/ 查询自己想要取的包名是否和npm库中的包名重复
    ① 新建 tools 文件夹，作为包的根目录
    ② 在 tools 文件夹中，必须要有以下文件：
    ⚫ package.json （包管理配置文件）
    json中不能写注释且不用单引号，这里为了方便解释含义才写注释的
{
// 包名，在npm库中应唯一，下载该包后引用该npm包的格式是require("tools-code6e")
    "name": "tools-code6e",
	// 从1.0.0开始
    "version": "1.0.0",
	// js入口文件，即引用该包后从这里开始执行，require()加载的入口文件
    "main": "tools.js",
	//搜索时会展现该描述，主要描述基本的功能
    "description": "提供了格式化时间，转义及还原HTML字符的功能",
	// 关键字
    "keywords": [
        "dateFormat",
        "escape",
        "unescape"
    ],
	// 协议类型
    "license": "ISC",
    "dependencies": {
        "tools-code6e": "^1.0.0"
    }
}

image

关于更多 license 许可协议相关的内容，可参考 https://www.jianshu.com/p/86251523e898
⚫ tools.js （包的入口文件, 文件名不固定，自己取）
⚫ README.md （包的说明文档）
tools中的其他文件可自行设置
image

  1. 将不同的功能进行模块化拆分
    ① 将格式化时间的功能，拆分到 src -> dateFormat.js 中
  • dateFormat
// 定义格式化时间的方法
function dateFormat(date) {
    // 以下Date实例方法返回值类型均为number
    let y = date.getFullYear()
    let m = zero(date.getMonth() + 1)
    let d = zero(date.getDate())
    let h = zero(date.getHours())
    let mi = zero(date.getMinutes())
    let s = zero(date.getSeconds())
    // 别忘了写return, 不是console.log(`${y}-${m}-${d} ${h}:${mi}:${s}`)
    return `${y}-${m}-${d} ${h}:${mi}:${s}`;
}
// 定义补零的函数
function zero(t) {
    return t = t < 9 ? '0' + t : t;
}
// 从自定义模块中导出格式化时间的函数, 即暴露接口
module.exports = {
    dateFormat
}

② 将处理 HTML 字符串的功能，拆分到 src -> htmlEscape.js 中

  • htmlEscape
// 定义转义 HTML 字符的函数
function htmlEscape(htmlStr){
    // 别忘了将htmlStr.replace()的返回值返回给htmlEscape()
    return htmlStr.replace(/<|"|>|&/g,(match)=>{
        switch(match){
            case '<':
                return '&lt;'
            case '"':
                return '&quot;'
            case '>':
                return '&gt;'
            case '&':
                return '&amp;'
        }
    })
}
// 定义还原 HTML 字符的函数
function htmlUnEscape(str){
    return str.replace(/&lt;|&quot;|&gt;|&amp;/g,(match)=>{
        switch(match){
            case '&lt;':
                return '<'
            case '&quot;':
                return '"'
            case '&gt;':
                return '>'
            case '&amp;':
                return '&'
        }
    })
}
 
module.exports={
    htmlEscape,
    htmlUnEscape
}

③ 在 tools.js 中，导入两个模块，得到需要向外共享的方法
④ 在 tools.js 中，使用 module.exports 把对应的方法共享出去

// 导入src中的模块
const date =require("./src/dateFormat.js")
const html =require("./src/htmlEscape")
// 把接口暴露出去供调用
module.exports={
    ...date,
    ...html
}

发布包之前要测试

// 这时还是以本地包的路径引入模块
const tools=require('./tools/tools.js')
console.log(tools.dateFormat(new Date()));
console.log("------");
let htmlStr='<h1 title="abc">这是h1标签<span>123&nbsp;</span></h1>'
console.log(tools.htmlEscape(htmlStr));
let str=tools.htmlEscape(htmlStr)
console.log("------");
console.log(tools.htmlUnEscape(str));

image

  1. 编写包的说明文档
    包根目录中的 README.md 文件，是包的使用说明文档。通过它，我们可以事先把包的使用说明，以 markdown 的格式写出来，方便用户参考。
    README 文件中具体写什么内容，没有强制性的要求；只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。
    我们所创建的这个包的 README.md 文档中，会包含以下 6 项内容：
    安装方式、导入方式、具体各项功能的用法参考、开源协议

  2. 发布包

    1. 登录 npm 账号：npm login
      image
      注意：在运行 npm login 命令之前，必须先把下包的服务器地址切换为 npm 的官方服务器。否则会导致发布包失败！
    2. 切换到包的根目录
    3. 运行 npm publish 命令，即可将包发布到 npm 上（注意：包名应唯一（就是package.json中的name属性应唯一，不是说包的文件夹名称要唯一），否则会导致包发布失败）
      image
      发布成功后可以查看都自己账户下新增了这个包, 并且可以在官网上查看下载该包
      image

  3. 测试：下载自己发布的包，看看能否正常使用

    1. 返回项目根目录
    2. npm i tools-code6e下载包
      image
      会发现下载的包文件夹在node_modules中，并且包文件夹名称与包的package.json中的name属性值一致
    3. 测试包功能是否正常
    		// 这时就不用以路径方式引入模块了，直接以包名的形式引入模块
    		const tools=require('tools-code6e')
    		console.log(tools.dateFormat(new Date()));
    		console.log("------");
    		let htmlStr='<h1 title="abc">这是h1标签<span>123&nbsp;</span></h1>'
    		console.log(tools.htmlEscape(htmlStr));
    		let str=tools.htmlEscape(htmlStr)
    		console.log("------");
    		console.log(tools.htmlUnEscape(str));

    正常运行
    image

  4. 删除已发布的包
    运行 npm unpublish 包名 --force 命令，即可从 npm 删除已发布的包。

注意：
① npm unpublish 命令只能删除 72 小时以内发布的包
② npm unpublish 删除的包，在 24 小时内不允许重复发布
③ 发布包的时候要慎重，尽量不要往 npm 上发布没有意义的包！

模块的加载机制

  1. 优先从缓存中加载
    模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次。
    注意：不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率。
    03.自定义模块.js
console.log('ok')

04.test.js

require('./03.自定义模块')
require('./03.自定义模块')
require('./03.自定义模块')

只执行了一次“03.自定义模块.js”
image
2. 内置模块的加载机制
内置模块是由 Node.js 官方提供的模块，内置模块的加载优先级最高。若有与内置模块同名的用户自定义模块或第三方模块，则优先加载内置模块
例如，require('fs') 始终返回内置的 fs 模块，即使在 node_modules 目录下有名字相同的包也叫做 fs。
3. 自定义模块的加载机制
示例

const m = require('./test')
console.log(m)

使用 require() 加载自定义模块时，必须指定以 ./ 或 ../ 开头的路径标识符。在加载自定义模块时，如果没有指定 ./ 或 ../ 这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载。
同时，在使用 require() 导入自定义模块时，如果省略了文件的扩展名，则 Node.js 会按以下顺序分别尝试加载以下的文件：
① 按照确切的文件名进行加载，test
② 补全 .js 扩展名进行加载, test.js
③ 补全 .json 扩展名进行加载, test.json
④ 补全 .node 扩展名进行加载, test.node
⑤ 加载失败，终端报错
4. 第三方模块的加载机制
如果传递给 require() 的模块标识符不是一个内置模块，也没有以 ‘./’ 或 ‘../’ 开头，则 Node.js 会从当前模块的父目录开始，尝试从 /node_modules 文件夹中加载第三方模块。
如果没有找到对应的第三方模块，则移动到再上一层父目录中，进行加载，直到文件系统的根目录。
例如，假设在 'C:\Users\itheima\project\foo.js' 文件里调用了 require('tools')，则 Node.js 会按以下顺序查找：
① C:\Users\itheima\project\node_modules\tools
② C:\Users\itheima\node_modules\tools
③ C:\Users\node_modules\tools
④ C:\node_modules\tools
5. 目录作为模块
image
require('./testm')
image
当把目录作为模块标识符，传递给 require() 进行加载的时候，有三种加载方式：
① 在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口
② 如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件。
③ 如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失：Error: Cannot find module 'xxx'

蓝桥考察范围：

  1. node.js基础
  2. 内置模块使用：fs,http等

本文作者：Road to Code

本文链接：https://www.cnblogs.com/road2code/p/17189680.html

版权声明：本作品采用知识共享署名-非商业性使用-禁止演绎 2.5 中国大陆许可协议进行许可。

posted @   Code6E  阅读(98)  评论(0)  编辑  收藏  举报
点击右上角即可分享
微信分享提示
💬
评论
📌
收藏
💗
关注
👍
推荐
🚀
回顶
➖
收起
  1. 1 404 not found REOL
404 not found - REOL
00:00 / 00:00
An audio error has occurred.