当前位置： 首页 > news >正文

Express 模块

news 来源：原创 2025/5/26 2:05:11

目录

安装 Express

Express 的请求和响应对象

创建一个 Express 服务器

创建一个 GET 方式的接口

创建一个 POST 方式的接口

接口返回 void

统一处理异常

跨域请求（CORS）

日志中间件

Express 路由

官网：Express Node.js

Express 是一个灵活且广泛使用的 Node.js Web 应用框架，简化了 Web 应用和 API 的开发。它提供了一系列强大的功能和工具，帮助开发者处理请求、路由、模板渲染、会话管理等常见的 Web 开发任务。

安装 Express

npm install express

Express 的请求和响应对象

req

  • req.query 用于获取 URL 中的查询参数（也就是 URL 中 ? 后面的部分）。示例 URL：http://localhost:3000/test?name=Tom&age=25
  • req.body 用于获取请求体中的数据。一般用于 POST、PUT 或 PATCH 请求。
  • req.params 用于获取 URL 中路径部分的参数。示例 URL：http://localhost:3000/user/123，获取方式：req.params.id 将返回 "123"

res

  • res.send() 用于发送响应数据。它可以处理多种数据类型，包括字符串、对象、数组和 Buffer。它会自动推断数据类型设置响应的 Content-Type。
  • res.json() 是专门用于发送 JSON 数据的方法。它将传入的对象或数组自动转换为 JSON 字符串，并设置 Content-Type 为 application/json。
  • res.status() 用于设置响应的 HTTP 状态码。可以与其他响应方法结合使用，例如 res.status().send() 或 res.status().json()。
  • res.redirect() 用于重定向客户端到另一个 URL。它接受 URL 地址作为参数，浏览器会自动向新的 URL 发送请求。
    • 重定向到一个新的 URL：res.redirect("http://example.com");
    • 重定向到相对 URL：res.redirect("/new-page");
    • 设置重定向状态码（默认是 302）：res.redirect(301, "/new-page");

创建一个 Express 服务器

// 引入 Express
import express from 'express';

// 创建一个 Express 应用
const app = express();

// 启动服务器，监听 3000 端口
app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

// 示例：设置路由处理 GET 请求
app.get('/', (req, res) => {
    res.send('Hello, Express!');
});

创建一个 GET 方式的接口

创建一个GET请求方式的接口，接收参数，返回结果

// app.get
app.get('/test', (req, res) => {
    const { name, age } = req.query;  // 接收 name、age 参数
    console.log({ name, age });
    // 发送响应
    res.send({ name, age });  // 将参数返回给客户端
});

创建一个 POST 方式的接口

全局中间件：会作用于所有的接口。

请求头：Content-Type: application/x-www-form-urlencoded

全局中间件的方式

import express from 'express';

const app = express();

app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

// 全局中间件：用于解析 x-www-form-urlencoded 格式的请求体，全局中间件，表示所有接口都可以使用 x-www-form-urlencoded 方式接收参数
app.use(express.urlencoded({ extended: true }));
// app.use(express.json());     // json 格式的参数

// 创建一个 POST 请求的路由
app.post('/test', (req, res) => {
    const { name, age } = req.body;  // 从请求体中提取参数
    res.send({ name, age });         // 接口返回数据
});

非全局中间件的方式

import express from 'express';

const app = express();

app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

// 创建一个 POST 请求的路由，接收 application/x-www-form-urlencoded 格式的参数
app.post('/test', express.urlencoded({ extended: true }), (req, res) => {
    const { name, age } = req.body;  // 从请求体中提取参数
    res.send({ name, age });         // 接口返回数据
});

请求头：Content-Type: application/json

import express from 'express';

const app = express();

app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

// 全局中间件：用于解析 application/json 格式的请求体
// app.use(express.json());

// 创建一个 POST 请求的路由，接收 application/json 格式的参数
app.post('/test', express.json(), (req, res) => {
    const { name, age } = req.body;  // 从请求体中提取参数
    res.send({ name, age });         // 接口返回数据
});

请求头：Content-Type: multipart/form-data

安装中间件 multer

npm install multer

单文件上传

import express from 'express';
import multer from 'multer';
import fs from 'fs';

const app = express();

app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

// 确保目标目录存在，如果不存在则创建它
const uploadDir = 'D:\\aaa\\bbb';
if (!fs.existsSync(uploadDir)) {
    fs.mkdirSync(uploadDir, { recursive: true });  // 如果目录不存在，创建它
}

// 设置 multer 存储配置（可以设置存储目录和文件名）
const storage = multer.diskStorage({
    destination: (req, file, cb) => {
        cb(null, uploadDir);   // 上传的文件存储目录
    },
    filename: (req, file, cb) => {
        cb(null, Date.now() + '-' + file.originalname);  // 给文件重命名
    }
});

// 初始化 multer 实例，并限制上传的单个文件大小（可选）
const upload = multer({ storage: storage, limits: { fileSize: 10 * 1024 * 1024 } });  // 限制文件大小为 10MB

// 创建 POST 路由，接收 multipart/form-data 格式的数据，upload.single('file') 的 file 是参数名
app.post('/test', upload.single('file'), (req, res) => {
    // req.file 包含上传的文件信息
    if (req.file) {
        res.send(`上传文件成功: ${req.file.filename}`);
    } else {
        res.send('没有文件上传');
    }
});

