nodeJs express 路由 如何使用
// 导入 Express 模块 const express = require('express'); // 创建 Express 应用程序 const app = express(); // 定义路由 // 当访问根目录时,返回 "Hello, World!" app.get('/', (req, res) => { res.send('Hello, World!'); }); // 当访问 /about 路径时,返回关于信息 app.get('/about', (req, res) => { res.send('This is the about page.'); }); // 当访问 /contact 路径时,返回联系信息 app.get('/contact', (req, res) => { res.send('Contact us at example@example.com'); }); // 监听端口,启动服务器 const port = 3000; app.listen(port, () => { console.log(`Server is running on port ${port}`); });
nodejs express 路由分类和规则
在 Node.js 中使用 Express 框架进行路由分类和规则的设置是非常常见的。通过路由分类,您可以将不同类型的请求分配给不同的处理函数,这样可以更好地组织代码并提高可维护性。以下是一些常见的路由分类和规则:
基本路由规则:
- 使用
app.METHOD(PATH, HANDLER)
方法设置路由,其中 METHOD 是 HTTP 请求方法(如 GET、POST、PUT、DELETE 等),PATH 是路由的路径,HANDLER 是请求的处理函数。- 可以使用通配符
*
匹配所有路径,或者/:parameter
定义参数化路径。
模块化路由介绍(父包含子路由)
const express = require('express'); const app = express(); // 引入路由模块 const authRoutes = require('./authRoutes'); const blogRoutes = require('./blogRoutes'); // 使用路由模块 app.use('/auth', authRoutes); app.use('/blog', blogRoutes); app.listen(3000, () => { console.log('Server is running on port 3000'); });
接下来,创建
authRoutes.js
文件:const express = require('express'); const router = express.Router(); // 认证相关路由 router.get('/login', (req, res) => { res.send('Login Page'); }); router.get('/register', (req, res) => { res.send('Register Page'); }); module.exports = router;
express 请求参数详解
在Express中,请求参数(request parameters)是通过请求URL的路径部分(path)传递的信息。Express提供了几种方式来访问这些请求参数:
- 路由参数(Route Parameters): 路由参数是通过在路由路径中定义占位符来传递的。这些占位符可以在路由处理函数中通过
req.params
对象访问。例如:// 路由定义 app.get('/users/:id', (req, res) => { console.log(req.params.id); // 访问路由参数 }); // 请求示例:GET /users/123 // 输出:123
- 查询参数(Query Parameters): 查询参数是通过URL中的查询字符串(query string)传递的键值对。可以使用
req.query
对象来访问这些查询参数。例如:// 路由定义 app.get('/search', (req, res) => { console.log(req.query.q); // 访问查询参数 }); // 请求示例:GET /search?q=nodejs // 输出:nodejs
- 请求体参数(Request Body Parameters): 请求体参数通常在POST请求中使用,客户端将数据作为请求的正文(body)发送。Express需要使用中间件(如body-parser)来解析请求体。请求体参数可以通过
req.body
对象访问。例如:// 使用body-parser中间件解析请求体 const bodyParser = require('body-parser'); app.use(bodyParser.json()); // 解析JSON格式的请求体 // 路由定义 app.post('/users', (req, res) => { console.log(req.body.name); // 访问请求体参数 }); // POST请求示例:POST /users { "name": "John" } // 输出:John
这些是Express中常用的请求参数处理方式。根据你的需求,你可以选择其中一种或多种方式来接收和处理请求参数。
使用POST请求来演示如何使用请求体参数
让我们创建一个完整的Express应用,并使用POST请求来演示如何使用请求体参数。我们将创建一个简单的API,用于创建和检索用户。
首先,确保你已经安装了Express和body-parser:
npm install express body-parser
接下来,创建一个名为
app.js
的文件,编写以下代码:const express = require('express'); const bodyParser = require('body-parser'); const app = express(); const PORT = 3000; // 使用body-parser中间件解析JSON格式的请求体 app.use(bodyParser.json()); // 模拟用户数据存储 let users = []; // 创建用户路由 app.post('/users', (req, res) => { const newUser = req.body; // 获取请求体参数 users.push(newUser); // 将新用户添加到用户列表 res.status(201).json(newUser); // 返回新用户信息 }); // 获取所有用户路由 app.get('/users', (req, res) => { res.json(users); // 返回所有用户列表 }); // 启动服务器 app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
现在,我们已经创建了一个简单的Express应用,它包含了两个路由:
POST /users
:用于创建新用户。客户端可以通过发送JSON格式的请求体来提供新用户的信息。GET /users
:用于获取所有用户列表。现在,启动你的应用:
node app.js
现在你的Express应用已经在端口3000上运行了。可以使用任何HTTP客户端(如curl、Postman等)发送POST请求来创建新用户,并使用GET请求来获取所有用户列表。例如,使用curl发送POST请求来创建一个新用户:
curl -X POST -H "Content-Type: application/json" -d '{"name": "Alice", "age": 30}' http://localhost:3000/users
然后,使用curl发送GET请求来获取所有用户列表:
curl http://localhost:3000/users
你应该能够看到新创建的用户信息以JSON格式返回。这就是一个完整的例子,演示了如何在Express应用中使用请求体参数。
express 中间件
Express中间件是一个函数,可以在请求到达路由处理函数之前或之后执行。它可以执行任何任务,如修改请求对象、响应对象,执行其他函数,结束请求-响应循环等。Express中间件在应用程序级别、路由级别或特定请求级别上使用。
下面是一些常见的Express中间件的用法:
- 内置中间件:Express内置了一些常用的中间件,例如
express.static
用于提供静态文件,express.json
用于解析JSON格式的请求体,express.urlencoded
用于解析URL编码的请求体等。使用方法如下:const express = require('express'); const app = express(); // 使用内置中间件 app.use(express.static('public')); // 提供静态文件 app.use(express.json()); // 解析JSON格式的请求体 app.use(express.urlencoded({ extended: true })); // 解析URL编码的请求体
举一个例子说明app.use(express.json())
中间件
const express = require('express'); const app = express(); // 使用 express.json() 中间件解析JSON格式的请求体 app.use(express.json()); // POST请求路由,用于接收JSON格式的请求体 app.post('/api/user', (req, res) => { // 访问请求体中的JSON数据 const userData = req.body; // 在控制台中打印接收到的JSON数据 console.log('Received JSON data:', userData); // 假设这里有一些逻辑,例如将用户数据存储到数据库中 // 返回响应 res.status(200).send('User data received and processed successfully!'); }); // 启动服务器 const PORT = 3000; app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
在上面的示例中,我们创建了一个POST请求路由
/api/user
,用于接收JSON格式的请求体,然后我们使用req.body
访问接收到的JSON数据。当客户端发送POST请求并附带JSON数据时,Express中间件会自动解析请求体,并将解析后的JSON数据附加到req.body
上。你可以使用curl或Postman等工具向这个端点发送POST请求,示例请求如下:
curl -X POST -H "Content-Type: application/json" -d '{"username": "john_doe", "email": "john@example.com"}' http://localhost:3000/api/user
服务器将会接收到这个JSON数据,并在控制台中打印出来。这个例子演示了如何使用
express.json()
中间件来处理JSON格式的请求体。
express 访问数据库MongoDb
const express = require('express'); const mongoose = require('mongoose'); const app = express(); const PORT = 3000; // 连接到MongoDB数据库 mongoose.connect('mongodb://localhost:27017/my_database', { useNewUrlParser: true, useUnifiedTopology: true, }); const db = mongoose.connection; // 定义用户模型 const User = mongoose.model('User', { name: String, email: String, }); // 创建用户路由 app.post('/users', async (req, res) => { try { // 创建新用户 const newUser = new User({ name: req.body.name, email: req.body.email, }); // 将新用户保存到数据库中 await newUser.save(); res.status(201).json(newUser); // 返回新用户信息 } catch (err) { console.error('Error creating user:', err); res.status(500).send('Error creating user'); } }); // 获取所有用户路由 app.get('/users', async (req, res) => { try { // 查询所有用户 const users = await User.find(); res.json(users); // 返回所有用户列表 } catch (err) { console.error('Error fetching users:', err); res.status(500).send('Error fetching users'); } }); // 启动服务器 app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
express validator 表达式校验
const express = require('express'); const { body, validationResult } = require('express-validator'); const app = express(); // 添加表单验证中间件 app.use(express.json()); app.use(express.urlencoded({ extended: false })); // 定义路由来处理表单提交 app.post('/submit-form', [ // 使用express-validator进行字段验证 body('username').notEmpty().withMessage('Username is required'), body('email').isEmail().withMessage('Email is not valid'), body('password').isLength({ min: 6 }).withMessage('Password must be at least 6 characters long') ], (req, res) => { // 检查是否有验证错误 const errors = validationResult(req); if (!errors.isEmpty()) { return res.status(400).json({ errors: errors.array() }); } // 如果验证通过,处理表单提交逻辑 const { username, email, password } = req.body; // 在这里执行你的逻辑,例如保存用户到数据库等 res.send('Form submitted successfully'); }); // 启动服务器 const PORT = 3000; app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
在上面的示例中,我们定义了一个POST路由
/submit-form
来处理表单提交。在路由处理函数中,我们使用express-validator
中的body()
方法来验证请求体中的各个字段。例如,我们使用body('username').notEmpty().withMessage('Username is required')
来验证用户名字段是否为空,以及使用body('email').isEmail().withMessage('Email is not valid')
来验证邮箱字段是否为有效的邮箱格式。你可以根据需要添加其他验证规则。然后,我们检查是否有验证错误,如果有,我们将错误信息作为JSON格式返回给客户端,如果没有验证错误,我们执行表单提交的逻辑。
这就是一个使用
express-validator
进行表单字段验证的简单示例。
express 模板引擎的使用
const express = require('express'); const app = express(); // 设置模板引擎为EJS app.set('view engine', 'ejs'); // 指定存放模板文件的目录(默认为 views 目录) // 如果你的模板文件不在 views 目录下,可以使用 app.set('views', 'your-directory') 来指定 // app.set('views', 'views-directory'); // 路由处理 app.get('/', (req, res) => { // 渲染名为 index.ejs 的模板文件 res.render('index', { title: 'Express App', message: 'Hello, World!' }); }); // 启动服务器 const PORT = 3000; app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
在上面的代码中,我们设置了Express应用的模板引擎为EJS,通过
app.set('view engine', 'ejs')
来实现。然后,我们指定了存放模板文件的目录,这一步是可选的,默认情况下Express会在views
目录下寻找模板文件。接下来,我们定义了一个路由处理函数,当用户访问根路由
/
时,会渲染名为index.ejs
的模板文件,并将一个包含数据的对象传递给模板。在这个例子中,我们传递了title
和message
两个变量给模板。现在,创建一个名为
index.ejs
的EJS模板文件,并将其放置在你的模板文件目录下(默认为views
目录):<!-- index.ejs --> <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title><%= title %></title> </head> <body> <h1><%= message %></h1> </body> </html>
express socket 通信
Socket.io 是一个流行的 Node.js 库,用于实现实时、双向通信的 WebSocket 应用程序。在 Express 中结合 Socket.io 使用可以实现实时通信的功能。下面是一个简单的示例,演示了如何在 Express 应用中使用 Socket.io 实现一个简单的聊天室:
首先,确保你已经安装了 Express 和 Socket.io:
npm install express socket.io
然后,创建一个名为
app.js
的文件,编写以下代码:const express = require('express'); const http = require('http'); const socketIo = require('socket.io'); const app = express(); const server = http.createServer(app); const io = socketIo(server); // 定义一个路由来提供聊天室页面 app.get('/', (req, res) => { res.sendFile(__dirname + '/index.html'); }); // 监听客户端的连接事件 io.on('connection', (socket) => { console.log('A user connected'); // 监听客户端发送的消息 socket.on('chat message', (msg) => { console.log('Message from client:', msg); // 将消息广播给所有客户端 io.emit('chat message', msg); }); // 监听客户端断开连接事件 socket.on('disconnect', () => { console.log('A user disconnected'); }); }); // 启动服务器 const PORT = 3000; server.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
接下来,创建一个名为
index.html
的文件,用作客户端的界面:<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Chat Room</title> </head> <body> <ul id="messages"></ul> <form id="form" action=""> <input id="input" autocomplete="off" /><button>Send</button> </form> <script src="/socket.io/socket.io.js"></script> <script> const socket = io(); const form = document.querySelector('form'); const input = document.querySelector('#input'); form.addEventListener('submit', (e) => { e.preventDefault(); if (input.value) { // 发送消息给服务器 socket.emit('chat message', input.value); input.value = ''; } }); // 监听服务器发送的消息 socket.on('chat message', (msg) => { const item = document.createElement('li'); item.textContent = msg; document.querySelector('#messages').appendChild(item); }); </script> </body> </html>
在这个示例中,我们创建了一个 Express 应用,然后使用 Socket.io 将其升级为支持实时通信的应用。我们定义了一个简单的路由来提供聊天室页面。在服务器端,我们使用
io.on('connection')
来监听客户端的连接事件,并在客户端连接时打印一条消息。然后,我们监听客户端发送的消息事件'chat message'
,并在收到消息时打印到控制台,并使用io.emit()
将消息广播给所有连接的客户端。最后,我们监听客户端断开连接事件,并在客户端断开连接时打印一条消息。在客户端,我们使用 Socket.io 的客户端库来与服务器建立连接,并监听表单的提交事件,当用户发送消息时,通过
socket.emit()
发送消息给服务器。同时,我们使用socket.on('chat message')
来监听服务器发送的消息,并将消息添加到页面上。现在,启动你的应用并访问
http://localhost:3000
,你将可以看到一个简单的聊天室页面,可以在多个浏览器窗口中进行实时聊天。
express 文件上传
在Express中处理文件上传通常需要使用一个中间件来解析multipart/form-data格式的请求体,同时还需要一个文件存储库(例如Multer)来处理文件的上传和存储。下面是一个简单的示例,演示了如何使用Multer中间件在Express应用中实现文件上传功能:
首先,确保你已经安装了Express和Multer:
npm install express multer
然后,创建一个名为
app.js
的文件,编写以下代码:const express = require('express'); const multer = require('multer'); const path = require('path'); const app = express(); const PORT = 3000; // 设置文件存储目录和文件名 const storage = multer.diskStorage({ destination: function (req, file, cb) { cb(null, 'uploads/'); // 文件存储在 uploads 目录中 }, filename: function (req, file, cb) { cb(null, Date.now() + '-' + file.originalname); // 文件名为时间戳 + 原始文件名 } }); // 创建Multer实例并配置文件上传 const upload = multer({ storage: storage }); // 配置静态文件服务,用于提供上传的文件 app.use('/uploads', express.static(path.join(__dirname, 'uploads'))); // 定义文件上传路由 app.post('/upload', upload.single('file'), (req, res) => { // 如果有文件上传,则 req.file 将包含上传的文件信息 // req.body 将包含其他非文件字段的信息 if (!req.file) { return res.status(400).send('No file uploaded.'); } res.send('File uploaded successfully.'); }); // 启动服务器 app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
在上面的代码中,我们使用了Multer中间件来处理文件上传。我们首先设置了文件存储的配置,包括文件存储目录和文件名。然后,我们创建了一个Multer实例,并传入配置对象,用于配置文件上传。接着,我们定义了一个路由
/upload
来处理文件上传,使用upload.single('file')
中间件来处理单个文件的上传。在路由处理函数中,如果有文件上传,则req.file
将包含上传的文件信息,我们可以在这里处理上传的文件。最后,我们启动了Express服务器,并监听在端口3000上。接下来,创建一个HTML文件来创建一个文件上传表单:
<!-- index.html --> <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>File Upload</title> </head> <body> <h2>Upload a file</h2> <form action="/upload" method="post" enctype="multipart/form-data"> <input type="file" name="file" /> <button type="submit">Upload</button> </form> </body> </html>
现在,启动你的应用并访问
http://localhost:3000
,你将会看到一个简单的文件上传表单。选择一个文件并点击“上传”按钮,文件将会被上传到服务器的 uploads 目录中。上传完成后,你可以在浏览器中访问http://localhost:3000/uploads/your-file
来查看上传的文件。
express 文件下载
const express = require('express'); const path = require('path'); const app = express(); const PORT = 3000; // 配置静态文件服务,用于提供待下载的文件 app.use('/downloads', express.static(path.join(__dirname, 'downloads'))); // 定义文件下载路由 app.get('/download/:filename', (req, res) => { const filename = req.params.filename; const filePath = path.join(__dirname, 'downloads', filename); // 使用 res.download() 方法来发送文件给客户端进行下载 res.download(filePath, filename, (err) => { if (err) { console.error('Error downloading file:', err); res.status(404).send('File not found'); } else { console.log('File downloaded successfully'); } }); }); // 启动服务器 app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
在上面的代码中,我们首先使用
express.static()
中间件来指定静态文件服务,以提供待下载的文件。然后,我们定义了一个文件下载路由/download/:filename
,通过动态路由参数:filename
来指定要下载的文件名。在路由处理函数中,我们使用res.download()
方法来发送文件给客户端进行下载。该方法接收文件的完整路径和文件名作为参数,并在下载完成后触发回调函数。如果下载过程中出现错误,则会在回调函数中处理并发送适当的错误响应。现在,将你想要提供下载的文件放置在
downloads
目录中,并命名为你想要的文件名。然后,启动你的应用并访问http://localhost:3000/download/your-file
,浏览器将会下载该文件。
nodejs+ websocket 示例:
WebSocket是一种在单个TCP连接上提供全双工通信的协议,它允许客户端和服务器之间进行实时的双向数据传输。下面我将逐行解释一个简单的WebSocket示例代码。
首先,我们创建一个基于Node.js的WebSocket服务器。假设我们使用ws库来实现WebSocket服务器:
const WebSocket = require('ws'); // 创建WebSocket服务器 const wss = new WebSocket.Server({ port: 8080 }); // 当有新的连接建立时,执行回调函数 wss.on('connection', function connection(ws) { console.log('New client connected'); // 监听客户端发送的消息 ws.on('message', function incoming(message) { console.log('Received message:', message); // 原样返回收到的消息 ws.send(message); }); // 当连接关闭时执行 ws.on('close', function close() { console.log('Client disconnected'); }); });
现在让我逐行解释上面的代码:
const WebSocket = require('ws');
:导入ws库,用于创建WebSocket服务器。
const wss = new WebSocket.Server({ port: 8080 });
:创建WebSocket服务器实例,监听在端口8080上。
wss.on('connection', function connection(ws) { ... });
:当有新的WebSocket连接建立时,执行回调函数。参数ws
是表示连接的WebSocket实例。
ws.on('message', function incoming(message) { ... });
:当接收到客户端发送的消息时,执行回调函数。参数message
是表示接收到的消息。
ws.send(message);
:通过WebSocket连接向客户端发送消息。
ws.on('close', function close() { ... });
:当WebSocket连接关闭时,执行回调函数。接下来,我们可以编写一个简单的客户端代码来连接到WebSocket服务器并发送/接收消息。假设我们使用浏览器作为客户端:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>WebSocket Client</title> </head> <body> <script> const ws = new WebSocket('ws://localhost:8080'); ws.onopen = function() { console.log('WebSocket connection established'); // 发送消息到服务器 ws.send('Hello, WebSocket Server!'); }; ws.onmessage = function(event) { console.log('Received message from server:', event.data); }; ws.onclose = function() { console.log('WebSocket connection closed'); }; </script> </body> </html>
现在让我解释客户端代码:
const ws = new WebSocket('ws://localhost:8080');
:创建一个WebSocket实例,连接到服务器的WebSocket地址。
ws.onopen = function() { ... };
:当WebSocket连接成功建立时,执行回调函数。
ws.send('Hello, WebSocket Server!');
:向服务器发送消息。
ws.onmessage = function(event) { ... };
:当接收到服务器发送的消息时,执行回调函数。参数event.data
表示接收到的消息。
ws.onclose = function() { ... };
:当WebSocket连接关闭时,执行回调函数。以上就是一个简单的WebSocket示例代码,展示了如何使用Node.js和ws库创建WebSocket服务器,并使用浏览器作为客户端与服务器进行通信。
express 分页查询
const express = require('express'); const app = express(); // 模拟的用户数据 const users = [ { id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }, { id: 3, name: 'Charlie' }, { id: 4, name: 'David' }, { id: 5, name: 'Eve' }, // 添加更多用户... ]; // 分页查询路由 app.get('/users', (req, res) => { // 解析客户端请求中的页数和每页条目数,默认为第一页,每页显示5条 const page = parseInt(req.query.page) || 1; const pageSize = parseInt(req.query.pageSize) || 5; // 计算起始索引和结束索引 const startIndex = (page - 1) * pageSize; const endIndex = startIndex + pageSize; // 从用户数组中获取分页数据 const paginatedUsers = users.slice(startIndex, endIndex); // 返回分页数据给客户端 res.json({ page: page, pageSize: pageSize, totalPages: Math.ceil(users.length / pageSize), users: paginatedUsers }); }); // 启动服务器 const PORT = 3000; app.listen(PORT, () => { console.log(`Server is running on port ${PORT}`); });
在上面的代码中,我们创建了一个路由
/users
来处理分页查询请求。在路由处理函数中,我们解析了客户端请求中的页数和每页条目数,默认情况下为第一页,每页显示5条数据。然后,我们计算了起始索引和结束索引,并从用户数组中获取分页数据。最后,我们将分页数据以JSON格式返回给客户端。你可以使用浏览器或者其他HTTP客户端工具发送带有页数和每页条目数的GET请求到
http://localhost:3000/users
,服务器将返回相应的分页数据。例如,你可以尝试发送如下请求:
http://localhost:3000/users?page=2&pageSize=3
将返回第2页的3条数据。http://localhost:3000/users
将返回默认的第1页的5条数据。这就是一个简单的Express分页查询的示例。在实际项目中,你可能需要根据数据库的查询语言和方式来实现分页查询。