Node.js 模块学习

椿生Sakura.

已于 2022-03-30 08:40:06 修改

阅读量1.2k

点赞数

分类专栏： Node.js 文章标签： node.js 学习 javascript

于 2022-03-17 22:40:11 首次发布

本文链接：https://blog.csdn.net/m0_49424368/article/details/123562601

版权

Node.js 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

Node.js 模块学习

1、模块化的基本概念

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

编程领域中的模块化，就是遵守固定的规则，把一个大文件拆分成独立并互相依赖的多个小模块

代码模块化的好处：

提了代码的复用性
提高了代码的可维护性
可以实现按需加载

模块化规范就是对代码进行模块化的拆分与组合时，需要遵守的规则，遵守模块化规范能够降低沟通成本，极大地方便各大模块之间的相互调用。

2、Node.js 中的模块化

2.1、Node.js 中模块的分类

Node.js 中根据模块来源的不同，将模块分为了三大类，如下：

内置模块：Node.js 官方提供的，如 fs、path、http等
自定义模块：用户创建的 .js 文件
第三方模块：由第三方开发出来的模块，非官方提供，使用前需要下载

加载模块可以使用 require() 方法按需加载模块

注意：

使用 require() 方法加载其他模块时，会执行被加载模块中的代码
使用 require() 方法加载用户自定义模块时，可以省略 .js 的后缀名

2.2、Node.js 中的模块作用域

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

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

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

重点：require() 方法导入自定义模块时，得到的永远是 module.exports 指向的对象

1、module 对象

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

自定义模块的module对象

2、module.exports 对象

在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。外界用 require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象

注意：使用 require() 方法导入模块时，导入的结果，永远以 module.exports 指向的对象为准

// 向 module.exports 对象上挂在 username 属性
module.exports.username = 'cs'

// 向 module.exports 对象上挂在 sayHello 方法
module.exports.sayHello = () => {
  console.log('Hello!')
}

module.exports = {
  nickname: 'cst',
  syaHi: () => {
    console.log('Hi!')
  }
}

const m = require('./06-module&exports')

console.log(m)
// 输出的对象为 { nickname: 'cst', syaHi: [Function: syaHi] }

3、exports 对象

Node.js 为了简化向外共享成员的代码 (module.exports)，提供了 exports 对象。默认情况下，exports 和 module.exports 指向同一个对象。最终共享的结果，还是以 module.exports 指向的对象为准。

4、module.exports 和 exports 使用注意事项

在这里插入图片描述

为了防止混乱，建议不要在同一个模块中同时使用 module.exports 和 exports 来共享成员对象

5、Node.js 中的模块化规范

Node.js 遵循 CommonJS 模块化规范，CommonJS 规定了模块的特性和各模块之间如何相互依赖。

CommonJS 规定：

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

3、npm 与包

3.1、包的相关概念

由于Node.js 的内置模块仅提供了一些底层的 API，在项目开发时效率很低，所以出现了包。

包是由第三方个人或团队开发出来的，基于内置模块封装，提供了更高级、更方便的 API，极大的提高了开发效率。

包又称为 Node.js 中的第三方模块，不同于 Node.js 中的内置模块与自定义模块。

注意：Node.js 中的包都是免费且开源的，不需要付费即可免费下载使用

包的语义化版本规范：包的版本号是以“点分十进制”形式进行定义的，总共三位数字，例如 2.24.0

第1位数字：大版本
第2位数字：功能版本
第3位数字：Bug修复版本

版本号提升规则：只要前面的版本号增长，则后面的版本号归零

3.2 、npm

npm, Inc. 公司提供了一个全球最大的包共享平台 npm

从 https://www.npmjs.com/ 网站上可以搜索自己需要的包

从 https://www.registry.npmjs.org/ 服务器上可以下载自己需要的包

通过使用包管理工具 Node Package Manager (简称 npm 包管理工具)，从 https://www.registry.npmjs.org/ 服务器上把需要的包下载到本地使用。

3.3、体验 npm

案例-格式化时间

传统做法步骤如下：

在这里插入图片描述

// 创建格式化时间的函数
// YYYY-MM-DD HH:MM:SS
const dateFormat = (dt) => {
  const date = new Date(dt)
  const Y = date.getFullYear()
  const M = padZero(date.getMonth() + 1)
  const D = padZero(date.getDay())
  const h = padZero(date.getHours())
  const m = padZero(date.getMinutes())
  const s = padZero(date.getSeconds())
  return Y + '-' + M + '-' + D + ' ' + h + ':' + m + ':' + s
}

// 创建补零函数
const padZero = (n) => {
  return n > 9 ? n : '0' + n
}

// 导出格式化时间的函数
module.exports = {
  dateFormat
}

const TIME = require('./10-dateFormat')

const date = new Date()
const newDate = TIME.dateFormat(date)

console.log(newDate)

高级做法步骤如下（借助格式化时间的包 moment）：

在这里插入图片描述

const moment = require('moment')

const dt = moment().format('YYYY-MM-DD HH:mm:ss')

console.log(dt)

3.4、项目配置文件的描述：

项目安装完第三方模块后会出现相关的配置文件：node_modules、package-lock.json、package.json 等。

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

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

注意：不要手动修改 node_modules 或 package-lock.json 文件，npm 包管理工具会自动进行维护

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

项目的名称、版本号、描述
项目中使用了哪些包
哪些包只在开发期间使用
哪些包在开发和部署时都需要用到

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

npm init -y

注意：该命令只能在英文的目录下成功运行！项目文件夹一定要使用英文命名，不要使用中文，不能出现空格。另外，使用 npm install 命令安装包时，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中

package.json 中的节点：