多文件上传

import express from 'express';
import multer from 'multer';
import fs from 'fs';

const app = express();

app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

// 确保目标目录存在，如果不存在则创建它
const uploadDir = 'D:\\aaa\\bbb';
if (!fs.existsSync(uploadDir)) {
    fs.mkdirSync(uploadDir, { recursive: true });  // 如果目录不存在，创建它
}

// 设置 multer 存储配置（可以设置存储目录和文件名）
const storage = multer.diskStorage({
    destination: (req, file, cb) => {
        cb(null, uploadDir);   // 上传的文件存储目录
    },
    filename: (req, file, cb) => {
        cb(null, Date.now() + '-' + file.originalname);  // 给文件重命名
    }
});

// 初始化 multer 实例，并限制上传的单个文件大小（可选）
const upload = multer({ storage: storage, limits: { fileSize: 10 * 1024 * 1024 } });  // 限制文件大小为 10MB

// 创建 POST 路由，接收 multipart/form-data 格式的数据，upload.array('files', 10) 的 files 是参数名，10是一次最多上传10个文件
app.post('/test', upload.array('files', 10), (req, res) => {
    // req.file 包含上传的文件信息
    if (req.files && req.files.length > 0) {
        res.send(`上传文件成功 ${req.files.length} 个文件`);
    } else {
        res.send('没有文件上传');
    }
});

接口返回 void

import express from 'express';

const app = express();

app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

app.get('/test', (req, res) => {
    const { name, age } = req.query;
    console.log({ name }, { age });

    // 仅返回一个空响应，状态码为 200 (OK)
    res.status(200).end();  // 使用 .end() 来结束请求响应
});

统一处理异常

异常处理中间件必须放在所有路由和其他中间件之后，因为它捕捉的是在请求处理过程中出现的错误。

import express from 'express';

const app = express();

app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

app.get('/test', (req, res) => {
    throw new Error("test.error...");
});

app.post('/test2', (req, res) => {
    throw new Error("test2.error...");
});

// 错误处理中间件
app.use((err, req, res, next) => {
    console.error(err.stack);  // 打印错误的堆栈信息，帮助调试

    // 设置状态码并返回错误消息和错误的url
    res.status(500).send({ error: err.message, url: req.originalUrl });
});

跨域请求（CORS）

npm install cors
import express from 'express';
import cors from 'cors';

const app = express();

app.use(cors());  // 允许所有来源的跨域请求

app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

日志中间件

在控制台打印日志格式。选项如下：

  • combined：127.0.0.1 - - [10/Oct/2023:14:33:42 +0000] "GET / HTTP/1.1" 200 2326
  • common：127.0.0.1 - - [10/Oct/2023:14:33:42 +0000] "GET / HTTP/1.1" 200
  • dev：GET / 200 15ms
  • short：GET / 200 15ms
  • tiny：GET / 200 15ms
npm install morgan
import express from 'express';
import morgan from 'morgan';

const app = express();

app.use(morgan('combined'));  // 使用 "combined" 格式记录日志

app.listen(3000);

app.get('/test', (req, res) => {
    res.send("test");
});

Express 路由

服务器启动入口文件 和 接口文件分开

启动服务器文件 app.ts

// app.ts
import express from "express";
import router from './test';
// import router2 from './test2';    // 如果有多个就写多个

// 创建一个 Express 应用
const app = express();

// 挂载使用 router 中间件
app.use(router);
// app.use('/api', router);    // api 是接口前缀

// 监听端口
app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
});

接口文件

// test.ts
import express from "express";
const router = express.Router();    // 路由对象

// 测试接口
router.get('/', (req, res) => {
    res.send('index')
})

// 导出路由对象
export default router;

相关文章：

  • 【工具篇】探索 Notion AI：功能强大的智能写作助手
  • 掌握SQLAlchemy：Python数据库集成的艺术
  • OpenSSL实验
  • Unity面板介绍_Scene场景面板（23.1.1）
  • 银河麒麟系统安装mysql5.7【亲测可行】
  • Redis文档总结
  • 最新华为 HCIP-Datacom（H12-821）2025.2.20
  • VSCode集成deepseek使用介绍（Visual Studio Code）
  • cesium（vue）一些面试问题（包含Three.js）
  • 优选算法的灵动之章：双指针专题（一）
  • SpringBoot项目启动失败进程不结束问题
  • 【Linux】【网络】frp 如何准确将 客户端B 请求转发给 服务器A 的
  • 高性能内存对象缓存Memcached详细实验操作
  • 搭建Kubernetes (K8s) 集群----Centos系统
  • RK3588配置成为路由器
  • 京东广告基于 Apache Doris 的冷热数据分层实践
  • 如何清理cache-loader生成的缓存目录？
  • 命令执行漏洞 Command Execute
  • 数据结构——字符串匹配KMP
  • Linux（ubuntu） GPU CUDA 构建Docker镜像
  • wordpress自定义链接怎么配置/seo优化关键词排名
  • 网站做宣传域名什么好/中国企业500强
  • 新疆维吾尔族城乡建设厅网站/推广自己的网站
  • 招聘网站建设人员条件/怎样推广自己的产品
  • 苏州新海通网站建设/广州百度首页优化
  • 企业网站备案是什么意思/链接提交工具