【前端】NodeJS：express框架

子非鱼921

于 2024-08-12 13:57:49 发布

阅读量884

点赞数 38

分类专栏：【前端】NodeJS 文章标签：前端 express node.js javascript 开发语言

本文链接：https://blog.csdn.net/weixin_45980065/article/details/141124964

版权

【前端】NodeJS 专栏收录该内容

18 篇文章 0 订阅

订阅专栏

1 介绍

express是一个基于Node.js平台的极简、灵活的WEB应用开发框架，官方网址：https://www.expressjs.com.cn/。简单来说，express是一个封装好的工具包，封装了很多功能，便于我们开发WEB应用（HTTP服务）。

2 express使用

2.1 express下载

express本身是一个npm包，所以可以通过npm安装。

npm init
npm i express

2.2 express初体验

创建JS文件。

//导入 express
const express = require('express');

//创建应用对象
const app = express();

/*
  当浏览器把请求发送过来之后，如果请求的方法是get, 并且请求url的路径是/home的话，
  会执行回调函数，为浏览器响应结果
*/
//创建路由，req：请求报文的封装对象, res：响应报文的封装对象
app.get('/home', (req, res) => {
  	res.end('hello express');
});

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....')
})

命令行下执行该脚本。

node <文件名>
// 或者
nodemon <文件名>

然后在浏览器就可以访问http://127.0.0.1:3000/home。

3 express路由

3.1 什么是路由

官方定义：路由确定了应用程序如何响应客户端对特定端点的请求。

3.2 路由的使用

一个路由的组成：请求方法、路径和回调函数。
express中提供了一系列方法，可以很方便的使用路由，使用格式：app.<method>(path，callback)。

//导入 express
const express = require('express');

//创建应用对象
const app = express();

//创建路由
app.get('/home', (req, res) => {
  	res.end('hello express');
});

//首页路由
app.get('/', (req, res) => {
  	console.log(req.ip);
  	res.end('home');
});

//post
app.post('/login', (req, res) => {
  	res.end('login login');
});

//匹配所有的方法
app.all('/test', (req, res) => {
  	res.end('test test');
})

//404 响应
app.all('*', (req, res) => {
  	res.end('404 not Found');
});

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

3.3 获取请求参数

express框架封装了一些API来方便获取请求报文中的数据，并且兼容原生HTTP模块的获取方式。

//导入 express
const express = require('express');

//创建应用对象
const app = express();

//获取请求的路由规则
app.get('/request', (req, res) => {
  	//原生操作，获取报文的方式与原生 HTTP 获取方式是兼容的
  	console.log(req.method);
  	console.log(req.url);
  	console.log(req.httpVersion);
  	console.log(req.headers);

  	//express 独有的获取报文的方式
  	console.log(req.path);
  	console.log(req.query); //获取查询字符串
  	console.log(req.ip); //获取 ip
  	console.log(req.get('host')); //获取指定的请求头

	res.send('请求报文的获取');
  	res.end('hello express');
});

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

3.4 获取路由参数

路由参数：URL路径中的参数（数据）。

//导入 express
const express = require('express');

//创建应用对象
const app = express();

//创建路由
app.get('/:id.html', (req, res) => {
  	//获取 URL 路由参数
  	console.log(req.params.id); //params是req的一个属性，存储所有路由参数，id是路由参数中的一个（要与占位符名字保持一致）
  	res.setHeader('content-type','text/html;charset=utf-8');
  	res.end('商品详情');
});

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

3.5 路由参数练习

根据路由参数响应歌手的信息（姓名和图片）。

{
  "singers": [
    {
      "singer_name": "周杰伦",
      "singer_pic": "http://y.gtimg.cn/music/photo_new/T001R150x150M0000025NhlN2yWrP4.webp",
      "other_name": "Jay Chou",
      "singer_id": 4558,
      "id": 1
    },
    {
      "singer_name": "林俊杰",
      "singer_pic": "http://y.gtimg.cn/music/photo_new/T001R150x150M000001BLpXF2DyJe2.webp",
      "other_name": "JJ Lin",
      "singer_id": 4286,
      "id": 2
    },
    {
      "singer_name": "G.E.M. 邓紫棋",
      "singer_pic": "http://y.gtimg.cn/music/photo_new/T001R150x150M000001fNHEf1SFEFN.webp",
      "other_name": "Gloria Tang",
      "singer_id": 13948,
      "id": 3
    }
  ]
}

