深入了解npm，不迷路“我正在参加「掘金·启航计划」” 1.第三方模块介绍 1 什么是包 Node.js 中的第三方模块

“我正在参加「掘金·启航计划」”

1.第三方模块介绍

1 什么是包

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

2 包的来源

不同于 Node.js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用
注意： Node.js 中的包都是免费且开源的，不需要付费即可免费下载使用

3 为什么需要包

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

4 从哪里下载包

在学习和以后的实际开发中，下载包，都是从 npm 这个网站下载

5 如何下载包

下载包使用 npm ，全名叫做 Node Package Manager（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。
可以在终端中执行 npm -v 命令，来查看自己电脑上所安装的 npm 包管理工具的版本号

结论:要使用第三方的包要使用npm包管理工具

2.npm 初体验

1 格式化时间的传统做法

// 格式化时间方法.js

// 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}`
}

module.exports = {
  dateFormat
}
// 对时间进行格式化.js

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

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

3 使用第三方包

2.1 实现思路分析

使用 npm 包管理工具，在项目中安装格式化时间的包 moment
使用 require() 导入格式化时间的包

参考 moment 的官方 API 文档对时间进行格式化

// 1.moment
const moment = require('moment')

// 2.参考 moment 官方 API 文档，调用对应的方法，对时间进行格式化
// 2.1 调用 moment() 方法，得到当前的事件
// 2.2 针对当前的时间，调用 format() 方法，按照指定的格式进行时间的格式化
const dt = moment().format('YYYY-MM-DD HH:mm:ss')

console.log(dt)

2.2npm install 命令安装包

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

npm install 包的完整名称

上述的装包命令，可以简写成如下格式

npm i 包的完整名称

npm i moment

2.3moment 对时间格式化

// 1.moment
const moment = require('moment')

// 2.参考 moment 官方 API 文档，调用对应的方法，对时间进行格式化
// 2.1 调用 moment() 方法，得到当前的事件
// 2.2 针对当前的时间，调用 format() 方法，按照指定的格式进行时间的格式化
const dt = moment().format('YYYY-MM-DD HH:mm:ss')

console.log(dt)

4 `node_modules` 和 `pageage-lock.json` 的作用

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

node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时，就是从这个目录中查找并加载包
package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等

5 安装指定版本的包

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

npm i moment@2.22.2

6 包管理配置

6.1 包管理配置的概念

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

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

6.2 理解 `package.json` 配置文件的作用

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

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

6.3 快速创建 `package.json`

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

npm init -y

注意：

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

6.4 了解 dependencies 节点的作用

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

// 安装一个包
npm i xxx

// 安装多个包
npm i xxx1  xxx2

6.5 一次性安装所有的包

当我们拿到一个剔除了 node_modules 的项目之后，需要先把所有的包下载到项目中，才能将项目运行起来。否则会报类似于下面的错误：

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

6.6 卸载包

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

6.7 了解 `devDependencies` 节点的作用

如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到 devDependencies 节点中
与之对应的，如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到 dependencies 节点中
您可以使用如下的命令，将包记录到 devDependencies 节点中

7. 解决包下载慢的问题

7.1 分析包下载慢的原因

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

7.2 了解淘宝 `npm` 镜像服务器的作用

淘宝在国内搭建了一个服务器，专门把国外官方服务器上的包同步到国内的服务器，然后在国内提供下包的服务。从而极大的提高了下包的速度
镜像是一种文件存储形式，一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本即为镜像

7.3 切换 `npm` 的下包镜像源

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

8. 包的分类

8.1 项目包

那些被安装到项目的 node_modules 目录中的包，都是项目包
项目包又分为两类，分别是：

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

8.2 全局包

在执行 npm install 命令时，如果提供了 -g 参数，则会把包安装为全局包
全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下
注意：

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

8.3 nodemon 的安装和使用

用nodemon指令运行 xxx.js 代码时,当修改代码完毕后,不需要再时时重启该文件.

9. 开发属于自己的包

9.1 规范的包结构

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

包必须以单独的目录而存在
包的顶级目录下要必须包含 package.json 这个包管理配置文件

9.2 了解需要实现的功能

需要实现的功能: 开发一个简易计算器功能,实现加减乘除功能

9.3 初始化包的基础结构

新建 calc 文件夹，作为包的根目录
在 cals 文件夹中，创建如下两个文件：

package.json (包管理配置文件)
index.js (包的入口文件)

9.4 完成加减乘除的功能模块

// 在项目根目录中添加src文件夹   创建 add.js ,sub.js ...

//add.js
function add(a,b){
    return a+b
}
module.exports = add

//sub.js
function sub(a,b){
    return a-b
}
module.exports = sub

9.5 在 `index.js` 中定义计算器的方法

//实现了计算器的加减乘除功能
const add = require("./src/add.js")
const sub = require("./src/sub.js")

module.exports = {
    add,
    sub
}

9.6 `package.json` 文件中 `main` 的作用

在导入一个文件的时候，如果没有指定一个特定的文件，但是却能够得到某个包的返回内容，这是因为 Node 在使用 require 导入某个路径的时候，发现没有具体的文件，就会看这个路径下查看是否有 package.json 这个文件，如果有，则查看是否有 main 这个属性，如果有，则指定 main 属性对应的文件作为要执行的文件

10. 模块的加载机制

10.1 优先从缓存中加载

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

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

// 自定义模块.js
console.log('ok')

// 其它模块
require('./自定义模块.js')
require('./自定义模块.js')
require('./自定义模块.js')

//结果:多次加载只会打印一次ok

10.2 内置模块的加载优先级

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

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

const fs = require('fs') // 始终返回的是内置的 fs 模块

10.3 自定义模块的加载机制

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

10.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

10.5 目录作为模块

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

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

深入了解npm，不迷路