6.npm与包

Posted on Edited on In

 

1.npm与包

1.包的定义

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

2.包的来源:

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

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

3.为什么需要包

由于 Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发的时，效率很低。

包是基于内置模块封装出来的，提供了更高级、更方便的 API，极大的提高了开发效率。

4.包的下载地址

国外有一家 IT 公司，叫做 npm, Inc. 这家公司旗下有一个非常著名的网站： https://www.npmjs.com/ ，它是全球最大的包共享平台，你可以从这个网站上搜索到任何你需要的包，只要你有足够的耐心！

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

注意：

5.包管理工具npm

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

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

2.npm包使用示例

格式化时间

方法一：自定义模块

dateFormat.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// 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
}

test1.js

1
2
3
4
5
6
7
8
9
// 导入自定义的格式化时间的模块
const TIME = require('./15.dateFormat')

// 调用方法，进行时间的格式化
const dt = new Date()
// console.log(dt)
const newDT = TIME.dateFormat(dt)
console.log(newDT);
// 2023-02-15 14:17:25

方法二：使用第三方模块moment

1
2
3
4
5
6
// 1. 导入需要的包
// 注意：导入的名称，就是装包时候的名称
const moment = require('moment')

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

3.安装第三方模块

1.安装命令：

1
2
3
npm install [module_name]

npm i [module_name]

2.生成文件：

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

其中：

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

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

1
2
3
4
5
6
7
8
9
10
11
{
  "requires": true,
  "lockfileVersion": 1,
  "dependencies": {
    "moment": {
      "version": "2.22.2",
      "resolved": "https://registry.npm.taobao.org/moment/download/moment-2.22.2.tgz",
      "integrity": "sha1-PCV/mDn8DpP/UxSWMiOeuQeD/2Y="
    }
  }
}

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

3.安装指定版本的包

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

1
npm i moment@2.22.0

改变模块的版本时，不需要先卸载再安装，直接安装执行的版本即可

4.包管理配置文件

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

  • 项目的名称、版本号、描述等
  • 项目中都用到了哪些包
  • 哪些包只在开发期间会用到
  • 哪些包在开发和部署时都需要用到
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "name": "code",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "body-parser": "^1.19.0",
    "cors": "^2.8.5",
    "express": "^4.17.1"
  }
}

1.多人协作项目的问题

遇到的问题：第三方包的体积过大，源代码的体积相对很小，不方便团队成员之间共享项目源代码。

解决方案：共享时剔除node_modules

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

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

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

3.快速创建 package.json

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

1
npm init -y

注意：

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

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

4.一次性安装多个包

1
npm install [module1] [module2]

5.一次性安装所有的包

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

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

1
npm install

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

6.卸载包

1
npm uninstall [module_name]

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

7.devDependencies 节点

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
    "name": "code",
    "version": "1.0.0",
    "description": "",
    "main": "index.js",
    "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1"
    },
    "keywords": [],
    "author": "",
    "license": "ISC",
    "dependencies": {
        "art-template": "^4.13.2",
        "express": "^4.17.1",
        "jquery": "^3.4.1",
        "moment": "^2.24.0"
    },
    "devDependencies": {
        "webpack": "^4.42.1"
    }
}

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

1
2
3
4
5
6
7
npm i [module_name] -D

npm i -D [module_name]

npm install [module_name] --save-dev

npm install --save-dev [module_name]

参数写在包名的前后均可以

5.包源地址管理

查看源地址

1
npm config get registry

设置源地址

1
npm config set registry = https://registry.npmjs.org/

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

安装nrm工具（全局安装）

1
npm install -g nrm

查看所有可用的镜像源

1
nrm ls

切换镜像源

1
nrm use [镜像源名称]

6.包的分类

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

  • 项目包
  • 全局包

(1) 项目包

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

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

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

(2) 全局包

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

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

全局安装：

1
npm install -g [module_name]

全局卸载：

1
npm uninstall -g [module_name]

注意：

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

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

7.规范的包结构

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

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

8.开发自定义包

初始化包的基本结构

新建 [module_name] 文件夹，作为包的根目录

1.编写功能函数

在包的根目录下新建src目录，在src目录下编写功能函数

(1) dateFormat.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// 定义格式化时间的函数
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) htmlEscape.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// 定义转义 HTML 字符的函数
function htmlEscape(htmlstr) {
  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
}

2.在 [module_name] 包的根目录文件夹中，新建如下三个文件：

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

(1) index.js

1
2
3
4
5
6
7
8
9
10
// 这是包的入口文件

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

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

(2) package.json

1
2
3
4
5
6
7
8
{
    "name": "itbh-tools", // 包名
    "version": "1.0.0",
    "main": "index.js", // 入口文件
    "description": "提供了基本的格式化时间，HTMLEscape的功能",
    "keywords": ["selftools", "dateformat", "escape"], // npm网站搜索关键字
    "license": "ISC" // 开源协议
}

(3) README.md

README.md通常包含：

  • 安装方式
  • 导入方式
  • 模块功能的常用用法
  • 开源协议

9.发布自定义包

1.注册 npm 账号

在网站上完成npm账户注册

2.登录 npm 账号

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

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

3.把包发布到 npm 上

将终端切换到包的根目录之后，运行 npm publish 命令，即可将包发布到 npm 上。

注意：包名不能和已经发布到 npm 上的包的名称相同

4.删除已发布的包

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

注意：

  • npm unpublish 命令只能删除 72 小时以内发布的包
  • npm unpublish 删除的包，在 24 小时内不允许重复发布