【Node.js]

一、概述

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境 ,使用了一个事件驱动、非阻塞式I/O模型, 让JavaScript 运行在服务端的开发平台,它让JavaScript成为与PHP、Python、Perl、Ruby等服务端语言平起平坐的脚本语言。

官网地址:https://nodejs.org/zh-cn

Node.js 学习路线:JavaScript 基础语法 + Node.js 内置API模块(fs、path、http等) + 第三方API模块(express、mysql等)

二、安装

打开 官网 ,根据实际需求选择下载方式以及下载内容

三、Node.js 模块

1、概述

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

  • 内置模块(内置模块是由 Node.js 官方提供的,例如 fs、path、http 等)
  • 自定义模块(用户创建的每个 .js 文件,都是自定义模块)
  • 第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载)
js 复制代码
// 1. 加载内置的 fs 模块
const fs = require('fs')
// 2. 加载用户的自定义模块
const custom = require(' ./custom.js')
// 3. 加载第三方模块
const moment = require('moment')

2、内置模块

教程参见:

3、模块作用域

在自定义模块中定义的变量、方法等成员,只能在当前模块内被访问,这种模块级别的访问限制,叫做模块作用域。

模块作用域防止了全局变量污染的问题

4、module

在每个 .js 自定义模块中都有一个 module 对象,它里面存储了和当前模块有关的信息。

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

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

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

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

为了防止混乱,建议不要在同一个模块中同时使用 exports 和 module.exports

5、模块的加载过程

  • 优先从缓冲中加载
    模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次。
    不论是内置模块、用户自定义模块、还是第三方模块,它们都会优先从缓存中加载,从而提高模块的加载效率。
  • 内置模块的加载机制
    内置模块是由 Node.js 官方提供的模块,内置模块的加载优先级最高。
    例如,require('fs') 始终返回内置的 fs 模块,即使在 node_modules 目录下有名字相同的包也叫做 fs。
  • 自定义模块的加载机制
    使用 require() 加载自定义模块时,必须指定以 ./../ 开头的路径标识符。在加载自定义模块时,如果没有指定 ./../ 这样的路径标识符,则 node 会把它当作内置模块或第三方模块进行加载。
    在使用 require() 导入自定义模块时,如果省略了文件的扩展名,则 Node.js 会按顺序分别尝试加载以下的文件:
    ① 按照确切的文件名进行加载
    ② 补全 .js 扩展名进行加载
    ③ 补全 .json 扩展名进行加载
    ④ 补全 .node 扩展名进行加载
    ⑤ 加载失败,终端报错
  • 第三方模块的加载机制
    如果传递给 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
  • 目录作为模块
    当把目录作为模块标识符,传递给 require() 进行加载的时候,有三种加载方式:
    ① 在被加载的目录下查找一个叫做 package.json 的文件,并寻找 main 属性,作为 require() 加载的入口
    ② 如果目录里没有 package.json 文件,或者 main 入口不存在或无法解析,则 Node.js 将会试图加载目录下的 index.js 文件。
    ③ 如果以上两步都失败了,则 Node.js 会在终端打印错误消息,报告模块的缺失:Error: Cannot find module 'xxx'

四、npm与包

1、包

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

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

由于 Node.js 的内置模块仅提供了一些底层的 API,导致在基于内置模块进行项目开发的时,效率很低。包是基于内置模块封装出来的,提供了更高级、更方便的 API,极大的提高了开发效率。

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

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

关于更多的约束参见:【包约束规范】

2、npm(Node Package Manager)

2.1 概述

npm 是随着 Node.js 的安装一块安装的包管理和分发工具。

npm 常见的场景:

  • 允许用户从 npm 服务器下载别人编写的第三方包到本地使用。
  • 允许用户从 npm 服务器下载并安装别人编写的命令行程序到本地使用。
  • 允许用户将自己编写的包或命令行程序上传到 npm 服务器供别人使用。

npm 的背后,是基于 couchdb 的一个数据库,详细记录了每个包的信息,包括作者、版本、依赖、授权信息等。它的一个很重要的作用就是:将开发者从繁琐的包管理工作(版本、依赖等)中解放出来,更加专注于功能的开发。

npm 命令参见:npm 官方文档

2.2 package.json

项目使用 npm 初始化命令(项目名需为英文):

bash 复制代码
npm init -y

该命令会在项目根目录生成包管理配置文件 package.json ,用来记录与项目有关的一些配置信息。

复制代码
{
  "name": "code",   				// 项目名称 
  "version": "1.0.0",      	// 项目版本号
  "description": "",   			// 项目描述
  "main": "index.js",     	// 包的入口文件
  "scripts": {}							// 脚本
  "author": "",							// 作者
  "keywords": [],    				// 关键字
  "license": "ISC",  				// 开源许可协议
  "devDependencies": {},    // 开发依赖包
  "dependencies": {}    		// 核心依赖包
}

