【精选】Node.js笔记总结(day3)

文章目录

• • Node第三天
  • • • 今日目标
      • 1. npm与包
      • • 1.1 包管理配置文件
        • 1.2 解决下包速度慢的问题
        • 1.3 包的分类
        • 1.4 规范的包结构
        • 1.5 开发属于自己的包
        • 1.6 发布包
      • 2. 模块的加载机制
      • • 2.1 优先从缓存中加载
        • 2.2 内置模块的加载机制
        • 2.3 自定义模块的加载机制
        • 2.4 第三方模块的加载机制
        • 2.5 目录作为模块
      • 3. 初识 Express
      • • 1、Express 简介
        • 2、Express 的基本使用
        • 3、托管静态资源
        • 4、nodemon

Node第三天

今日目标

• 能够使用 npm 管理包
• 了解如何开发包
• 了解如何发布包
• 能够了解模块的加载机制
• 熟悉 express基本操作

1. npm与包

1.1 包管理配置文件

npm 规定，在项目根目录中，必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置信息。

例如：

1、项目的名称、版本号、描述等

2、项目中都用到了哪些包

3、哪些包只在开发期间会用到

4、那些包在开发和部署时都需要用到

• 多人协作的问题

  

• 如何记录项目中安装了哪些包

  在项目根目录中，创建一个叫做 package.json 的配置文件，即可用来记录项目中安装了哪些包。从而方便剔除 node_modules 目录之后，在团队成员之间共享项目的源代码。

  注意：今后在项目开发中，一定要把 node_modules 文件夹，添加到 .gitignore 忽略文件中。

• 快速创建 package.json

  npm 包管理工具提供了一个快捷命令，可以在执行命令时所处的目录中，快速创建 package.json 这个包管理

  命令：

  // 作用：在执行命令所处的目录中，快速新建 package.json 文件
  npm init -y
  

  注意：

  1、上述命令只能在英文的目录下成功运行!所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格。

  2、运行 npm install 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中。

• dependencies 节点

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

  

• 一次性安装所有的包

  当我们拿到一个剔除了 node_modules 的项目之后，需要先把所有的包下载到项目中，才能将项目运行起来。

  否则会报类似于下面的错误：

  Error: Cannot find module 'moment'
  

  可以运行 npm install 命令(或 npm i)一次性安装所有的依赖包：

  npm install 或 npm i 
  

• 卸载包

可以运行 npm uninstall 命令，来卸载指定的包：

npm uninstall moment

注意：npm uninstall 命令执行成功后，会把卸载的包，自动从 package.json 的 dependencies 中移除掉。

• devDependencies 节点

  如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到 devDependencies 节点中。

  与之对应的，如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到 dependencies 节点中。

  您可以使用如下的命令，将包记录到 devDependencies 节点中：

  // 安装指定的包，并记录到 devDependencies 节点中
  npm i 包名 -D
  // 注意：上述命令为简写形式，等价于下面完整写法
  npm install 包名 --save-dev
  

1.2 解决下包速度慢的问题

• 为什么下包速度慢

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

  扩展阅读 - 海底光缆：

  • baike.baidu.com/item/%E6%B5…
  • baike.baidu.com/item/%E4%B8…
  • baike.baidu.com/item/APG/23…

• 淘宝 NPM 镜像服务器

  

• 切换 npm 的下包镜像源

  下包的镜像源，指的就是下包的服务器地址。

  // 查看当前下包的镜像源
  npm config get registry
  
  // 将下包的镜像源切换成淘宝镜像源
  npm config set registry=https://registry.npm.taobao.org/
  

• 解决下包速度慢的问题

  为了更方便的切换下包的镜像源，我们可以安装 nrm 这个小工具，利用 nrm 提供的终端命令，可以快速查看和切换下 包的镜像源。

  // 通过 npm 包管理工具，将 nrm安装为全局可用工具
  npm i nrm -g
  
  // 查看所有可用的镜像源
  nrm ls
  
  // 将下包的镜像源切换为淘宝镜像
  nrm use taobao
  

