终极目标:掌握和使用node

本博客目的:记录node学习的进度和心得(CommonJs 和Nodejs 模块、自定义模块)

内容:CommonJs 和Nodejs 模块、自定义模块。

CommonJs 和Nodejs 模块、自定义模块

CommonJs

什么是commonJS

​ JavaScript 是一个强大面向对象语言,它有很多快速高效的解释器。然而, JavaScript标准定义的API 是为了构建基于浏览器的应用程序。并没有制定一个用于更广泛的应用程序的标准库。CommonJS 规范的提出,主要是为了弥补当前JavaScript 没有标准库的缺陷。它的终极目标就是:提供一个类似Python,Ruby 和Java 语言的标准库,而不只是让JavaScript 停留在小脚本程序的阶段。用CommonJS API 编写出的应用,不仅可以利用JavaScript 开发客户端应用,而且还可以编写以下应用:
​ •服务器端JavaScript 应用程序。(nodejs)
​ •命令行工具。
​ •桌面图形界面应用程序。

CommonJS 就是模块化的标准,nodejs 就是CommonJS(模块化)的实现。

Nodejs 中的模块化

​ 1、Node 应用由模块组成,采用CommonJS 模块规范

​ 在Node 中,模块分为两类: 一类是Node 提供的模块,称为核心模块(系统模块);另一类是用户编写的模块,称为文件模块(自定义模块)。

核心模块部分在Node 源代码的编译过程中,编译进了二进制执行文件。在Node 进程启动时,部分核心模块就被直接加载进内存中,所以这部分核心模块引入时,文件定位和编译执行这两个步骤可以省略掉,并且在路径分析中优先判断,所以它的加载速度是最快的。如:HTTP 模块、URL 模块、Fs 模块都是nodejs 内置的核心模块,可以直接引入使用。

文件模块则是在运行时动态加载,需要完整的路径分析、文件定位、编译执行过程、速度相比核心模块稍微慢一些,但是用的非常多。这些模块需要我们自己定义。

​ 2、CommonJS(Nodejs)中自定义模块的规定

​ 我们可以把公共的功能抽离成为一个单独的js 文件作为一个模块,默认情况下面这个模块里面的方法或者属性,外面是没法访问的。如果要让外部可以访问模块里面的方法或者属性,就必须在模块里面通过exports 或者module.exports 暴露属性或者方法。

​ 在需要使用这些模块的文件中,通过require 的方式引入这个模块。这个时候就可以使用模块里面暴露的属性和方法。如图所示:

image-20200509202911341

具体使用实例

​ 例子1:

​ 例如我们需要使用一些方法时,通常可以在同一文件定义,并且使用:

image-20200509203730269

​ 结果:

image-20200509203849491

例子2:

​ 但通常我们是把一个公共的方法定义在一个文件夹里的某个文件,例如定义一个module文件夹,里面把公共方法写在tools.js:

image-20200509204051036

​ 然后用export或module.exports导出:

image-20200509204303130

​ 然后在需要使用的地方导入使用:

image-20200509204445772

​ 运行,看控制台结果:

image-20200509204542793

​ 正好输出的是我们exports.formatApi这个formatApi对象。

​ 浏览器也反映了结果:

image-20200509204713401

​ 例子3:模块导出的方式还可以是module.exports=导出对象,例如创建一个request.js

image-20200509204914906

image-20200509204931745

​ 此时,相当于这个js文件就是名为obj的对象。(封装成对象的形式,在于对对象属性和方法的自定义)

​ 打印模块:

image-20200509205041763

​ 此外,如果说我们只是导出一些方法,也可以不用封装成一个对象,直接导出即可。(其实也是把模块文件看成了一个对象)

image-20200509205153745

image-20200509205234953

​ 例子4:node_modules文件夹的定义

​ 通常node_modules文件夹是放置我们自定义模块的地方。

​ 我们先创建一个名为node_modules的文件夹,然后再里面创建一个axios(表示数据请求模块),并创建index.js文件。

image-20200509205611739

image-20200509205743464

​ 当我们需要引入这个axios下的index.js时,可以:

image-20200509205827060

(index.js的.js后缀可以省略)

​ 还可以省略node_modules,引入和使用:

image-20200509205938168

​ 因为node_modules文件夹,在其里面定义的模块,node可以在不写完整路径,直接找到node_modules文件夹下的模块。(原理应该是node配置中,默认了先从自己内置模块(系统模块)找,再接着从node_modules文件夹找,也就是从自定义模型里面找。)

​ 进一步地,每个模块的index.js就是一个默认的文件入口,使用时也可以省略:

image-20200509210302568

​ 这就与引入系统模块类似:

image-20200509210445160

例子5:

​ 如果,我们自定义的模块不是以index.js写的,例如:

​ 创建一个自定义模块db(表示数据库):

image-20200509210640312

image-20200509210652766

​ 但是如果直接(省略完整路径)引入使用时:

image-20200509210734029

​ 这样,会出错,找不到这个模块:

image-20200509210856133

​ 因为省略完整路径的规范中,入口文件是以index.js查找的,虽然我们把db.js改写成index.js可以,但我们其实可以为其配置入口文件packag.json。

​ 首先,通过npm init 生成package.json(配置文件)

​ cd模块文件路径,然后cmd输入命令:

npm init --yes –在当前文件目录下强制生成package.json。

image-20200509211335024

​ package.json文件里面有很多信息。如名字,版本,描述,入口,脚本等。

image-20200509211409822 此时,修改main属性为模块文件。

​ 之后,在引入使用模块时,就可以正常使用了:

image-20200509211530441

​ 结果(成功使用):

image-20200509211540769

小结:node的自定义模型都是放在node_modules文件夹里面,引入模块时,直接require这个模块名即可。如果不是命名为index.js的自定模块,需要配置package.json,配置入口。