dependencies 节点：记录使用 npm install 命令安装了哪些包，使用 npm uninstall 命令卸载包之后，卸载的包会从中自动移除
devDependencies节点：记录只在项目开发阶段使用，项目上线之后不会用到的包，使用如下命令可以将包记录到 devDependencies 节点中

  // 安装指定的包，并记录到 devDependencies 节点中
  npm install 包名 --save-dev
  // 简写形式
  npm i 包名 -D

多人协作时，在项目根目录中，package.json 配置文件记录项目中安装了哪些包，从而方便剔除 node_modules 目录之后，在团队成员之间共享项目的源代码

注意：项目开发中，将 node_modules 文件夹添加到 .gitignore 忽略文件中。

3.5、npm 下包镜像源

下载包速度慢的解决方法：可以切换 npm 的下包镜像源

在这里插入图片描述

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

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

nrm 用于快速查看和切换下包的镜像源

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

3.6、包的分类

使用 npm 包管理工具下载的包，分为 项目包 和 全局包 两大类

项目包：被安装到项目的 node_modules 目录中的包，可以再细分两类：

开发依赖包：记录到 devDependencies 节点中的包，只在开发期间使用
核心依赖包：记录到 Dependencies 节点中的包，项目开发和上线都会用到

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

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

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

注意：只有工具性质的包，才有全局安装的必要性，判断包是否需要全局安装，可以参考官方提供的使用说明

规范的包结构

包必须以单独的目录而存在
包的顶级目录下必须包含 package.json 这个包管理配置文件
package.json 中必须包含 name，version，main 这三个属性，分别代表包的名字、版本号、包的入口

注意：更多包的约束，可以参考这个网址：https://yarnpkg.com/zh-Hans/docs/package-json

3.7、开发属于自己的包

初始化包的基本结构

新建 sakura-tools 文件夹，作为包的根目录
在 sakura-tools 文件夹中，新建如下三个文件：
- package.json（包管理配置文件）
- index.js（包的入口文件）
- README.md（包的说明文档）

{
  "name": "sakura-tools",                              // 包的名称
  "version": "1.0.0",                                  // 包的版本
  "main": "index.js",                                  // 包的入口
  "description": "提供了格式化时间、HTMLEscape相关的功能",  // 包的简短描述
  "keywords": [                                        // 包的关键字（搜索时可以通过关键字）
    "sakura",
    "dateFormat",
    "escape"
  ],
  "license": "ISC"                                     // 包的许可协议
}

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

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

// dateFormat.js

// 定义格式化时间的函数  YYYY-MM-DD HH:MM:SS
const dateFormat = (dt) => {
  const date = new Date(dt)
  const Y = date.getFullYear()
  const M = padZero(date.getMonth() + 1)
  const D = padZero(date.getDate())
  const h = padZero(date.getHours())
  const m = padZero(date.getMinutes())
  const s = padZero(date.getSeconds())
  // return Y + '-' + M + '-' + D + ' ' + h + ':' + m + ':' + s
  return `${Y}-${M}-${D} ${h}:${m}:${s}`
}

// 创建补零函数
const padZero = (n) => {
  return n > 9 ? n : '0' + n
}

module.exports = {
  dateFormat
}

// htmlEscape.js

// 定义转义 HTML 字符的函数
const htmlEscape = (htmlstr) => {
  return htmlstr.replace(/<|>|"|&/g, (match) => {
    switch (match) {
      case '<':
        return '&lt;'
      case '>':
        return '&gt;'
      case '"':
        return '&quot;'
      case '&':
        return '&amp;'
    }
  })
}

// 定义还原 HTML 字符的函数
const htmlUnEscape = (str) => {
  return str.replace(/&lt;|&gt;|&quot;|&amp;/g, (match) => {
    switch (match) {
      case '&lt;':
        return '<'
      case '&gt;':
        return '>'
      case '&quot;':
        return '"'
      case '&amp;':
        return '&'
    }
  })
}

module.exports = {
  htmlEscape,
  htmlUnEscape
}

// index.js

const date = require('./src/dateFormat')
const escape = require('./src/htmlEscape')

// 导出格式化时间的函数
// 展开运算符
module.exports = {
  ...date,
  ...escape
}

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

## 安装

```
npm install sakura-tools
```

## 导入

```js
const sakura = require('sakura-tools')
```

## 格式化时间

```js
// 调用 dateFormat 对时间进行格式化
const dtStr = sakura.dateFormat(new Date())
// 输出格式 YYYY-MM-DD hh:mm:ss
console.log(dtStr)
```

## 转义 HTML 中的特殊字符

```js
// 待转换的 HTML 字符串
const htmlStr = '<h1 title="abc">这是h1标签<sapn>123&nbsp;</sapn></h1>'
// 调用 htmlEscape 方法进行转换
const str = sakura.htmlEscape(htmlStr)
// 转换的结果
console.log(str)
```

## 还原 HTML 中的特殊字符

```js
// 待还原的 HTML 字符串
const str2 = sakura.htmlUnEscape(str)
// 输出的结果 <h1 title="abc">这是h1标签<sapn>123&nbsp;</sapn></h1>
console.log(str2)
```

## 开源协议

ISC

发布包：

在 npmjs.com 上注册账号
npm账号注册完成之后，在终端中执行 npm login 命令登录账号（注意：登录时必须把下包的服务器地址切换为 npm 官方服务器，否则会导致发布包失败！）
将终端切换到包的根目录之后，运行 npm publish 命令，即可将包发布到 npm 上（注意：包名不能雷同）
删除已发布的包，运行 npm unpublish 包名 --force 命令
- npm unpublish 命令只能删除72小时以内发布的包
- npm unpublish 删除的包。在24小时内不允许重复发布
- 尽量不要往 npm 上发布没有意义的包