1.3 包的分类

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

1、项目包

2、全局包

• 项目包

  那些被安装到项目的 node_modules 目录中的包，都是项目包。

  项目包又分为两类，分别是：

  1、开发依赖包(被记录到 devDependencies 节点中的包，只在开发期间会用到)

  2、核心依赖包(被记录到 dependencies 节点中的包，在开发期间和项目上线之后都会用到)

• 全局包

  在执行 npm install 命令时，如果提供了 -g 参数，则会把包安装为全局包。

  全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下。

  npm i 包名 -g		// 全局安装指定包
  npm uninstall 包名 -g		// 卸载全局安装的包
  

  注意：
  1、只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。

  2、判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。

• i5ting_toc

  i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具，使用步骤如下：

  // 将 i5ting_toc 安装到全局
  npm i i5ting_toc -g
  
  // 调用 i5ting_toc 轻松实现 md 转换为 html 的功能
  i5ting_toc -f 要转换的md文件路径 -o
  

1.4 规范的包结构

在清楚了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。

一个规范的包，它的组成结构，必须符合以下 3 点要求：

1、包必须以单独的目录而存在

2、包的顶级目录下要必须包含 package.json 这个包管理配置文件

3、package.json 中必须包含 name，version，main 这三个属性，分别代表包的名字、版本号、包的入口。

注意：以上 3 点要求是一个规范的包结构必须遵守的格式，关于更多的约束，可以参考如下网址:

yarnpkg.com/zh-Hans/doc…

1.5 开发属于自己的包

• 需要实现的功能

  • 格式化日期

    

  • 转义 HTML 中的特殊字符

    

  • 还原 HTML 中的特殊字符

    

• 初始化包的基本结构

  步骤：

  1、新建 my_pkg_26 (可自定义)文件夹，作为包的根目录

  2、在 my_pkg_26 文件夹中，新建如下三个文件：

  • package.json (包管理配置文件)
  • index.js (包的入口文件)
  • README.md (包的说明文档)

• 初始化 package.json

  {
    "name": "my_util",
    "version": "1.0.1",
    "main": "index.js",
    "description": "提供了格式化时间，转译html字符等功能",
    "keywords": ["util", "dateFormat", "escape"],
    "license": "ISC"
  }
  

  关于更多 license 许可开源协议相关的内容，可参考 www.jianshu.com/p/86251523e…

• 在 index.js 中定义格式化时间的方法

  // 格式化时间方法
  function dateFormat(dateStr) {
    const dt = new Date(dateStr);
  
    const y = padZero(dt.getFullYear());
    const m = padZero(dt.getMonth() + 1);
    const d = padZero(dt.getDate());
  
    const hh = padZero(dt.getHours());
    const mm = padZero(dt.getMinutes());
    const ss = padZero(dt.getSeconds());
  
    return `${y}-${m}-${d} ${hh}:${mm}:${ss}`;
  }
  
  // 补零函数
  function padZero(n) {
    return n > 9 ? n : "0" + n;
  }
  

• 在 index.js 中定义转义 HTML 的方法

  // 转换 html 字符串函数
  function htmlEscape(htmlStr) {
    return htmlStr.replace(/<|>|"|&/g, (match) => {
      switch (match) {
        case "<":
          return "&lt;";
        case ">":
          return "&gt;";
        case '"':
          return "&quot;";
        case "&":
          return "&amp;";
      }
    });
  }
  

• 在 index.js 中定义还原 HTML 的方法

  // 还原 html 函数
  function htmlUnEscape(str) {
    return str.replace(/<|>|"|&/g, (match) => {
      switch (match) {
        case "<":
          return "<";
        case "&gt;":
          return ">";
        case "&quot;":
          return '"';
        case "&amp;":
          return "&";
      }
    });
  }
  

