前后端交互学习笔记（二）：Node.js及npm学习

Node.js及npm

文章目录

Node.js及npm
- 复习引入
- 初识node.js
- fs文件系统模块
- path路径模块
- http模块
- - 创建web服务器
  - 根据不同url设置响应代码模板
- 模块化学习
- - module对象
  - export对象
初识npm与包
- 包
- 包的安装
- - moment包：格式化时间
- 包管理配置文件
- - nrm工具和i5ting_toc工具
- 包的分类
- 开发属于自己的包
- 发布删除包
- 模块的加载机制

复习引入

js代码在浏览器中能运行是因为浏览器有的解析引擎，常用如下
Chrome 浏览器 => V8
Firefox 浏览器 => OdinMonkey（奥丁猴）
Safri 浏览器 => JSCore
IE 浏览器 => Chakra（查克拉）
etc…，其中V8性能最好
每个浏览器都内置了 DOM、BOM 这样的 API 函数，因此，浏览器中的 JavaScript 才可以调用它们。由上可得js在前端浏览器的运行环境如下所示：

内置 API 是由运行环境提供的特殊接口，只能在所属的运行环境中（如浏览器）被调用。
如果想要用js做后端开发，便需要node.js开发环境。

初识node.js

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境。Node.js 的官网地址： https://nodejs.org/zh-cn/
浏览器是 JavaScript 的前端运行环境。Node.js 是 JavaScript 的后端运行环境。 Node.js 中无法调用 DOM 和 BOM 等浏览器内置 API。node.js运行环境如下：
下载网址：https://nodejs.org/en/
- LTS 为长期稳定版，对于追求稳定性的企业级项目来说，推荐安装 LTS 版本的 Node.js。
- Current 为新特性尝鲜版，对热衷于尝试新特性的用户来说，推荐安装 Current 版本的 Node.js。但是，Current 版本中可能存在隐藏的 Bug 或安全性漏洞，因此不推荐在企业级项目中使用 Current 版本的 Node.js。

node -v查看当前node版本号
node 要执行的js文件的路径运行对应的js文件，也可以在文件的目录下右键选择在该目录下打开终端
输入文件开头字母+tab 键，能够快速补全路径，该文件要在当前运行目录下
使用 esc 键，能够快速清空当前已输入的命令
cls可以实现终端清屏

fs文件系统模块

fs 模块是 Node.js 官方提供的、用来操作文件的模块。它提供了一系列的方法和属性，用来满足用户对文件的操作需求。在下载node.js的时候就已经安装好了，使用方法：

// 1. 导入 fs 模块，来操作文件
const fs = require('fs')
// 2. 调用 fs.readFile() 方法读取文件
//    参数1：读取文件的存放路径
//    参数2：读取文件时候采用的编码格式，一般默认指定 utf8（这个非必须，但最好写上，不然可能看不懂结果）
//    参数3：回调函数，拿到读取失败和成功的结果  err  dataStr
fs.readFile('./files/1.txt', 'utf8', function(err, dataStr) {// 2.1 打印失败的结果// 如果读取成功，则 err 的值为 null，dataStr为打印成功的结果// 如果读取失败，则 err 的值为 错误对象，dataStr 的值为 undefinedconsole.log(err)console.log('-------')// 2.2 打印成功的结果console.log(dataStr)
})//3.写入文件（会覆盖原来的内容）
//    参数1：表示文件的存放路径
//    参数2：表示要写入的内容
//    这里原本还有一个参数，默认为utf-8，一般都进行省略
//    参数3：回调函数
fs.writeFile('./files/3.txt', 'ok123', function(err) {// 2.1 如果文件写入成功，则 err 的值等于 null// 2.2 如果文件写入失败，则 err 的值等于一个 错误对象// 无论写入还是写出，都可以用下述方式进行判断是否成功if (err) {return console.log('文件写入失败！' + err.message)}console.log('文件写入成功！')
})

路径拼接问题：
**原因：**代码在运行的时候，会以执行 node 命令时所处的目录，动态拼接出被操作文件的完整路径。
解决方案：
- 在使用 fs 模块操作文件时，直接提供完整的路径，注意用双斜线，不然会识别成转义。不要提供 ./ 或 …/ 开头的相对路径，从而防止路径动态拼接的问题。
- 在文件路径前面加上__dirname(两条短横线),恒定拼接当前文件所在的路径，不随node文件路径变化
  总的来讲：找到了执行的文件，但是执行文件里面还有文件的路径，只能根据当前node命令下的路径进行拼接