dependencies & devDependencies

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

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

将包记录到 devDependencies 节点中:

bash 复制代码
// 安装指定的包,并记录到 devDependencies 节点中
npm i 包名 -D


//注意:上述命令是简写形式,等价于下面完整的写法:
npm install 包名 --save-dev

判断一个包是否在项目上线后会不会用到:https://www.npmjs.com/包名#install

2.3 node_modules & package-lock.json

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

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

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

多个第三方包体积较大,在协作开发时,一般不将第三方包上传至代码仓库。

即将 node_modulus 文件夹,添加到 .gitignore 忽略文件中。

当我们拉代码时,需执行 npm install 来一次性安装所有的包。

npm install` 会先读取 package.json 中的 dependencies 节点,读取到新记录的所有依赖包名称和版本号之后,npm包管理工具把所有包安装。

公司项目有的时候会有自己开发的包,这类包一般存放在公司自己建的镜像仓库,所以在执行 npm install 前,需要修改镜像。

2.4 切换镜像源

由于在国内上网环境影响,一些依赖包下载会很慢,甚至会下载失败,所以就要使用到镜像下载。

将npm默认的registry修改为淘宝registry:

shell 复制代码
# 查看当前使用的镜像路径
npm config get registry

# 修改为淘宝镜像
npm config set registry https://registry.npm.taobao.org/

# 检查是否修改成功
npm config get registry

镜像源地址:

复制代码
npm 官方原始镜像网址是:https://registry.npmjs.org/
淘宝 NPM 镜像:http://registry.npmmirror.com
阿里云 NPM 镜像:https://npm.aliyun.com
腾讯云 NPM 镜像:https://mirrors.cloud.tencent.com/npm/
华为云 NPM 镜像:https://mirrors.huaweicloud.com/repository/npm/
网易 NPM 镜像:https://mirrors.163.com/npm/
中国科学技术大学开源镜像站:http://mirrors.ustc.edu.cn/
清华大学开源镜像站:https://mirrors.tuna.tsinghua.edu.cn/

nrm:可以快速查看和切换下包的镜像源

bash 复制代码
# 通过 npm 包管理器,将 nrm 安装为全局可用的工具
npm i nrm -g

# 查看所有可用的镜像源
nrm ls

# 将下包的镜像源切换力 taobao 镜像
nrm use taobao

使用淘宝 cnpm:

bash 复制代码
# 全局安装基于淘宝源的cnpm:
npm install -g cnpm --registry=https://registry.npm.taobao.org

# 检测cnpm安装是否成功
cnpm -v
2.5 项目包 & 全局包
  • 项目包:那些被安装到项目的 node_modules 目录中的包,都是项目包
  • 全局包:在执行 npm install 命令时,如果提供了 -g 参数,则会把包安装为全局包。全局包安装路径:
    • Windows:C:\Users\用户目录\AppData\Roaming\npm\node_modules
    • Mac:

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

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

推荐一些全局包:

  • nrm:切换镜像源
  • i5ting_toc:把 md 文档转为 html 页面
  • nodemon:监听项目文件的变动,当代码被修改后,nodemon 会自动重启项目

五、Express

1、Express 概述

Express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架。

Express 的作用和 Node.js 内置的 http 模块类似,是专门用来创建 Web 服务器的。

Express 就是一个 npm 上的第三方包,提供了快速创建 Web 服务器的便捷方法。

Express 框架核心特性:

  • 可以设置中间件来响应 HTTP 请求。
  • 定义了路由表用于执行不同的 HTTP 请求动作。
  • 可以通过向模板传递参数来动态渲染 HTML 页面。

2、Express 基本使用

十、资料

相关推荐
代码搬运媛2 小时前
Jest 测试框架详解与实现指南
前端
counterxing2 小时前
Agent 跑起来之后,难的是复用、观测和评测
node.js·agent·ai编程
counterxing3 小时前
我把 Codex 里的 Skills 做成了一个 MCP,还支持分享
前端·agent·ai编程
wangqiaowq3 小时前
windows下nginx的安装
linux·服务器·前端
之歆3 小时前
DAY_12JavaScript DOM 完全指南(二):实战与性能篇
开发语言·前端·javascript·ecmascript
发现一只大呆瓜4 小时前
Vite凭什么这么快?3分钟带你彻底搞懂 Vite 热更新的幕后黑手
前端·面试·vite
Maimai108084 小时前
React如何用 @microsoft/fetch-event-source 落地 SSE:比原生 EventSource 更灵活的实时推送方案
前端·javascript·react.js·microsoft·前端框架·reactjs·webassembly
kyriewen5 小时前
产品经理把PRD写成“天书”,我用AI半小时重写了一遍,他当场愣住
前端·ai编程·cursor
humcomm6 小时前
元框架的工作原理详解
前端·前端框架
canonical_entropy6 小时前
Attractor Before Harness: AI 大规模开发的方法论
前端·aigc·ai编程