• 将不同的功能进行模块化拆分

  • 将格式化时间的功能，拆分到 src -> dateFormat.js 中
  • 将处理 HTML 字符串的功能，拆分到 src -> htmlEscape.js 中
  • 在 index.js 中，导入两个模块，得到需要向外共享的方法
  • 在 index.js 中，使用 module.exports 把对应的方法共享出去

• 测试

  // test.js
  
  const itpeilibo= require('./my_pkg/index')
  
  // 格式化时间的代码
  const dtStr = itpeilibo.dateFormat(new Date())
  console.log(dtStr)
  
  // 转义 Html 字符串
  const htmlStr = '<h4 title="abc">这是h4标签<span>123&nbsp;</span></h4>'
  const str = itpeilibo.htmlEscape(htmlStr)
  console.log(str)
  
  // 还原 Html 字符串
  const resetHtml = itpeilibo.htmlUnEscape(str)
  console.log(resetHtml)
  

• 编写包的说明文档

  包根目录中的 README.md 文件，是包的使用说明文档。通过它，我们可以事先把包的使用说明，以 markdown 的 格式写出来，方便用户参考。

  README 文件中具体写什么内容，没有强制性的要求;只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。

  我们所创建的这个包的 README.md 文档中，会包含以下 6 项内容：

  安装方式、导入方式、格式化时间、转义 HTML 中的特殊字符、还原 HTML 中的特殊字符、开源协议

  ## 安装
  ```
  npm install my_utils
  ```
  
  ## 导入
  ```js
  const utils = require('my_utils')
  ```
  
  ## 格式化时间
  ```js
  // 调用 dateFormat 对时间进行格式化
  const dt = m.dateFormat(new Date())
  console.log(dt);
  // 输出：2021-12-23 17:09:11
  ```
  
  ## 转译 html 中特殊字符
  ```js
  // 待转换的 html 字符串
  const htmlStr = '<h1 class="red">你好！<span>123&nbsp;</span></h1>';
  const newStr = m.htmlEscape(htmlStr);
  console.log(newStr);
  // 输出： &lt;h1 class=&quot;red&quot;&gt;你好！&lt;span&gt;123&amp;nbsp;&lt;/span&gt;&lt;/h1&gt;
  ```
  
  ## 还原 html 中的特殊字符
  ```js
  // 待还原的字符
  const str = '&lt;h1 class=&quot;red&quot;&gt;你好！&lt;span&gt;123&amp;nbsp;&lt;/span&gt;&lt;/h1&gt;'
  
  const htmlStr = m.htmlUnEscape(str)
  console.log(htmlStr);
  // 输出：<h1 class="red">你好！<span>123&nbsp;</span></h1>
  ```
  
  ## 开源协议
  ISC
  

1.6 发布包

• 注册 npm 账号

  • 访问 www.npmjs.com/ 网站，点击 sign up 按钮，进入注册用户界面
  • 填写账号相关的信息:Full Name、Public Email、Username、Password
  • 点击 Create an Account 按钮，注册账号
  • 登录邮箱，点击验证链接，进行账号的验证（如果不进行验证，则发布不了包）

• 登录 npm 账号

  npm 账号注册完成后，可以在终端中执行 npm login 命令，依次输入用户名、密码、邮箱后，即可登录成功。

  

​ 注意：在运行 npm login 命令之前，必须 先把下包的服务器地址切换为 npm 的官方 服务器。否则会导致发布包失败!

• 把包发布到 npm 上

  将终端切换到包的根目录之后，运行 npm publish 命令，即可将包发布到 npm 上(注意：包名不能雷同)。

  

• 删除已发布的包

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

​

​ 注意：

​ 1、npm unpublish 命令只能删除 72 小时以内发布的包

​ 2、npm unpublish 删除的包，在 24 小时内不允许重复发布

