Node.js 简介

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境

Node.js 可以做什么

Node.js 作为一个 JavaScript 的运行环境,仅仅提供了基础的功能和 API。然而,基于 Node.js 提供的这些基础能,很多强大的工具和框架如雨后春笋,层出不穷,所以学会了 Node.js ,可以让前端程序员胜任更多的工作和岗位:

  • 基于 Express 框架(http://www.expressjs.com.cn/),可以快速构建 Web 应用
  • 基于 Electron 框架(https://electronjs.org/),可以构建跨平台的桌面应用
  • 基于 restify 框架(http://restify.com/),可以快速构建 API 接口项目
  • 读写和操作数据库、创建实用的命令行工具辅助前端开发、etc…

Node.js 版本区别

  1. LTS 为长期稳定版,对于追求稳定性的企业级项目来说,推荐安装 LTS 版本的 Node.js。
  2. Current 为新特性尝鲜版,对热衷于尝试新特性的用户来说,推荐安装 Current 版本的 Node.js。但是,Current 版本中可能存在隐藏的 Bug 或安全性漏洞,因此不推荐在企业级项目中使用 Current 版本的 Node.js。

fs 文件系统模块

fs 模块是 Node.js 官方提供的、用来操作文件的模块,它提供了许多的方法和属性。

  • fs.readFile() 方法,用来读取指定文件中的内容
  • fs.writeFile() 方法,用来向指定的文件中写入内容

fs.readFile()

使用 fs.readFile() 方法,可以读取指定文件中的内容,语法格式如下:

fs.readFile(path, [code], callback)
  • path:必选参数,字符串,表示文件的路径
  • code:可选参数,表示以什么编码格式来读取文件
  • callback:必选参数,文件读取完成后的回调函数
1
2
3
4
5
6
7
8
const fs = require('fs');

fs.readFile('./files/11.txt', 'utf8', function (err, data) {
if (err) {
return console.log('读取文件失败!' + err.message);
}
console.log('读取文件成功!' + data);
});

fs.writeFile()

使用 fs.writeFile() 方法,可以向指定的文件中写入内容,语法格式如下:

fs.writeFile(path, data, [code], callback)
  • path:必选参数,字符串,表示文件的路径
  • data:必选参数,表示要写入的内容
  • code:可选参数,表示以什么编码格式来写入文件内容
  • callback:必选参数,文件写入完成后的回调函数
1
2
3
4
5
6
7
8
const fs = require('fs');

fs.writeFile('./files/3.txt', 'Hello Node.js!', function (err) {
if (err) {
return console.log('文件写入失败!' + err.message);
}
console.log('文件写入成功!');
});

综合案例-整理成绩

整理前,成绩.txt 文件中的数据格式如下:

1
小红=99 小白=100 小黄=70 小黑=66 小绿=88

整理后,成绩.txt 文件中的数据格式如下:

1
2
3
4
5
小红:99
小白:100
小黄:70
小黑:66
小绿:88

整体成绩的代码如下:

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
const fs = require('fs');

fs.readFile('../素材/成绩.txt', 'utf8', function (err, data) {
if (err) {
return console.log('读取文件失败!' + err.message);
}
// console.log('读取文件成功!');
const arrOld = data.split(' ');
// console.log(arrOld);
const arrNew = [];
// 等于号转成冒号
arrOld.forEach((item) => {
arrNew.push(item.replace('=', ':'));
});
// console.log(arrNew);
// 添加换行符
const result = arrNew.join('\r\n');
// console.log(result);
fs.writeFile('./files/成绩.txt', result, function (err) {
if (err) {
return console.log('写入文件失败!' + err.message);
}
console.log('写入文件成功!');
});
});

路径动态拼接的问题

在使用 fs 模块操作文件时,如果提供的操作路径是以 ./ 或 ../ 开头的相对路径时,很容易出现路径动态拼接错误的问题。因为代码在运行的时候,会以执行 node 命令时所处的目录,动态拼接出被操作文件的完整路径。
解决方案:在使用 fs 模块操作文件时,直接提供完整的路径,不要提供 ./ 或 ../ 开头的相对路径。

1
2
3
4
5
6
7
8
const fs = require('fs');

fs.readFile(__dirname + '/files/1.txt', 'utf8', function (err, dataStr) {
if (err) {
return console.log('读取文件失败!' + err.message);
}
console.log('读取文件成功!' + dataStr);
});

path 路径模块

path 模块是 Node.js 官方提供的、用来处理路径的模块,它提供了许多的方法和属性。

  • path.join() 方法,用来将多个路径片段拼接成一个完整的路径字符串
  • path.basename() 方法,用来从路径字符串中,将文件名解析出来

path.join()

使用 path.join() 方法,可以把多个路径片段拼接为完整的路径字符串,语法格式如下:

path.join(path1, path2, ...)
  • path1:路径片段 1
  • path2:路径片段 2
1
2
3
4
5
6
7
8
9
10
11
12
13
const path = require('path');
const fs = require('fs');

// 注意: ../ 会抵消前面的路径
const pathStr = path.join('/a', '/b/c', '../', './d', 'e');
console.log(pathStr); // \a\b\d\e

fs.readFile(path.join(__dirname, './files/1.txt'), 'utf8', function (err, dataStr) {
if (err) {
return console.log(err.message);
}
console.log(dataStr);
});

path.basename()

使用 path.basename() 方法,可以获取路径中的最后一部分,经常通过这个方法获取路径中的文件名,语法格式如下:

path.basename(path, [ext])
  • path:必选参数,表示文件的路径
  • ext:可选参数,表示文件的扩展名
1
2
3
4
5
6
7
8
9
10
const path = require('path');

// 定义文件的存放路径
const fpath = '/a/b/c/index.html';

const fullName = path.basename(fpath);
console.log(fullName); // index.html

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

path.extname()

使用 path.extname() 方法,可以获取路径中的扩展名部分,语法格式如下:

path.extname(path)
  • path:必选参数,表示文件的路径
1
2
3
4
5
6
7
const path = require('path');

// 这是文件的存放路径
const fpath = '/a/b/c/index.html';

const fext = path.extname(fpath);
console.log(fext); // .html

综合案例-拆分文件

案例要将素材目录下的 index.html 页面拆分成三个文件到 clock 文件夹下,分别为 index.html、index.css、index.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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// 导入模块
const fs = require('fs');
const path = require('path');

// 匹配 css 和 js 的正则
const regStyle = /<style>[\s\S]*<\/style>/;
const regScript = /<script>[\s\S]*<\/script>/;

// 读取源文件
const sourceFile = path.join(__dirname, '../素材/index.html');
fs.readFile(sourceFile, 'utf8', function (err, data) {
if (err) {
return console.log('读取文件失败!' + err.message);
}
// 提取 css、js、html
resolveCSS(data);
resolveJs(data);
resolveHtml(data);
});

// 提取 css
function resolveCSS(htmlStr) {
const oldCss = regStyle.exec(htmlStr);
// console.log(oldCss[0]);
const newCss = oldCss[0].replace('<style>', '').replace('</style>', '');
// console.log(newCss);
const cssPath = path.join(__dirname, './clock/index.css');
fs.writeFile(cssPath, newCss, function (err) {
if (err) {
return console.log('css 写入失败!' + err.message);
}
console.log('css 写入成功!');
});
}

// 提取 js
function resolveJs(htmlStr) {
const oldJs = regScript.exec(htmlStr);
// console.log(oldJs[0]);
const newJs = oldJs[0].replace('<script>', '').replace('</script>', '');
// console.log(newJs);
const jsPath = path.join(__dirname, './clock/index.js');
fs.writeFile(jsPath, newJs, function (err) {
if (err) {
return console.log('js 写入失败!' + err.message);
}
console.log('js 写入成功!');
});
}

// 提取 html
function resolveHtml(htmlStr) {
// 把内嵌 css 和 js 替换为外链的形式
const newHtml = htmlStr.replace(regStyle, '<link rel="stylesheet" href="./index.css">').replace(regScript, '<script src="./index.js"></script>');
// console.log(newHtml);
const htmlPath = path.join(__dirname, './clock/index.html');
fs.writeFile(htmlPath, newHtml, function (err) {
if (err) {
return console.log('html 写入失败!' + err.message);
}
console.log('html 写入成功!');
});
}
  • fs.writeFile() 方法只能用来创建文件,不能用来创建路径
  • 重复调用 fs.writeFile() 写入同一个文件,新写入的内容会覆盖之前的旧内容

http 模块

http 模块是 Node.js 官方提供的、用来创建 web 服务器的模块。通过 http 模块提供的 http.createServer() 方法,就能方便的把一台普通的电脑,变成一台 Web 服务器,从而对外提供 Web 资源服务。

创建 web 服务器

  1. 导入 http 模块
  2. 创建 web 服务器实例
  3. 为服务器实例绑定 request 事件,监听客户端的请求
  4. 启动服务器
1
2
3
4
5
6
7
8
9
10
11
12
// 1. 导入 http 模块
const http = require('http');
// 2. 创建 web 服务器实例
const server = http.createServer();
// 3. 为服务器实例绑定 request 事件,监听客户端的请求
server.on('request', function (req, res) {
console.log('Someone visit our web server.');
});
// 4. 启动服务器
server.listen(8080, function () {
console.log('server running at http://127.0.0.1:8080');
});

req 请求对象

只要服务器接收到了客户端的请求,就会调用通过 server.on() 为服务器绑定的 request 事件处理函数。
如果想在事件处理函数中,访问与客户端相关的数据或属性,可以使用如下的方式:

  • req.url:客户端请求的 URL 地址
  • req.method:客户端请求的 method 类型
1
2
3
4
5
6
7
8
9
10
11
12
13
14
const http = require('http');
const server = http.createServer();
// req 是请求对象,包含了与客户端相关的数据和属性
server.on('request', (req, res) => {
// req.url 是客户端请求的 URL 地址
const url = req.url;
// req.method 是客户端请求的 method 类型
const method = req.method;
const str = `Your request url is ${url}, and request method is ${method}`;
console.log(str);
});
server.listen(80, () => {
console.log('server running at http://127.0.0.1');
});

res 响应对象

在服务器的 request 事件处理函数中,如果想访问与服务器相关的数据或属性,可以使用如下的方式:

  • res.end():向客户端响应一些内容
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
const http = require('http');
const server = http.createServer();
// req 是请求对象,包含了与客户端相关的数据和属性
server.on('request', (req, res) => {
// req.url 是客户端请求的 URL 地址
const url = req.url;
// req.method 是客户端请求的 method 类型
const method = req.method;
const str = `Your request url is ${url}, and request method is ${method}`;
console.log(str);
// 调用 res.end() 方法,向客户端响应一些内容
res.end(str);
});
server.listen(80, () => {
console.log('server running at http://127.0.0.1');
});

解决中文乱码问题

当调用 res.end() 方法,向客户端发送中文内容的时候,会出现乱码问题,此时,需要手动设置内容的编码格式:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const http = require('http');
const server = http.createServer();

server.on('request', (req, res) => {
// 定义一个字符串,包含中文的内容
const str = `您请求的 URL 地址是 ${req.url},请求的 method 类型为 ${req.method}`;
// 调用 res.setHeader() 方法,设置 Content-Type 响应头,解决中文乱码的问题
res.setHeader('Content-Type', 'text/html; charset=utf-8');
// res.end() 将内容响应给客户端
res.end(str);
});

server.listen(80, () => {
console.log('server running at http://127.0.0.1');
});

综合案例-动态响应内容

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const http = require('http');
const server = http.createServer();

server.on('request', (req, res) => {
// 1. 获取请求的 url 地址
const url = req.url;
// 2. 设置默认的响应内容为 404 Not found
let 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');
});

综合案例-在线时钟

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const http = require('http');
const fs = require('fs');
const path = require('path');

const server = http.createServer();
server.on('request', (req, res) => {
const url = req.url;
// const fpath = path.join(__dirname, url);
let fpath = '';
if (req.url == '/') {
fpath = path.join(__dirname, './clock/index.html');
} else {
fpath = path.join(__dirname, '/clock', url);
}
fs.readFile(fpath, 'utf8', (err, data) => {
if (err) {
return res.end('404 Not Found.');
}
res.end(data);
});
});
server.listen(80, () => {
console.log('server running at http://127.0.0.1');
});

Node.js 中的模块化

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

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

加载模块

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

1
2
3
4
5
6
7
8
// 内置模块
const fs = require('fs');

// 用户自定义模块
const custom = require('./custom.js');

// 第三方模块
const moment = require('moment');

模块作用域

与函数作用域类似,在自定义模块中定义的变量、方法等成员,只能在当前模块内被访问,这种模块级别的访问限制,叫做模块作用域。模块作用域防止了全局变量污染的问题。

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

  1. module 对象

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

  1. module.exports 对象

在自定义模块中,可以使用 module.exports 对象,将模块内的成员共享出去,供外界使用。
外界用 require() 方法导入自定义模块时,得到的就是 module.exports 所指向的对象。

  1. 共享成员时的注意点

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// 在一个自定义模块中,默认情况下, module.exports = {}
const age = 20;

// 向 module.exports 对象上挂载 username 属性
module.exports.username = 'zs';
// 向 module.exports 对象上挂载 sayHello 方法
module.exports.sayHello = function () {
console.log('Hello!');
};
module.exports.age = age;

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

// 最终,向外共享的结果,永远都是 module.exports 所指向的对象
// { username: 'zs', age: 20, sayHello: [Function (anonymous)] }
  1. exports 对象

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
console.log(exports); // {}
console.log(module.exports); // {}
console.log(exports === module.exports); // true

const username = 'zs';

module.exports.username = username;
exports.age = 20;
exports.sayHello = function () {
console.log('大家好!');
};

// 最终,向外共享的结果,永远都是 module.exports 所指向的对象
// { nickname: '小黑', sayHi: [Function: sayHi] }
  1. exports 和 module.exports 的使用误区

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

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

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
// {gender: '男', age: 22}
exports.username = 'zs';
module.exports = {
gender: '男',
age: 22,
};

// {username: 'zs'}
module.exports.username = 'zs';
exports = {
gender: '男',
age: 22,
};

// {username: 'zs', age: 22}
exports.username = 'zs';
module.exports.gender = '男';

// {username: 'zs', gender: '男', age: 22}
exports = {
username: 'zs',
gender: '男',
};
module.exports = exports;
module.exports.age = 22;

模块化规范

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

  • 每个模块内部,,module 变量代表当前模块
  • module 变量是一个对象,module.exports 属性是对外的接口
  • require() 加载某个模块,其实是加载该模块的 module.exports 属性

npm 与包

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

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

发布包

1
2
3
4
5
6
7
8
9
10
11
// 非官方源会报错
npm config set registry https://registry.npmjs.org

// 初始化包的信息
npm init

// 登录账号
npm login

// 发布包
npm publish

删除包

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

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

模块的加载机制

模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次。
注意:不论是内置模块、用户自定义模块、还是第三方模块,它们都会优先从缓存中加载,从而提高模块的加载效率。

内置模块

内置模块是由 Node.js 官方提供的模块,内置模块的加载优先级最高。
例如,require('fs') 始终返回内置的 fs 模块,即使在 node_modules 目录下有名字相同的包也叫做 fs。

自定义模块

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

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

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

第三方模块

如果传递给 require() 的模块标识符不是一个内置模块,也没有以 ‘./’ 或 ‘../’ 开头,则 Node.js 会从当前模块的父目录开始,尝试从 /node_modules 文件夹中加载第三方模块。如果没有找到对应的第三方模块,则移动到再上一层父目录中,进行加载,直到文件系统的根目录。

例如,假设在 'C:\Users\itheima\project\foo.js' 文件里调用了 require('tools'),则 Node.js 会按以下顺序查找:

  1. C:\Users\itheima\project\node_modules\tools
  2. C:\Users\itheima\node_modules\tools
  3. C:\Users\node_modules\tools
  4. C:\node_modules\tools

目录作为模块

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

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