模块化python 模块化教学

模块化

这是这篇文章是在b站学习 黑马程序员Node.js全套入门教程 时做的笔记

笔记太长（全文27k词）所以分成4篇文章发布

分别对应了学习视频中讲的四个模块

1. Node基础
2. 模块化 (当前这篇）
3. Express
4. 数据库与身份认证

最后还有一个 api_server项目 gitee地址

希望对你学习有帮助

1.模块化的基本概念

1.1 什么事模块化

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

1. 生活中的模块化
2. 编程领域中的模块化，就是遵守固定的规则，把一个大文件拆成独立并相互依赖的多个小模块。
   把代码进行模块化拆分的好处：

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

1.2 模块化规范

模块化规范就是对代码进行模块化的拆分与组合时，需要遵守的那些规则。

例如：

• 使用什么样的语法格式来引用模块
• 在模块中使用什么样的语法格式向外暴露成员

模块化规范的好处： 大家都遵守同样的模块化规范写代码，降低了沟通的成本，极大方便了各个模块之间的相互调用，利人利己。

2. Node.js 中的模块化

2.1 Node.js 中模块的分类

Node.js 中根据模块来源的不同，将模块分为了3大类，分别是：

• 内置模块（内置模块是由 Node.js 官方提供的，例如 fs、path、http等)
• 自定义模块（用户创建的每个 .js 文件，都是自定义模块）
• 第三方模块（由第三方开发出来的模块，并非官方提供的内置模块，也不是用户创建的自定义模块，使用前需要先下载）

2.2 加载模块

使用强大的 require()方法，可以加载需要的内置模块、使用自定义模块、第三方模块进行使用。例如：

// 1. 加载内置的 fs 模块
const fs = require('fs')

// 2. 加载用户的自定义模块
const custom = require('./custom.js')

// 3. 加载第三方模块(关于第三方模块的下载和使用，会在后面的课程中进行专门的讲解)
const moment = require('moment')

注意：使用 require() 方法加载其他模块时，会执行被加载模块中的代码。

2.3 Node.js 中的模块作用域

1. 什么是模块作用域

和函数作用域类似，在自定义模块中定义的变亮、方法等成员，只能在当前模块内被访问限制，叫做==模块作用域==。

// 02.test.js
const custom = require('./01.custom')
// 输出 { } 对象
// 在 02.test.js 模块中，无法访问到 01.custom.js 模块中的私有成员
console.log(custom)

// 01.custom.js
// 1. 在模块作用域中定义常量 username
const username = '张三'
// 2. 在模块作用域中定义函数 sayHello
function sayHello() {
  console.log('大家好！我是' + username)
}

2. 模块作用域的好处

防止了全局变量污染的问题

// index.html
<script src="./reg.js"></script>
<script src="./login.js"></script>
<script>
	console.log(username)
</script>

// reg.js
var username = 'zs'

// login.js
var username = 'ls'

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

1. module 对象

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

2. module.exports 对象

在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。

外界用 require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象。

3. 共享成员时的注意点

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

// 07.test.js
// 1. 导入模块 m2
const m2 = require('./06.m2.js')

// 输出 { nickname: '小黑', sayHi: [Function: sayHi] }
console.log(m2)

// 06.m2.js
// 1. 向 module.exports 对象上挂载属性 username
module.exports.username = 'zs'
// 2. 向 module.exports 对象上挂载 sayHello
module.exports.sayHello = function() {
  console.log('Hello!')
}

// 3. 让 module.exports 指向一个全新的对象
module.exports = {
  nickname: '小黑',
  sayHi() {
    console.log('Hi')
  }
}

4. exports 对象

由于 module.exports 单词写起来比较复杂，为了简化向外共享成员的代码，Node 提供了 exports 对象。默认情况下，exports 和 module.exports 指向同一个对象。最终共享的结果，还是 module.exports 指向的对象为准。

// 09.test.js
const m3 = require('./08.m3.js')

// 输出 { username: 'zs', age: 20, sayHello: [Function] }
console.log(m3)

// 08.m3.js
// 1. 定义模块私有成员 username
const username = 'zs'

exports.username = username				// 2. 将私有成员共享出去
exports.age = 20								 // 3. 直接挂载新的成员
exports.sayHello = function() {		// 4. 直接挂载方法
  console.log('大家好!')
}

5. exports 和 module.exports 的使用误区

时刻谨记，require() 模块时，得到的永远是 module.exports 指向的对象：

注意： 为了防止混乱，建议大家不要在同一个模块中同时使用 exports 和 module.exports

2.5 Node.js 中的模块化规范

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

CommonJS 规定：

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

3. npm 与包

3.1 包

1. 什么是包

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

就像电脑和计算机指的是相同的东西，第三方模块和包指的是同一概念，只不过叫法不同。

2. 包的来源

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

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

3. 为什么需要包

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

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

包和内置模块之间的关系，类似于 jQuery 和 浏览器内置 API 之间的关系。

4. 从哪里下载包

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

到目前为止，全球约 1100 多万的开发人员，通过这个包共享平台，开发并共享了超过 120 多万个包 供我们使用。

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

注意：

• 从 https://www.npmjs.com/ 网站上搜索自己所需要的包
• 从 https://registry.npmjs.org/ 服务器上下载自己需要的包

5. 如何下载包

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

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

大家可以在终端中执行 npm -v 命令，来查看自己电脑上所安装的 npm 包管理工具的版本号：

3.2 npm 初体验

1. 格式化时间的传统做法