fs.readFile('./files/1.txt', 'utf8', function (err, dataStr)
//执行之后如下

path路径模块

首先使用const path = require(‘path’)引入该模块

使用 path.join() 方法，可以把多个路径片段拼接为完整的路径字符串。注意：**今后凡是涉及到路径拼接的操作，都要使用 path.join() 方法进行处理。**不要直接使用 + 进行字符串的拼接，可能会报错。

//  ../会抵消一级路径
const pathStr = path.join('/a', '/b/c', '../../', './d', 'e')
console.log(pathStr)  // \a\d\e

使用 path.basename() 方法，可以获取路径中的最后一部分，如下，第二个参数可有可无，有的话可以去除后缀

const fpath = '/a/b/c/index.html'
const nameWithoutExt = path.basename(fpath, '.html')
console.log(nameWithoutExt)//index

使用 path.extname() 方法，可以获取路径中的扩展名部分(包括点哦)

const fpath = '/a/b/c/index.html'
const fext = path.extname(fpath)
console.log(fext)//.html

http模块

导入：const http=require(‘http’)

http 模块是 Node.js 官方提供的、用来创建 web 服务器的模块。通过 http 模块提供的 http.createServer() 方法，就能方便的把一台普通的电脑，变成一台 Web 服务器，从而对外提供 Web 资源服务。
服务器和普通电脑的区别在于，服务器上安装了 web 服务器软件，例如：IIS、Apache 等。通过安装这些服务器软件，就能把一台普通的电脑变成一台 web 服务器。
在 Node.js 中，我们不需要使用 IIS、Apache 等这些第三方 web 服务器软件。因为我们可以基于 Node.js 提供的 http 模块，通过几行简单的代码，就能轻松的手写一个服务器软件，从而对外提供 web 服务。

IP 地址就是互联网上每台计算机的唯一地址，因此 IP 地址具有唯一性。为了方便测试，可以在自己的浏览器中输入 127.0.0.1 这个 IP 地址，就能把自己的电脑当做一台服务器进行访问。
域名即ip地址的别名，便于记忆，IP地址和域名是一一对应的关系，这份对应关系存放在一种叫做域名服务器。127.0.0.1 对应的域名是 localhost，它们都代表我们自己的这台电脑
在一台电脑中，可以运行成百上千个 web 服务。每个 web 服务都对应一个唯一的端口号。客户端发送过来的网络请求，通过端口号，可以被准确地交给对应的 web 服务进行处理。每个端口号不能同时被多个 web 服务占用。在实际应用中，URL 中的 80 端口可以被省略。

创建web服务器

创建最基本web服务器步骤，浏览器发起默认是get请求，req 请求对象访问与客户端相关的数据或属性，res 响应对象访问与服务器相关的数据或属性：

// 1. 导入 http 模块
const http = require('http')
// 2. 创建 web 服务器实例
const server = http.createServer()
// 3. 为服务器实例绑定 request 事件，监听客户端的请求
server.on('request', function (req, res) {//执行访问事件的处理函数// req.url 是客户端请求的 URL 地址const url = req.url // req.method 是客户端请求的 method 类型const method = req.methodconst str = `Your request url is ${url}, and request method is ${method}`console.log(str)//下面这一行解决中文的响应乱码的问题，固定写法res.setHeader('Content-Type', 'text/html; charset=utf-8')// 调用 res.end() 方法，向客户端响应一些内容（呈现在客户端上，即浏览器上）res.end(str)
})
// 4. 启动服务器
server.listen(8080, function () {
//服务器启动后的处理函数，如在命令行的输出服务启动console.log('server running at http://127.0.0.1:8080')
})

改完代码后记得重启服务器
对于转义中文那一行代码，没有需求不要加，加了可能会导致html代码中引入的css文件加载不出来

根据不同url设置响应代码模板

const http = require('http')
const server = http.createServer()server.on('request', (req, res) => {// 1. 获取请求的 url 地址（当前文件后的相对路径）const url = req.url// 2. 设置默认的响应内容为 404 Not foundlet content = '<h1>404 Not found!</h1>'// 3. 判断用户请求的是否为 / 或 /index.html 首页// 4. 判断用户请求的是否为 /about.html 关于页面if (url === '/' || url === '/index.html') {content = '<h1>首页</h1>'} else if (url === '/about.html') {content = '<h1>关于页面</h1>'}// 5. 设置 Content-Type 响应头，防止中文乱码res.setHeader('Content-Type', 'text/html; charset=utf-8')// 6. 使用 res.end() 把内容响应给客户端res.end(content)
})server.listen(80, () => {console.log('server running at http://127.0.0.1')
})

模块化学习

模块化规范就是对代码进行模块化的拆分与组合时，需要遵守的那些规则。降低了沟通的成本，极大方便了各个模块之间的相互调用，利人利己。node.js模块主要分为以下几类(前两个模块直接在电脑本地，无需下载)：

内置模块（内置模块是由 Node.js 官方提供的，例如 fs、path、http 等）

自定义模块（用户创建的每个 .js 文件，都是自定义模块）

第三方模块（由第三方开发出来的模块，并非官方提供的内置模块，也不是用户创建的自定义模块，使用前需要先下载）

加载模块方法：使用 require() 方法加载其它模块时，会执行被加载模块中的代码，但是你拿不到被加载模块的代码，因为有模块作用域，自定义的时候带不带后缀js都没有影响。
在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，模块作用域。

module对象

在每个 js 自定义模块中都有一个 module 对象，它里面存储了和当前模块有关的信息。在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。外界用 require() 方法导入自定义模块时，返回值的就是 module.exports或者直接使用exports （两个指向的是一个对象）所指向的对象，多个对象的时候会组合成一个数组。

export对象

module.exports.username = username
exports.age = 20
exports.sayHello = function() {console.log('大家好！')
}
在另一个js文件中使用
const m = require('./上面文件的路径')
console.log(m)//{ username: 'zs', age: 20, sayHello: [Function (anonymous)] }

如果上述的另一个文件中，对module.exports文件进行了新的赋值，那么前面的会被覆盖，如下，导入的结果永远以 module.exports 指向的对象为准

module.exports.username = username
exports.age = 20
exports.sayHello = function () {console.log('大家好！')
}
module.exports = {name: 'jiajia'
}
那么此时require的文件输出，只有{ name: 'jiajia' }//但如果是下面的，则不会发生作用，因为对其重新赋值，和module.export指向的就不是一个对象
exports = {name: 'jiajia'
}
那么此时require的文件输出{ username: 'zs', age: 20, sayHello: [Function (anonymous)] }

建议不要在同一个模块中同时使用 exports 和 module.exports
Node.js 遵循了 CommonJS 模块化规范，CommonJS 规定：每个模块内部，module 变量代表当前模块。module 变量是一个对象，它的 exports 属性（即 module.exports）是对外的接口。加载某个模块，其实是加载该模块的 module.exports 属性。require() 方法用于加载模块。

初识npm与包

包

Node.js 中的第三方模块又叫做包。包是基于内置模块封装出来的，提供了更高级、更方便的 API，极大的提高了开发效率。

npm, Inc公司全球最大的包共享平台.从 https://www.npmjs.com/ 网站上搜索自己所需要的包从 https://registry.npmjs.org/ 服务器上下载自己需要的包
Node Package Manager（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。我们可以使用这个包管理工具，从 https://registry.npmjs.org/ 服务器把需要的包下载到本地使用。

包的安装

安装包：下载的包的使用可以去上述的查询包的网站上查看，多个包用空格隔开
- npm install 包的完整名称
- 简写：npm i 包的完整名称
- npm i 包的完整名称**@版本号** 安装指定版本的包
- npm install 或者npm i 一次性安装package里depengencies下的所有包
- npm uninstall 包名卸载指定的包并自动从 package.json 的 dependencies 中移除掉。
- npm i 包名 -D 安装包放到devDependencies 节点下
- npm install 包名 --save-dev 上述代码的全写形式
- npm config get registry 查看当前下载的源地址
- npm config set registry=https://registry.npm.taobao.org/ 修改下载源地址到国内淘宝镜像
- npm i 包名 -g 全局安装指定的包，全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下
- npm uninstall 包名 -g 卸载全局安装的包
初次装包完成后，在项目文件夹下多一个叫做 node_modules 的文件夹和 package-lock.json 的配置文件。

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

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

包的版本含义:版本号提升的规则：只要前面的版本号增长了，则后面的版本号归零。
第1位数字：大版本; 第2位数字：功能版本;第3位数字：Bug修复版本

moment包：格式化时间

// 导入需要的包
// 注意：导入的名称，就是装包时候的名称
const moment = require('moment')
const dt = moment().format('YYYY-MM-DD HH:mm:ss')
console.log(dt)//2023-01-11 17:55:07

包管理配置文件

npm 规定，在项目根目录中，必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置信息。由于第三包所占的空间太大，因此共享分享时可以剔除第三方包，但是保留配置文件，这样可以使得用户自己根据配置去下载。即git时候要把 node_modules 文件夹，添加到 .gitignore 忽略文件中

创建包配置文件的命令：npm init -y
上述命令只能在英文的目录下成功运行！不要使用中文，不能出现空格。运行 npm install 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中。
如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到 devDependencies 节点中。
与之对应的，如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到 dependencies 节点中。
具体放到那个节点可以去搜查的官网查看
镜像（Mirroring）是一种文件存储形式，一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本即为镜像。

nrm工具和i5ting_toc工具

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

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

包的分类

项目包：那些被安装到项目的 node_modules 目录中的包，都是项目包。
项目包又分为两类，分别是：
开发依赖包（被记录到 devDependencies 节点中的包，只在开发期间会用到）
核心依赖包（被记录到 dependencies 节点中的包，在开发期间和项目上线之后都会用到）
在执行 npm install 命令时，如果提供了 -g 参数，则会把包安装为全局包。判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。
一个规范的包，它的组成结构，必须符合以下 3 点要求：
- 包必须以单独的目录而存在
- 包的顶级目录下要必须包含 package.json 这个包管理配置文件
- package.json 中必须包含 name，version，main 这三个属性，分别代表包的名字、版本号、包的入口。
  更多约束参考：https://yarnpkg.com/zh-Hans/docs/package-json

开发属于自己的包

包的结构
- 首先新建一个文件夹，作为包的根目录
- 在该文件夹下新建package.json（包管理配置文件）；index.js （包的入口文件）；README.md （包的说明文档）
package.json初始化如下实例：

{"name": "itheima-tools",//下载包的名字，可以不和文件夹名一样（必须和网站上的包名字不一样）"version": "1.1.0","main": "index.js",//**require时候默认导入的入口文件**"description": "提供了格式化时间、HTMLEscape相关的功能","keywords": ["itheima","dateFormat","escape"],//搜索常用的关键字"license": "ISC"//包的开源许可协议，npm常用ISC
}

README.md 文档中，会包含以下 6 项内容：
安装方式、导入方式、相关的功能拆分的代码（可以注释写上结果）、开源协议
ES6新增了一个运算符“…”，叫做展开运算符。作用是把数组或者对象内容展开，如果主入口文件里面还用到其它的文件export的函数，这个时候可以将返回的变量进行展开后导出

发布删除包

注册npm账号，步骤如下：
- 访问 https://www.npmjs.com/ 网站，点击 sign up 按钮，进入注册用户界面
- 填写账号相关的信息：Full Name、Public Email、Username、Password
- 点击 Create an Account 按钮，注册账号
终端登录，npm 账号注册完成后，可以在终端中执行 npm login 命令，依次输入用户名、密码、邮箱后，即可登录成功。注意：在运行 npm login 命令之前，必须先把下包的服务器地址切换为 npm 的官方服务器。否则会导致发布包失败！
将终端切换到包的根目录之后，运行 npm publish 命令，即可将包发布到 npm 上（注意：包名不能雷同）。当包上传不成功，大概率是包的名字问题，要么就是和其中有的包名字相似，要么就是包的名字被系统识别为垃圾包，注意命名规范且改名字一定要去package里面去改，改文件夹名字没用
运行 npm unpublish 包名 --force 命令，即可从 npm 删除已发布的包。删除注意事项:
- npm unpublish 命令只能删除 72 小时以内发布的包
- npm unpublish 删除的包，在 24 小时内不允许重复发布

模块的加载机制

无论哪种模块在第一次加载后会被缓存。这也意味着多次调用 require() 不会导致模块的代码被执行多次。
内置模块是由 Node.js 官方提供的模块，内置模块的加载优先级最高。即出现同名的文件的时候，优先执行的是内置模块
使用 require() 加载自定义模块时，必须指定以 ./ 或 …/ 开头的路径标识符。在加载自定义模块时，如果没有指定 ./ 或 …/ 这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载。
使用 require() 导入自定义模块时，如果省略了文件的扩展名，则 Node.js 会按顺序分别尝试加载以下的文件，只要前面有一个匹配上则就算成功：
- 按照确切的文件名进行加载
- 补全 .js 扩展名进行加载
- 补全 .json 扩展名进行加载
- 补全 .node 扩展名进行加载 //到了这种方式基本就会报错了，因为node文件里不能写js代码
- 加载失败，终端报错
如果传递给 require() 的模块标识符不是一个内置模块，也没有以 ‘./’ 或 ‘…/’ 开头，则 Node.js 会从当前模块的父目录开始，尝试从 /node_modules 文件夹中加载第三方模块。如果没有找到对应的第三方模块，则移动到再上一层父目录中，进行加载，直到文件系统的根目录，如果还没有则报模块缺失的错误。
当把目录作为模块标识符，传递给 require() 进行加载的时候，有三种加载方式：
- 在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口
- 如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件。
- 如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失：Error: Cannot find module ‘xxx’