/**
 * 练习：根据路由参数响应歌手信息
 */
//导入 express
const express = require('express');
//导入 json 文件
const {singers} = require('./singers.json');
//创建应用对象
const app = express();

//创建路由
app.get('/singer/:id.html', (req, res) => {
  	//获取路由参数
  	let {id} = req.params;
  	//在数组中寻找对应 id 的数据
  	let result = singers.find(item => {
    	if(item.id === Number(id)){
      		return true;
    	}
  	});

  //判断
  if(!result){
  		res.statusCode = 404;
    	res.end(`<h1>404 Not Found</h1>`)
   		return;
  }

  res.end(`
  <!DOCTYPE html>
  <html lang="en">
  <head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
  </head>
  <body>
    <h2>${result.singer_name}</h2>
    <img src='${result.singer_pic}' />
  </body>
  </html>`);
});

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

4 express响应设置

express框架封装了一些API来方便给客户端响应数据，并且兼容原生HTTP模块的获取方式。

//导入 express
const express = require('express');

//创建应用对象
const app = express();

//创建路由
app.get('/response', (req, res) => {
  	//express 中设置响应的方式兼容 HTTP 模块的方式
  	res.statusCode = 404;
  	res.statusMessage = 'love';
  	res.setHeader('xxx', 'yyy');
  	res.write('hello express ')
  	res.end('response');

  	//express 的响应方法
  	res.status(500); //设置响应状态码
  	res.set('aaa','bbb'); //设置响应头
  	res.send('你好 Express'); //设置响应体 //send自动设置响应头，（无乱码）
  	res.status(500).set('abc','def').send('这都是 OK 的'); //可以连贯操作
});

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

//导入 express
const express = require('express');

//创建应用对象
const app = express();

//创建路由
app.get('/other', (req, res) => {
  	//跳转响应，重定向
  	res.redirect('http://atguigu.com');
  	//下载响应
  	res.download(__dirname + '/package.json');
  	//JSON 响应
  	res.json({
    	name: '尚硅谷',
  		slogon: '让天下没有难学的技术'
   	});
  	//响应文件内容
  	res.sendFile(__dirname + '/test.html'); // path.resolve()
});

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

5 express中间件

5.1 什么是中间件

中间件（Middleware）本质是一个回调函数。
中间件函数可以像路由回调一样访问请求对象（request）和响应对象（response）。

5.2 中间件的作用

中间件的作用：使用函数封装公共操作，简化代码。

5.3 中间件的类型

全局中间件
路由中间件

5.3.1 定义全局中间件

每一个请求到达服务端之后都会执行全局中间件函数。

声明中间件函数：

let recordMiddleware = function(request,response,next){
	//实现功能代码
	//.....
	//执行next函数(当如果希望执行完中间件函数之后，仍然继续执行路由中的回调函数，必须调用next)
	next();
}

应用中间件：

app.use(recordMiddleware);

声明时可以直接将匿名函数传递给use：

app.use(function (request, response, next) {
	console.log('定义第一个中间件');
	next();
})

5.3.2 多个全局中间件

express允许使用app.use()定义多个全局中间件。

app.use(function (request, response, next) {
	console.log('定义第一个中间件');
	next();
})
app.use(function (request, response, next) {
	console.log('定义第二个中间件');
	next();
})

/*
 * 记录每个请求的 url 与 IP 地址，存到文件中
 * 
 * 全局中间件：只要发请求，全局中间件就会执行，执行完毕后，执行后续的路由回调。
 */
//导入 express
const express = require('express');
const fs = require('fs');
const path = require('path');

//创建应用对象
const app = express();

//声明中间件函数，test指向后续的路由回调或中间件回调
function recordMiddleware(req, res, next){
  	//获取 url 和 ip
  	let {url, ip} = req;
  	//将信息保存在文件中 access.log
  	fs.appendFileSync(path.resolve(__dirname, './access.log'), `${url}  ${ip}\r\n`);
  	//调用 next，执行后续的路由回调
  	next();
}