1. 创建格式化时间得自定义模块
2. 定义格式化时间的方法
3. 创建补零函数
4. 从自定义模块中导出格式化时间的函数
5. 导入格式化时间的自定义模块
6. 调用格式化时间的函数

// 12.格式化时间的传统做法.js
// 导入格式化时间的自定义模块
const TIME = require('./13.dateFormat')

const dt = new Date()
// 调用格式化时间的函数
const newDT = TIME.dateFormat(dt)
console.log(newDT)

// 13.dateFormat
// 创建格式化时间的函数
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
}

2. 格式化时间的高级做法

1. 使用 npm 包管理工具，在项目中安装格式化时间的包 moment
2. 使用 require() 导入格式化时间的包
3. 参考 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) // 输出 2022-03-30 09:47:24

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

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

npm install 包的完整名称

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

npm i 包的完整名称

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

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

第一位数字：大版本

第二位数字：功能版本

第三位数字：Bug修复版本

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

3.3 包管理配置文件

npm 规定，在项目根目录中，**必须**提供一个叫做 package.json 的包管理配置文件。

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

1. 多人协作的问题

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

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

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

3. 快速创建 package.json

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

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

注意：

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

4. dependencies 节点

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

5. 一次性安装所有的包

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

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

// 由于项目运行依赖于 momten 这个包，如果没有提前安装好这个包，就会报如下的错误：
Error: Cannot find module 'moment'

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

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

6. 卸载包

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

// 使用 npm uninstall 具体的包名 来卸载包
npm uninstall moment

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

7. devDependencies 节点

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

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

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

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

3.4 解决下包速度慢的问题

1. 为什么下包速度慢

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

扩展阅读 - 海底光缆：

https://baike.baidu,com/···

2. 淘宝 NPM 镜像服务器

3. 切换 npm 的下包镜像源

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

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

# 官方的下包地址
https://registry.npmjs.org/

4. nrm

为了更方便的切换下包的镜像源，我们可以安装 nrm 这个小工具，

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

3.5 包的分类

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

• 项目包
• 全局包

1. 项目包

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

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

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

npm i 包名 -D		# 开发依赖包 (会被记录到 devDependencies 节点下)
npm i 包名		  # 核心依赖包 (会被记录到 dependencies 节点下)

2. 全局包

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

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

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

注意：

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

3. i5ting_toc

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

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

3.6 规范的包结构

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

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

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

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

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

3.7 开发属于自己的包

1. 需要实现的功能

1. 格式化日期
2. 转义 HTML 中的特殊字符
3. 还原 HTML 中的特殊字符

// 1. 导入自己的包
const itheima = require('itehima-utils')

// -------- 功能1: 格式化日期 ---------
const dt = itheima.dateFormat(new Date())
// 输出 2022-03-30 20:22:50
console.log(dt)

// 1. 导入自己的包
const itheima = require('itehima-utils')

// -------- 功能2: 转义 HTML 中的特殊字符 ---------
const htmlStr = '<h1 style="color: red;">你好！©<span>小黄!</span></h1>'
const str = itheima.htmlEscape(htmlStr)
// 输出<h1 style="color: red;">你好！©<span>小黄!</span></h1>
console.log(str)

// 1. 导入自己的包
const itheima = require('itheima-utils')

// -------- 功能3: 还原 HTML 中的特殊字符 ---------
const rawHTML = itheima.htmlUnEscape(str)
// 输出 <h1 style="color: red;">你好！©<span>小黄!</span></h1>
console.log(rawHTML)

2. 初始化包的基本结构

1. 新建 itheima-tools 文件夹，作为包的根目录
2. 在 itheima-tools 文件夹中，新建如下三个文件：

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

3. 初始化 package.json

{
  // 这里的name需要去npmjs.com搜索一下 不能和别人的重复
  "name": "itheima-tools-cicada",
  "version": "1.0.0",
  "main": "index.js",
  "description": "提供了格式化时间、HTMLEscape的功能",
  "keyWords": ["itheima", "dateFormat", "escape"],
  "license": "ISC"
}

关于更多 license 许可协议相关的内容，可参考 https://www.jianshu.com/p/86251523e898

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

// 格式化时间的方法
function dateFormat(dateStr) { /* 省略其余代码 */ }

// 补零的方法
function padZero(n) {
  return n > 9 ? n : '0' + n
}

module.exports = {
  dateFormat
}

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

function htmlEscape(htmlStr) {
  return htmlStr.replace(/<|>|"|&/g, (match) => {
    switch (match) {
    	case '<':
        return '<'
      case '>':
        return '>'
      case '"':
        return '"'
      case '&':
        return '&'
    }
  })
}

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

function htmlUnEscape(str) {
  return str.replace(/<|>|"|&/g, (match) => {
    switch (match) {
    	case '<':
        return '<'
      case '>':
        return '>'
      case '"':
        return '"'
      case '&':
        return '&'
    }
  })
}

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

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

8. 编写包的说明文档

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

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

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

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

3.8 发布包

1. 注册 npm 账号

1. 访问 https://www.npmjs.com/ 网站，点击 sign up 按钮，进入注册用户界面
2. 填写账号相关的信息：Full Name、Public Email、Username、Password
3. 点击 Create an Account 按钮，注册账号
4. 登录邮箱，点击验证连接，进行账号的验证

2. 登录 npm 账号

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

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

3. 把包发布到 npm 上

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

4. 删除已发布的包

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

注意：

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

4. 模块的加载机制

4.1 优先从缓存中加载

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

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

4.2 内置模块的加载机制

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

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

4.3 自定义模块的加载机制

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

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

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

4.4 第三方模块的加载机制

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

4.5 目录作为模块

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

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