​ 3、发布包的时候要慎重，尽量不要往 npm 上发布没有意义的包!

2. 模块的加载机制

2.1 优先从缓存中加载

模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次。

注意：不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率。

2.2 内置模块的加载机制

内置模块是由 Node.js 官方提供的模块，内置模块的加载优先级最高。

例如：require('fs') 始终返回内置的 fs 模块，即使在 node_modules 目录下有名字相同的包也叫做 fs。

2.3 自定义模块的加载机制

使用 require() 加载自定义模块时，必须指定以 ./ 或 …/ 开头的路径标识符。在加载自定义模块时，如果没有指定 ./ 或 …/ 这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载。

同时，在使用 require() 导入自定义模块时，如果省略了文件的扩展名，则 Node.js 会按顺序分别尝试加载以下的文件:

1、按照确切的文件名进行加载

2、补全 .js 扩展名进行加载

3、补全 .json 扩展名进行加载

4、补全 .node 扩展名进行加载

5、加载失败，终端报错

2.4 第三方模块的加载机制

如果传递给 require() 的模块标识符不是一个内置模块，也没有以 ‘./’ 或 ‘…/’ 开头，则 Node.js 会从当前模块的父 目录开始，尝试从 /node_modules 文件夹中加载第三方模块。

如果没有找到对应的第三方模块，则移动到再上一层父目录中，进行加载，直到文件系统的根目录。

例如，假设在 ‘C:\Users\itpeilibo\project\foo.js’ 文件里调用了 require(‘tools’)，则 Node.js 会按以下顺序查找：

1、C:\Users\itpeilibo\project\node_modules\tools

2、C:\Users\itpeilibo\node_modules\tools

3、C:\Users\node_modules\tools

4、C:\node_modules\tools

2.5 目录作为模块

当把目录作为模块标识符，传递给 require() 进行加载的时候，有三种加载方式：

1、在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为require()加载的入口。

2、如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件。

3、如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失:Error: Cannot find module ‘xxx’

3. 初识 Express

1、Express 简介

• 什么是 Express

  官方给出的概念：Express 是基于 Node.js 平台，快速、开放、极简的 Web 开发框架。

  通俗的理解：Express 的作用和 Node.js 内置的 http 模块类似，是专门用来创建 Web 服务器的。

  Express 的本质：就是一个 npm 上的第三方包，提供了快速创建 Web 服务器的便捷方法。

  Express 的中文官网：www.expressjs.com.cn/

• 进一步理解 Express

  思考：不使用 Express 能否创建 Web 服务器?

  答案：能，使用 Node.js 提供的原生 http 模块即可。

  思考：既生瑜何生亮(有了 http 内置模块，为什么还有用 Express)?
  答案：http 内置模块用起来很复杂，开发效率低;Express 是基于内置的 http 模块进一步封装出来的，能够极大的提高开发效率。

  思考：http 内置模块与 Express 是什么关系?
  答案：类似于浏览器中 Web API 和 jQuery 的关系。后者是基于前者进一步封装出来的。

• Express 能做什么

  对于前端程序员来说，最常见的两种服务器，分别是：

  • Web 网站服务器:专门对外提供 Web 网页资源的服务器。
  • API 接口服务器:专门对外提供 API 接口的服务器。

  使用 Express，我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器。

2、Express 的基本使用

• 安装

  在项目所处的目录中，运行如下的终端命令，即可将 express 安装到项目中使用：

  npm i express@4.17.1
  

• 创建基本的 Web 服务器

  // 1、导入 express
  const express = require("express");
  
  // 2、创建 web 服务器实例
  const app = express();
  
  // 3、调用app.listen(端口号，启动成功的回调函数)，启动服务器
  app.listen(80, () => {
    console.log("express server is running at http://129.0.0.1");
  });
  

