NodeJS-Npm与包&模块加载机制

鑫玉
125 阅读15分钟

npm与包

包

Node.js 中的第三方模块又叫做包。

包的来源

不同于 Node.js中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用。

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

为什么需要包

由于 Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发时，效率很低。包是基于内置模块封装出来的，提供了更高级、更方便的 API，极大的提高了开发效率。

从哪里下载包

www.npmjs.com/

它是全球最大的包共享平台，它可以搜索到任何你需要的包，只要你有足够的耐心！

例如：jquery,bootstrap等

npm,ln.公司提供了一个地址为registry.npmjs.org/ 的服务器，来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。

如何下载包

npm,ln.公司提供了一个包管理工具，我们可以使用这个包管理工具，从registry.npmjs.org/ 服务器把需要的包下载到本地使用。

这个包管理工具的名字叫做 Node Package Manage（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。

查看自己电脑上安装的 npm 包管理工具的版本号：npm -v

npm 初体验

1.格式化时间传统做法

// 定义格式化时间的方法
function dateFormat(dtStr) {
    const dt = new Date(dtStr)
    const y = 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
}
module.exports = {
    dateFormat
}

// 导入自定义的格式化时间的模块
const TIME = require('./01.dateFormat')

// 调用方法，进行时间的格式化
const dt = new Date()
const newDT = TIME.dateFormat(dt)
console.log(newDT)

1.png

2.格式化时间高级做法

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

3. 在项目中安装包的命令

如果想在项目中安装指定名称的包，需要允许如下的命令：

npm install 包的完整名称

可以简写如下格式：

npm i 完整的包名称

// 使用moment包对时间进行高级格式化处理
// 1.导入需要的包
// 注意：导入的名称，就是装包时候的名称
const moment = require('moment')

const dt = moment().format('YYYY-MM-DD HH:mm:ss')
const dy = moment().format('YYYY-MM-DD HH:m:ss')  // 一个 m 代表不补0
console.log(dt, dy)

2.png

4.初次装包后多了哪些文件

初次装包完成后，在项目文件夹下多一个叫做 node_modules 的文件夹和 package-lock.json 的配置文件。

其中：

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

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

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

5.安装指定版本的包

默认情况下，使用 npm install 命令安装包的时候，会自动安装最新版本的包。如果需要安装指定版本的包，可以在包名之后，通过 @ 符号指定具体的版本，例如：npm i moment@2.22.2

6.包的语义化版本规范

包的版本号是以 '点分十进制' 形式进行定义的，总共有三位数字，例如 2.24.0

其中每一位数字所代表的含义如下：

第1位数字：大版本

第2位数字：功能版本

第3位数字：Bug修复版本

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

包管理配置文件

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

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

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

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

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

2.快速创建package.json

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

注意：

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

3.dependencies 节点

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

4.一次性安装所有的包

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

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

// 执行 npm install 命令时，npm 包管理工具会先读取 package.json 中的 dependencies 节点
// 读取到记录的所有依赖包名称和版本号之后，npm 包管理工具会把这些包一次性下载到项目中

5.卸载包

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

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

6.devDependencies 节点

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

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

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

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

7.解决包下载慢的问题

1.为什么下包速度慢

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

2.淘宝 NPM 镜像服务器

淘宝在国内搭建了一个服务器，专门把国外服务器上的包 同步到国内的服务器，然后在国内提供下包的服务。从而极大的提高了下包的速度。

3.切换 npm 的下包镜像源

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

# 查看当前的下包镜像源
npm config get registry

3.png

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

4.nrm

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

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

4.png

5.png

包的分类

1.包的分类

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

  • 项目包

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

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

    • 开发依赖包（被记录到 devDependencies 节点中的包，只在开发期间会用到）

      npm i 包名 -D

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

      npm i 包名

  • 全局包

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

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

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

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

  • i5ting_toc

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

    # 将 i5ting_toc 安装为全局包
npm install -g i5ting_toc
# 调用 i5ting_toc，轻松实现 md 转 html 的功能
i5ting_toc -f 要转换的md文件路径 -o  // -o 代表自动在浏览器打开

6.png

7.png

2.规范的包结构

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

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

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

https://yarnpkg.com/zh-Hans/docs/package-json

发布包

1.初始化包的基本结构

  1. 新建 itheima-tools 文件夹，作为包的根目录

  2. 在 itheima-tools 文件夹中，新建如下三个文件：

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

  3. 初始化 package.json

    // 这些内容都是手动填写的
{
    "name": "itheima-tools-lxy",                          // 包名
    "version": "1.0.0",                                   // 版本号
    "main": "index.js",                                   // 入口文件
    "description": "提供了格式化时间、HTMLEscape相关的功能",   // 包的简洁描述
    "keywords": [                                         // 搜索的关键字
        "itheima",
        "dataFormat",
        "escape"
    ],
    "license": "ISC"                                      // 许可协议
}
// main 属性指定入口文件

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

    // 这是包的入口文件

// 定义格式化时间的函数
function dateFormat(dateStr) {
    const dt = new Date(dateStr)
    const y = 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
}

// 向外暴露需要的成员
module.exports = {
    dateFormat
}

    // 测试
const itheima = require('./itheima-tools-lxy/index')
// 格式化时间的功能
const dtStr = itheima.dateFormat(new Date())
console.log(dtStr)

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

    // 定义转义 HTML 字符的函数