//使用中间件函数
app.use(recordMiddleware);

//创建路由
app.get('/home', (req, res) => {
  	res.send('前台首页');
});

app.get('/admin', (req, res) => {
  	res.send('后台首页');
});

app.all('*',(req, res) => {
  	res.send('<h1>404 Not Found</h1>');
})

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

5.3.3 定义路由中间件

如果只需要对某一些路由进行功能封装，则就需要路由中间件：

app.get('/路径',`中间件函数`,(request,response)=>{

});
app.get('/路径',`中间件函数1`,`中间件函数2`,(request,response)=>{

});

/**
 * 针对 /admin  /setting 的请求, 要求 URL 携带 code=521 参数, 如未携带提示『暗号错误』  
 * 
 * 路由中间件：路由中间件与路由放在一起，只有满足某个路由规则，它所对应的回调函数（中间件）才会执行。
 */

//导入 express
const express = require('express');

//创建应用对象
const app = express();

//创建路由
app.get('/home', (req, res) => {
  res.send('前台首页');
});

//声明中间件，放在受约束的路由规则中
let checkCodeMiddleware = (req, res, next) => {
  //判断 URL 中是否 code 参数等于 521（通过报文过来的内容都是字符串）
  if(req.query.code === '521'){
    next();
  }else{
    res.send('暗号错误');
  }
}

//后台
app.get('/admin', checkCodeMiddleware, (req, res) => {
  res.send('后台首页');
});

//后台设置
app.get('/setting', checkCodeMiddleware, (req, res) => {
  res.send('设置页面');
});

app.all('*',(req, res) => {
  res.send('<h1>404 Not Found</h1>')
})

//监听端口, 启动服务
app.listen(3000, () => {
  console.log('服务已经启动, 端口 3000 正在监听中....')
})

5.4 静态资源中间件

//导入 express
const express = require('express');

//创建应用对象
const app = express();

//创建路由
app.get('/', (req, res) => {
  	res.send('我才是首页~~~');
});

/*
	静态资源中间件的设置，将当前文件夹下的public目录作为网站的根目录。
	static的参数就是静态资源文件夹的路径，当浏览器把请求发送过来后，服务端就会在文件夹中找对应的文件，读取文件，响应文件内容。
	如果访问的内容经常变化，还是需要设置路由。
	但是，在这里有一个问题，如果public目录下有index.html文件，单独也有index.html的路由，则谁书写在前，优先执行谁。
*/
//静态资源中间件设置
app.use(express.static(__dirname + '/public'));

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

index.html 文件为默认打开的资源。
如果静态资源与路由规则同时匹配，谁先匹配谁就响应。
路由响应动态资源，静态资源中间件响应静态资源。

5.5 获取请求体数据body-parser

express可以使用body-parser包处理请求体。

安装：npm i body-parser。
导入 body-parser 包：const bodyParser = require('body-parser');。
获取中间件函数：

//处理 querystring 格式的请求体
let urlParser = bodyParser.urlencoded({extended:false}));
//处理 JSON 格式的请求体
let jsonParser = bodyParser.json();

设置路由中间件，然后使用request.body来获取请求体数据：

app.post('/login', urlParser, (request,response)=>{
	//获取请求体数据
	//console.log(request.body);
	//用户名
	console.log(request.body.username);
	//密码
	console.log(request.body.userpass);
	response.send('获取请求体数据');
});

/**
 * 按照要求搭建 HTTP 服务
 * 
 * GET   /login  显示表单网页
 * POST  /login  获取表单中的『用户名』和『密码』
 */

/**
 * bodyParser：解析请求体，一个中间件，需要安装，npm i bodyParser
 */
//导入 express
const express = require('express');
const bodyParser = require('body-parser')

//创建应用对象
const app = express();

//解析 JSON 格式的请求体的中间件
// const jsonParser = bodyParser.json()

//解析 querystring 格式请求体的中间件
const urlencodedParser = bodyParser.urlencoded({ extended: false })

//创建路由规则
app.get('/login', (req, res) => {
  	// res.send('表单页面')
  	//响应 HTML 文件内容
  	res.sendFile(__dirname + '/form.html');
});