• 监听 GET 请求

  通过 app.get() 方法，可以监听客户端的 GET 请求，具体的语法格式如下：

  app.get("/user", (req, res) => {
    // 调用 express 提供的 res.send() 方法，向客户端响应一个 JSON 对象
    res.send({
      name: "zs",
      age: 18,
    });
  });
  

• 监听 POST 请求

  通过 app.post() 方法，可以监听客户端的 POST 请求，具体的语法格式如下：

  app.post("/user", (req, res) => {
    // 调用 express 提供的 res.send() 方法，向客户端响应一个 文本字符串
    res.send("请求成功！");
  });
  

• 把内容响应给客户端

  通过 res.send() 方法，可以把处理好的内容，发送给客户端：

  res.send("请求成功！");
  

• 获取 URL 中携带的查询参数

  通过 req.query 对象，可以访问到客户端通过查询字符串的形式，发送到服务器的参数：

  app.get('/', (req, res) => {
    // req.query 默认是一个空对象
    // 客户端使用 ?name=zs&age=20 这种查询字符串的形式，发送到服务器的参数
    // 可以通过 req.query 得到
    // 例如：req.query.name  req.query.age
    console.log(req.query);
    res.send(req.query)
  })
  

• 获取 URL 中的动态参数

  通过 req.params 对象，可以访问到 URL 中，通过 : 匹配到的动态参数：

  // :id 是一个动态的参数
  app.get("/user/:id", (req, res) => {
    // req.params 是动态匹配到的 URL 参数，默认也是一个空对象
    console.log(req.params);
    res.send(req.params);
  });
  

  注意：1、动态参数 :id 中的 id 不是固定值，可以写任意值

  ​ 2、路径中可以有多个动态参数，例如：http://127.0.0.1/user/:id/:name

3、托管静态资源

• express.static()

  express 提供了一个非常好用的函数，叫做 express.static()，通过它，我们可以非常方便地创建一个静态资源服务器，

  例如，通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了：

  app.use(express.static('public'))
  

  现在，你就可以访问 public 目录中的所有文件了

  注意：Express 在指定的静态目录中查找文件，并对外提供资源的访问路径。因此，存放静态文件的目录名不会出现在 URL 中。

• 托管多个静态资源目录

如果要托管多个静态资源目录，请多次调用 express.static() 函数：

app.use(express.static('public'))
app.use(express.static('clock'))

访问静态资源文件时，express.static() 函数会根据目录的添加顺序查找所需的文件。

• 挂载路径前缀

如果希望在托管的静态资源访问路径之前，挂载路径前缀，则可以使用如下的方式：

app.use('/public', express.static('/public'))

现在，你就可以通过带有 /public 前缀地址来访问 public 目录中的文件了。

4、nodemon

• 为什么要使用 nodemon

  在编写调试 Node.js 项目的时候，如果修改了项目的代码，则需要频繁的手动 close 掉，然后再重新启动，非常繁琐。

  现在，我们可以使用 nodemon(www.npmjs.com/package/nod…) 这个工具，它能够监听项目文件 的变动，当代码被修改后，nodemon 会自动帮我们重启项目，极大方便了开发和调试。

• 安装 nodemon

  在终端中，运行如下命令，即可将 nodemon 安装为全局可用的工具：

  npm install nodemon -g
  

• 使用 nodemon

  当基于 Node.js 编写了一个网站应用的时候，传统的方式，是运行 node app.js 命令，来启动项目。这样做的坏处是：代码被修改之后，需要手动重启项目。

  现在，我们可以将 node 命令替换为 nodemon 命令，使用 nodemon app.js 来启动项目。这样做的好处是:代码 被修改之后，会被 nodemon 监听到，从而实现自动重启项目的效果。

  现在，我们可以将 node 命令替换为 nodemon 命令，使用 nodemon app.js 来启动项目。这样做的好处是:代码 被修改之后，会被 nodemon 监听到，从而实现自动重启项目的效果。

  nodemon app.js