1. Server-side Web Programming
- 服务端和客户端通常协同工作提供完整的用户体验
1.1 Client-side Programming
- 采用client-side programming时,所有代码和数据都在本地执行
- 主要用于UI渲染和用户交互
- 本地运算处理,响应速度快
- 本地数据容易被修改
1.2 Server-side Programming
- 采用server-side programming时
- 主要处理业务逻辑,数据计算,数据库操作
- 网络延迟较高,因此一般不用于处理对延迟敏感的任务
- 数据由服务器集中管理,跨设备和位置共享数据
2. Introduction to Node.js
- Node.js是一个免费的开源服务器环境
- 在服务端上使用JavaScript
- 快速且性能卓越,拥有庞大的社区和极高的普及度
2.1 Node.js can do
- 可以生成动态页面内容
- 可以在服务器上创建/打开/读取/写入/删除/关闭文件
- 可以收集表单数据
- 可以对数据库进行添加/删除/修改等操作
Node.js File
- 包含在特定事件发生时将执行的任务对应代码
- 必须在服务器上初始化后才能生效
- 扩展名为
.js(通常是CommonJS或ESM module)
3. Asynchronous Programming
3.1 Synchronous vs Asynchronous Programming
- Synchronous programming(同步编程): 按顺序进行,等待前一个任务完成后再进行下一个任务, 其执行流程可预测
- Aynchronous programming: 并发执行,在等待后台异步任务完成的同时继续执行其他任务,尤其适合等待I/O操作,无需多线程
- 在Node.js中,异步编程通过以下方式实现
- Callback handlers(旧)
- Promise
- Async/await语法(以promise为基础)
3.2 Callbacks and Callback Hell
- 在过去由于Javascript的异步性质,许多Javascript函数接受一个callback parameter用于定义任务完成/失败后要运行的代码
- 例子中的readFile方法不返回任何东西,而是在完成后把结果交给data再传入callback:
fs.readFile('demo.txt','utf-8',(err,data) => {console.log(data)})
console.log('这行会先打印');Callback hell
- 典型的,当任务串行时(下一个任务需要等待上一个任务完成并返回),代码就会重复缩进,难以阅读且难以维护
fs.readFile('config.json', 'utf-8', (err, config) => {
if (err) return console.error(err);
fs.readFile('data.txt', 'utf-8', (err, data) => {
if (err) return console.error(err);
fs.writeFile('result.txt', config + data, (err) => {
if (err) return console.error(err);
console.log('done');
});
});
});- 每多一个串行步骤就多一层缩进,错误处理也要重复写
3.3 Promises
- promise表示一个异步操作最终完成(或失败)及其结果值,有以下三种状态
- pending: 初始状态
- resolved: 操作成功完成
- rejected: 操作失败
Compare to callbacks
Callback
import fs from 'fs';
function read_file() {
fs.readFile('demo.txt', 'utf-8', (err, data) => {
if (err !== null) {
console.error('error', err);
return;
}
console.log(data);
});
}
read_file();Promise
import fs from 'fs/promises'; //注意这里由fs变成fs/promises
function read_file() {
fs.readFile('demo.txt', 'utf-8')
.then((data) => {
console.log(data);
})
.catch((err) => {
console.error('error', err);
});
}
read_file();- promise链做到了让缩进不随依赖层数增长,错误处理从每层一次变为链尾一次(此处未体现)
3.4 Async/Await
- async/await构建在promise之上,让异步代码写起来像是同步代码
import fs from 'fs/promises';
async function read_file() {
try {
const data = await fs.readFile('demo.txt', 'utf-8');
console.log(data);
/*等价return fs.readFile('demo.txt', 'utf-8').then((data) => {
console.log(data);
})*/
} catch (err) {
console.error('error', err);
}
}
read_file();async函数总是返回一个promise;await等待promise完成并直接取出结果,失败时抛出异常交给catch
4. Node.js Modules
- Node.js包含一整套内置module,无需额外安装即可使用
4.1 Import and Export
- 此处展示ES Module的写法
- export
export const MyDateTime = () => {
return Date();
};- import
import http from 'http';
import { MyDateTime } from './myfirstmodule.js';
http.createServer((req.res)=>{
res.writeHead(200,{'Content-Type':'text/html;charset=utf-8'});
res.write("The date and time are currently:"+MyDateTime());
res.end();
})4.2 CommonJS vs ES Modules (ESM)
- 两套模块系统不能在同一文件中混用,
.js文件按哪套解析由最近的package.json中"type"字段决定
| 对比项 | CommonJS | ESM |
|---|---|---|
| 导入/导出 | require() / module.exports | import / export |
| 加载时机 | 运行时调用,用到才加载 | 静态声明,求值前先解析 |
| 书写位置 | 可写在if、函数内部 | 只能写在模块顶层 |
| 路径后缀 | require('./x')可省略.js | import './x.js'必须写全 |
| 启用方式 | .js默认,或.cjs强制 | package.json设"type":"module",或.mjs强制 |
5. Node.js HTTP Modules
- Node.js内置HTTP模块,能让Node.js通过Hypter Text Transfer Portocol(HTTP)传输数据
import http from 'http'5.1 Creating an HTTP Server
import http from 'http';
http.createServer((req,res)=>{ //创建server实例
res.write('Hello World!'); //以hello world作为response
res.end(); //停止response
}).listen(8080); //监听8080端口- 每当有人尝试访问8080端口时执行http.createServer()的传入函数
5.2 HTTP Headers
- 如果希望HTTP server的响应按照HTML显示,就需要带上内容类型正确的HTTP header
- res.writeHead() 方法的第一个参数是状态码,200 表示一切正常;第二个参数是一个包含响应头的对象
import http from 'http';
http.createServer((req, res) => {
res.writeHead(200, {'Content-Type': 'text/html; charset=utf-8'}); //header部分
res.write('Hello World!');
res.end();
}).listen(8080);5.3 URL and Query String Parsing
import http from 'http';
http.createServer((req, res) => {
res.writeHead(200, {'Content-Type': 'text/html; charset=utf-8'});
res.write(req.url); //req参数作为一个对象表示的来自客户端的请求,url是这个对象的其中一个属性,即请求的路径,此处代表将请求路径写回页面
res.end();
}).listen(8080);- 空格不能裸着出现在请求行中,浏览器发出前会把它转成
%20 - 使用URL模块进一步拆解网址
import { URL } from 'url';
// Create a new URL object
const myURL = new URL('https://www.example.com:8080/path/?param=value#fragment');
console.log('Host:', myURL.host); //host拆分整个域名带端口(www.example.com:8080)
console.log('Path:', myURL.pathname); //pathname拆分path,输出保留前后的斜杠(/path/)
console.log('Query:', myURL.search); // search查询参数字符串,前导必定是?(?param=value)
console.log('Fragment:', myURL.hash); //hash定位哈希值锚点,前导必定是#(#fragment)URLSearchParams
import { URLSearchParams } from 'url';
const myURL = new URL('https://www.example.com/path/?param1=value1¶m2=value2¶m3=value3');
// Get the search params
const searchParams = new URLSearchParams(myURL.search);
// Get a specific parameter value
console.log(searchParams.get('param1')); // Output: value1
// Loop through all parameter key-value pairs
searchParams.forEach((value, key) => {
console.log(key, ':', value);
});6. Node.js File I/O
6.1 File System Module
- 与
http类似,fs也是内置模块
import fs from "fs/promises";- 常见的
fsmodule用途包括: 读取文件、创建文件、更新文件、上传文件、删除文件、重命名文件
6.2 Reading and Creating Files
Reading File
- 最小的静态文件服务器构成如下:
- 静态HTML文件:
<html>
<body>
<h1>My Header</h1>
<p>My paragraph.</p>
</body>
</html>- 用于读取HTML文件的Node.js文件
import http from 'http';
import fs from 'fs/promises';
http.createServer((req,res)=>{
fs.readFile('demofile1.html').then((data)=>{ //异步读取文件
res.writeHead(200,{'Content-Type':'text/html'});
res.write(data);
return res.end();
}).catch((err)=>console.error('error',err))
}).listen(8080);Create Files
- 以下三种方法都能在文件不存在时创建它
fs.appendFile(): 追加- 使用appendFile追加
import fs from 'fs/promises';
fs.appendFile('mynewfile1.txt','Hello').then(()=> //创建并追加'Hello'
console.log('Saved!')
).catch((err)=>console.error('error',err));fs.open(): 只打开 -使用open withwflag:
import fs from 'fs/promises';
fs.open('mynewfile2.txt','w').then((file)=>{
console.log('Saved')
}).catch((err)=>console.error('error',err));fs.writeFile(): 覆盖- 使用writeFile覆盖
import fs from 'fs/promises'
fs.writeFile('mynewfile3.txt', 'Hello content!').then(() =>
console.log('Saved!')
).catch((err) => console.error('error', err));6.3 Updating, Deleting, and Renaming Files
Update Files
fs.appendFile()- 整体与Create Files类似:
import fs from 'fs/promises';
fs.appendFile('mynewfile1.txt', ' This is my text.')
.then(() => console.log('Updated!'))
.catch((err) => console.error('error', err));fs.writeFile()- 同上:
import fs from 'fs/promises';
fs.writeFile('mynewfile3.txt', 'This is my text')
.then(() => console.log('Replaced!'))
.catch((err) => console.error('error', err));Delete Files
fs.unlink()
import fs from 'fs/promises';
fs.unlink('mynewfile2.txt').then(()=>
console.log("File deleted")
).catch((error)=>console.error("error",err));Rename Files
fs.rename()
import fs from 'fs/promises';
fs.rename('mynewfile1.txt',"myrenamedfile.txt").then(()=>
console.log("File renamed")
).catch((err)=>console.error("error",err));6.4 File Uploads with Formidable
- Formidable是一个用于处理文件上传的module
import formidable from 'formidable';- (略)
7. Node Package Management
7.1 Packages and NPM
- packages是module的文件集合
npm install将其拉入node_modules- 使用
import在文件中引入 - npm是package manager for node.js packages/modules
7.2 Local and Global Installation
- 全局安装
npm install -g <package-name> - 本地安装
npm install <package-name> - 每次构建项目并使用npm时,我们都需要提供Package.json记录项目的信息
7.3 Package.json Configuration
{
"name": "demo-project", //name:项目名
"version": "1.0.0", //version:项目版本
"main": "src/index.js", //main:项目入口
"scripts": { //scripts:交给包管理器执行的命令
"start": "node src/index.js"
},
"devDependencies": { //devDependencies:只能在开发其使用的依赖
"@types/node": "^20.4.5",
"@types/express": "^4.17.17",
"typescript": "^5.1.6"
},
"dependencies": { //dependencies:项目依赖
"express": "^4.18.2"
}
}npm start: 即scripts.start,等价于npm run startnpm run xxx: 运行scripts中的任意自定义脚本xxxnpm install: 按照package.json安装所有的dependencies和devDependenciesnpm install typescript -D: 安装包并写入devDependenciesnpm install express: 安装包并写入dependencies
7.4 Semantic Versioning
{
...
"package-name":"version",
...
}- 版本号构成:
Major.Minor.Patch - 直接写
1.2.3,版本号必须精确对应 ~1.2.3,可以改变Patch,但是Major/Minor都不能动^1.2.3,可以改变Minor/Patch,但是Major不能变
8. Express.js
8.1 Introduction to Express.js
- express是一个最小化且灵活的Node.js web应用框架,提供简单的API用于构建网页/WEB应用/后端
- 抽象大量的底层细节,简化了HTTP请求和响应的处理流程
8.2 Express.js Installation and Setup
install
npm install --save expresssetup
import express from 'express';
const app = express(); //创建一个express应用实例
app.get('/', (req, res) => { //定义一个GET路由
res.send("Hello world!");
});
app.listen(3000);app.get(route,callback): 规定了当给定的route上发生GET请求时该做什么res.send(): 发送响应,在例子中发送的是字符串”Hello world!“
8.3 Express.js Routing and HTTP Methods
- 在express中应用中使用
app.method(path,handler)定义route - 这里的method可以是任意一个HTTP动作: get, post, put, patch, delete, 还有all(不管什么请求类型都会执行)
- GET: 请求指定资源
- POST: 把请求体提交给集合,由服务器决定新资源的 URI,常用于创建,重复发送会创建多条
- PUT: 用请求体整体替换客户端指定 URI 上的资源(不存在则创建),重复发送结果一致
- PATCH: 只更新资源的部分字段
- DELETE: 请求服务器删除指定资源
- path代表请求要运行的那个route
- handler是回调函数,当相关route上出现匹配的请求类型时执行
8.4 Dynamic Routes and URL Parameters
- 动态路由允许传入参数
import express from 'express';
const app = express();
app.get('/:id',(req.res)=>{ //此处由path中:后的标识符id决定键名
res.send('The id is '+req.params.id);
});
app.listen(3000);- 同时也可以使用regex来限制URL的参数匹配,下例中假设id是一个5位长度的数字
import express from 'express';
const app = express();
app.get('/things/:id([0-9]{5})',(req.res)=>{ //(0-9)代表数字,{5}代表5位数
res.send('ud: '+req.params.id);
})
app.listen(3000);- 更多的匹配规则:
*: 任意字符串, 如/ab*cd匹配/abcd、/abxcd?: 零个或一个字符, 如/ab?cd匹配/acd、/abcd+: 至少一个字符, 如/ab+cd匹配/abcd、/abbcd$: 匹配以指定字符结尾的字符串, 如n$匹配abn、an
8.7 Middleware and Execution Order
- middleware是一个函数:请求经过它时,它能读到请求
req、也能操作响应res,然后用next()把请求交给下一个中间件
import express from 'express';
const app = express();
app.use((req,res,next)=>{
console.log("A new request received at "+Date,now());
next();
})