function htmlEscape(htmlstr) {
    // | 代表或者，g 代表全局,match 代表匹配成功的那个字符
    return htmlstr.replace(/<|>|"|&/g, (match) => {
        switch (match) {
            case '<':
                return '&lt;'
            case '>':
                return '&gt;'
            case '"':
                return '&quot;'
            case '&':
                return '&amp;'
        }
    })
}
// 向外暴露需要的成员
module.exports = {
    dateFormat,
    htmlEscape
}

    // 测试
const itheima = require('./itheima-tools-lxy/index')
// 格式化时间的功能
// const dtStr = itheima.dateFormat(new Date())
// console.log(dtStr)

// 转义HTML字符的功能
const htmlStr = '<h1 title="abc">这是h1标签<span>123&nbsp;</span></h1>'
const str = itheima.htmlEscape(htmlStr)
console.log(str)

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

    // 定义还原 HTML 字符串的函数
function 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 = {
    dateFormat,
    htmlEscape,
    htmlUnEscape
}

    // 测试
const itheima = require('./itheima-tools-lxy/index')
// 格式化时间的功能
// const dtStr = itheima.dateFormat(new Date())
// console.log(dtStr)

// 转义HTML字符的功能
const htmlStr = '<h1 title="abc">这是h1标签<span>123&nbsp;</span></h1>'
const str = itheima.htmlEscape(htmlStr)
// console.log(str)

const str2 = itheima.htmlUnEscape(str)
console.log(str2)

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

    1. 将格式化时间的功能，拆分到 src—> dateFormat.js 中

      
// 定义格式化时间的函数
function dateFormat(dateStr) {
    const dt = new Date(dateStr)
    const y = 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
}

module.exports = {
    dateFormat
}

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

      // 定义转义 HTML 字符的函数
function htmlEscape(htmlstr) {
    // | 代表或者，g 代表全局,match 代表匹配成功的那个字符
    return htmlstr.replace(/<|>|"|&/g, (match) => {
        switch (match) {
            case '<':
                return '&lt;'
            case '>':
                return '&gt;'
            case '"':
                return '&quot;'
            case '&':
                return '&amp;'
        }
    })
}

// 定义还原 HTML 字符串的函数
function 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
}

    3. 在 index.js 中，导入两个模块，得到需要向外共享的方法

      // 这是包的入口文件
const date = require('./src/dateFormat')
const escape = require('./src/htmlEscape')

    4. 在 index.js 中，使用 module.exports 把对应的方法共享出去

      // 向外暴露需要的成员
module.exports = {
    ...date,
    ...escape
}
// 测试
const itheima = require('./itheima-tools-lxy/index')
// 格式化时间的功能
const dtStr = itheima.dateFormat(new Date())
console.log(dtStr)
console.log('-----------------')
// 转义HTML字符的功能
const htmlStr = '<h1 title="abc">这是h1标签<span>123&nbsp;</span></h1>'
const str = itheima.htmlEscape(htmlStr)
console.log(str)
console.log('-----------------')

const str2 = itheima.htmlUnEscape(str)
console.log(str2)

      image-20250709154632727

  8. 编写包的说明文档

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

    ## 安装
```
npm install itheima-tools-lxy
```

## 导入
```js
const itheima=require('itheima-tools-lxy')
```

## 格式化时间
```js
// 调用 dateFormat 对时间进行格式化
const dtStr = itheima.dateFormat(new Date())
// 结果 2020-04-03 17:20:58
console.log(dtStr)
```

## 转义 HTML 中的特殊字符
```js
// 待转换的 HTML 字符串
const htmlStr = '<h1 title="abc">这是h1标签<span>123&nbsp;</span></h1>'
// 调用 htmlEscape 方法进行转换
const str = itheima.htmlEscape(htmlStr)
// 转换结果 &lt;h1 title=&quot;abc&quot;&gt;这是h1标签&lt;span&gt;123&amp;nbsp;&lt;/span&gt;&lt;/h1&gt;
console.log(str)
```

## 还原 HTML 中的特殊字符
```js
// 待还原的 HTML 字符串
const str2 = itheima.htmlUnEscape(str)
// 还原结果 <h1 title="abc">这是h1标签<span>123&nbsp;</span></h1>
console.log(str2)
```

## 开源协议
ISC

2.把包发布到npm

  1. 注册npm账号

  2. 登录npm账号(终端登录，不是网页登录)

    注意：镜像源要切回到npm官方的镜像源，否则会失败

    输入用户名，密码和邮箱验证登录

  3. 把包发布到 npm 上

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

    image-20250709165846095

    image-20250709165806262

    成功发布如下两张图，可以去npm官网登录上自己账号。然后Packages下能看到自己发布的包。

删除包

1.删除已发布的包

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

注意：

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

模块的加载机制

1.优先从缓存中加载

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

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

2.内置模块的加载机制

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

3.自定义模块的加载机制

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

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

  1. 按照确切的文件名进行加载
  2. 补全 .js 扩展名进行加载
  3. 补全 .json 扩展名进行加载
  4. 补全 .node 扩展名进行加载
  5. 加载失败，终端报错

4.第三方模块的加载机制

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

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

image-20250709173200030

5.目录作为模块

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

  1. 在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口
  2. 如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件。
  3. 如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失: Error:Cannot find module 'xxx'
avatar
文章
阅读
粉丝