Express 中 TypeScript 类型安全的中间件定义与使用指南

酷枫小哥_8213

酷枫小哥_8213

2026-06-25

714人浏览

原创

Express 中 TypeScript 类型安全的中间件定义与使用指南

本文详解 express + typescript 项目中自定义中间件(如 authmiddleware)类型不匹配的根本原因及正确解决方案,重点介绍如何通过全局声明合并(declaration merging)扩展 express.request 类型,确保路由注册时类型校验通过。

本文详解 express + typescript 项目中自定义中间件(如 authmiddleware)类型不匹配的根本原因及正确解决方案,重点介绍如何通过全局声明合并(declaration merging)扩展 express.request 类型,确保路由注册时类型校验通过。

在 Express 的 TypeScript 项目中,为 req 对象添加自定义属性(如 req.user)是常见需求,但若未正确声明类型,就会在路由注册处(如 router.get("/", authMiddleware, ...))触发编译错误——正如你遇到的 TS2769:Argument of type '...' is not assignable to parameter of type 'RequestHandler<...>'。该错误本质是 TypeScript 拒绝将扩展了 user 属性的 AuthRequest 类型传入期望标准 Express.Request 的中间件参数位置。

问题根源在于:Express 的类型定义(来自 @types/express)默认导出的 Request 接口是封闭的;你手动定义的 AuthRequest extends Request 是一个全新类型,而非对原有 Express.Request 的增强。而 Express 的 Router.use() / .get() 等方法签名明确要求参数为 RequestHandler,其 req 参数类型固定为 Express.Request —— 它不认识你自定义的 AuthRequest。

✅ 正确解法不是创建新接口,而是扩展 Express 原生的 Request 接口,利用 TypeScript 的模块声明合并(Declaration Merging)机制:

typescript-dev
typescript-dev

使用 Vite 8、React 19、Tailwind CSS v4、shadcn/ui、Biome、Vitest 和 Hono 构建全栈 TypeScript 应用,涵盖前端(Vite/Rolldown 构建 + 开发)...

下载
// 在全局可见的声明文件中(推荐:src/types/express.d.ts)
declare global {
  namespace Express {
    interface Request {
      user?: JwtPayload; // ✅ 直接向 Express.Request 添加字段
      // 可选:其他常用字段(如 email、password),按需添加
      email?: string;
      password?: string;
    }
  }
}

// 注意:此文件必须是 .d.ts 后缀,且不能有 import/export 语句(否则变为模块)
// 若已有其他导入,可加空 export 使其成为模块,但此时需在 tsconfig.json 中配置 types 或 reference
export {}; // 仅当需要作为模块时添加

⚠️ 关键注意事项:

  • 文件必须命名为 .d.ts(如 express.d.ts),并置于 src/types/ 或项目根目录下被 tsconfig.json 的 "typeRoots" 或 "types" 覆盖;
  • 不要在 .ts 文件中写 declare global(会导致模块污染或类型不可见);
  • CustomHeaders 类型需确保已正确定义(例如 interface CustomHeaders extends Headers { authorization?: string }),但更推荐直接使用 req.headers.authorization(Express 已声明 headers 为 Record);
  • auth.middleware.ts 中无需再定义 AuthRequest 接口,直接使用原生 Request 即可:
// auth.middleware.ts(简化后)
import { Request, Response, NextFunction } from "express";
import jwt, { JwtPayload, Secret } from "jsonwebtoken";
import "dotenv/config";

const secretKey: Secret = process.env.secretKey as Secret;

export default function authMiddleware(
  req: Request, // ✅ 使用原生 Request,其类型已通过 global 声明扩展
  res: Response,
  next: NextFunction
) {
  if (req.method === "OPTIONS") {
    return next();
  }

  try {
    const authHeader = req.headers.authorization;
    const token = authHeader?.split(" ")[1];

    if (!token) {
      return res.status(401).json({ message: "Unauthorized" });
    }

    const decoded = jwt.verify(token, secretKey) as JwtPayload;
    req.user = decoded; // ✅ 类型安全:user 已在 Express.Request 中声明

    next();
  } catch (error) {
    return res.status(400).json({ message: "Bad Request" });
  }
}

最后,在 auth.routes.ts 中保持原样即可通过类型检查:

import { Router } from "express";
import authMiddleware from "../middleware/auth.middleware"; // ✅ 类型 now matches
import authController from "../controllers/authController";

const router = Router();
router.get("/", authMiddleware, authController.auth); // ✅ 编译通过

export default router;

? 总结:TypeScript 下 Express 中间件类型错误,90% 源于错误地“继承” Request 而非“扩展”它。牢记原则:用 declare global 增强 Express 内置类型,而非新建类型替代它。这是 Express + TypeScript 生态中的标准实践,也是官方 @types/express 文档所推荐的方式。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

typescript

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4386

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1109

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4304

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1756

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3165

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4113

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2660

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

868

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Express 中文开发手册
Express 中文开发手册

共0课时 | 1人学习