//post 规则
//urlencodedParser中间件函数在执行完毕之后，会在请求对象上添加一个属性->body
app.post('/login', urlencodedParser, (req, res) => {
  	//获取 用户名 和 密码
  	console.log(req.body);
  	res.send('获取用户的数据');
});

//启动服务
app.listen(3000, () => {
  	console.log('server is running...');
})

获取到的请求体数据：[Object: null prototype] { username: 'admin', userpass: '123456' }。

5.6 图片防盗链

//导入 express
const express = require('express');

//创建应用对象
const app = express();

//声明中间件
app.use((req, res, next) => {
  	//检测请求头中的 referer 是否为 127.0.0.1
  	//获取 referer
  	let referer = req.get('referer');
  	if(referer){
    	//实例化
    	let url = new URL(referer);
    	//获取 hostname
    	let hostname = url.hostname;
    	//判断
    	if(hostname !== '127.0.0.1'){
      		//响应 404 
      		res.status(404).send('<h1>404 Not Found</h1>');
      		return;
    	}
  	}
  	next();
});

//静态资源中间件设置
app.use(express.static(__dirname + '/public'));

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

6 Router

6.1 什么是Router

express中的Router是一个完整的中间件和路由系统，可以看做是一个小型的app对象。

6.2 Router作用

对路由进行模块化，更好的管理路由。

6.3 Router使用

创建独立的JS文件（homeRouter.js）：

//1. 导入 express
const express = require('express');
//2. 创建路由器对象
const router = express.Router();
//3. 在 router 对象身上添加路由
router.get('/', (req, res) => {
	res.send('首页');
})
router.get('/cart', (req, res) => {
	res.send('购物车');
});
//4. 暴露
module.exports = router;

主文件：

/**
 * 针对 /admin  /setting 的请求, 要求 URL 携带 code=521 参数, 如未携带提示『暗号错误』  
 */
//导入 express
const express = require('express');
//5.引入子路由文件
const homeRouter = require('./routes/homeRouter');
const adminRouter = require('./routes/adminRouter');

//创建应用对象
const app = express();

//6.设置和使用中间件
app.use(homeRouter);
app.use(adminRouter);

app.all('*',(req, res) => {
  	res.send('<h1>404 Not Found</h1>');
})

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

7 EJS模板引擎

7.1 什么是模板引擎

模板引擎是分离用户界面和业务数据的一种技术。

7.2 什么是EJS

EJS是一个高效的Javascript的模板引擎。
官网：https://ejs.co/
中文站：https://ejs.bootcss.com/

7.3 EJS初体验

下载安装EJS：npm i ejs --save。

/**
 * EJS模板引擎用来分离HTML和JS
 */
//1. 安装 EJS
//2. 导入 EJS
const ejs = require('ejs');
const fs = require('fs');

//字符串
let china = '中国';
// let str = `我爱你 ${china}`;
let weather = '今天天气不错~';

//声明变量
let str = fs.readFileSync('./01_html.html').toString();

//使用 ejs 渲染
//<%= %> 是ejs解析内容的标记，作用是输出当前表达式的执行结构
let result = ejs.render(str, {china: china, weather});
//let result = ejs.render('我爱你 <%= china %>', {china: china});

console.log(result);

01_html.html：

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
</head>
<body>
  <h2>我爱你 <%= china %></h2>
  <p><%= weather %></p>
</body>
</html>

7.4 EJS 常用语法

执行JS代码：<% code %>。
输出转义的数据到模板上：<%= code %>。
输出非转义的数据到模板上：<%- code %>。

7.5 列表渲染

const ejs = require('ejs');
//西游记
const xiyou = ['唐僧','孙悟空','猪八戒','沙僧'];

//原生 JS
// let str = '<ul>';

// xiyou.forEach(item => {
//   str += `<li>${item}</li>`;
// })

// //闭合 ul
// str += '</ul>';

// console.log(str);

// EJS 实现
const fs = require('fs');
let html = fs.readFileSync('./02_西游.html').toString();
let result = ejs.render(html, {xiyou:xiyou});

console.log(result);

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>西游四人组</title>
</head>
<body>
  <h2>西游四人组</h2>
  <ul>
    <% xiyou.forEach(item => { %>
    <li><%= item %></li>
    <% }) %>
  </ul>
</body>
</html>

7.6 条件渲染

/**
 * 条件渲染：根据条件输出结果内容
 * 
 * 通过 isLogin 决定最终的输出内容
 * true   输出『<span>欢迎回来</span>』
 * false  输出『<button>登录</button>  <button>注册</button>』
 */
// 导入 ejs
const ejs = require('ejs');
const fs = require('fs');
//变量
let isLogin = true;

//原生 JS
// if(isLogin){
//   console.log('<span>欢迎回来</span>')
// }else{
//   console.log('<button>登录</button>  <button>注册</button>');
// }

//EJS 实现
//读取 HTML 内容
let html = fs.readFileSync('./03_home.html').toString();
let result = ejs.render(html, {isLogin: isLogin});

console.log(result);

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
</head>
<body>
  <header>
    <% if(isLogin){ %>
    <span>欢迎回来</span>
    <% }else{ %>
    <button>登录</button>  <button>注册</button>
    <% } %>
  </header>
</body>
</html>

7.7 express中使用ejs

//导入 express
const express = require('express');
//导入 path
const path = require('path');
//创建应用对象
const app = express();
//1. 设置模板引擎
app.set('view engine', 'ejs');// pug  twing
//2. 设置模板文件存放位置   模板文件: 具有模板语法内容的文件
app.set('views', path.resolve(__dirname, './views'));

//创建路由
app.get('/home', (req, res) => {
  	//3. render 响应
  	// res.render('模板的文件名', '数据');
  	//声明变量
  	let title = '尚硅谷 - 让天下没有难学的技术';
  	res.render('home', {title});
  	//4. 创建模板文件
});

//监听端口, 启动服务
app.listen(3000, () => {
  	console.log('服务已经启动, 端口 3000 正在监听中....');
})

home.ejs：

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
</head>
<body>
  <h2><%= title %></h2>
</body>
</html>

8 Express应用程序生成器

Express中文网：https://www.expressjs.com.cn/starter/generator.html。
通过应用生成器工具 express-generator 可以快速创建一个应用的骨架。

8.1 上传图片实例

var express = require('express');
var router = express.Router();
//导入
const formidable = require('formidable');

/* GET home page. */
router.get('/', function(req, res, next) {
  	res.render('index', { title: 'Express' });
});

//显示网页的 (表单)
router.get('/portrait', (req, res) => {
  	res.render('portrait');
});

//处理文件上传
router.post('/portrait', (req, res) => {
  	//创建 form 对象
  	const form = formidable({ 
    	multiples: true,
    	//设置上传文件的保存目录
    	uploadDir: __dirname + '/../public/images',
    	//保持文件后缀
    	keepExtensions: true
  	});
  	//解析请求报文
  	form.parse(req, (err, fields, files) => {
    	if (err) {
      		next(err);
      		return;
    	}
    	// console.log(fields);// 除了文件上传以外的字段，text  radio  checkbox  select
    	// console.log(files); // file
    
    	/**
     	* 图片从客户端发送到服务器端，服务端将图片保存在静态资源文件夹（public）下，
     	* 再将url保存在数据库中，等用户访问时，就可以将路径返回给用户，
     	* 用户通过image标签和url，再向服务端发请求，就可以获得图片内容，头像就可以显示了
     	*/
    	//服务器保存该图片的访问 URL，
    	// /images/8ad3d5e36012212ba7642c000.jpg
    	let url = '/images/' + files.portrait.newFilename; // 将来将此数据保存在数据库中
    
    	res.send(url);
  	});
});

module.exports = router;

<!DOCTYPE html>
<html lang="en">
<head> 
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>文件上传</title>
</head>
<body>
  <h2>文件上传</h2>  <!--文件上传也是在发送http请求报文-->
  <hr>
  <!--                                            文件上传的必需的属性             -->
  <form action="/portrait" method="post" enctype="multipart/form-data">
    用户名: <input type="text" name="username"><br>
    头像: <input type="file" name="portrait"><br>
    <hr>
    <button>点击提交</button>
  </form>
</body>
</html>