如何让Express自定义Request接口的扩展属性为必填项？

方案一：全局扩展Express的Request接口（推荐） #

这是TypeScript官方推荐的扩展第三方库类型的方式，直接给Express原生的Request接口添加必填字段，不需要自定义新接口，所有地方都能直接使用。

1. 在项目根目录或src目录下创建types/express.d.ts文件：

import { Context } from '../classes/context.class';

declare module 'express' {
  interface Request {
    ctx: Context; // 直接设为必填字段
  }
}

2. 配置tsconfig.json，确保TypeScript能识别这个自定义类型文件：

{
  "compilerOptions": {
    "target": "ESNext",
    "module": "CommonJS",
    "typeRoots": ["./node_modules/@types", "./types"], // 包含自定义类型目录
    "esModuleInterop": true,
    "skipLibCheck": true,
    "strict": true
  },
  "include": ["./src/**/*", "./types/**/*"] // 包含src和types目录
}

3. 使用方式：

// 初始化ctx的中间件
app.use((req, res, next) => {
  req.ctx = new Context(); // TS会强制你赋值，否则报错，符合你的需求
  next();
});

// 后续中间件直接访问，无需断言
app.get('/', (req, res) => {
  console.log(req.ctx.someField); // 无类型错误
  res.send('Hello World');
});

方案二：自定义类型守卫函数 #

如果不想全局修改Express的类型，可以写一个类型守卫，一次校验后就能安全访问字段：

import { Request, Response, NextFunction } from 'express';
import { Context } from '../classes/context.class';

// 定义类型守卫，判断req是否包含必填的ctx
function hasCtx(req: Request): req is Request & { ctx: Context } {
  return typeof (req as any).ctx !== 'undefined' && req.ctx instanceof Context;
}

// 初始化中间件
app.use((req: Request, res: Response, next: NextFunction) => {
  (req as any).ctx = new Context();
  next();
});

// 业务中间件使用
app.get('/', (req, res) => {
  // 这里的判断只是给TS看，实际运行不会触发错误
  if (!hasCtx(req)) {
    throw new Error('Context未初始化');
  }
  // 此时TS知道req.ctx是存在的
  console.log(req.ctx.someField);
});

方案三：使用断言函数 #

通过断言函数强制告诉TSreq.ctx已存在，无需额外判断：

import { Request } from 'express';
import { Context } from '../classes/context.class';

// 断言函数：如果ctx不存在则抛出错误，否则TS会认为req包含必填的ctx
function assertCtx(req: Request): asserts req is Request & { ctx: Context } {
  if (!('ctx' in req) || !(req.ctx instanceof Context)) {
    throw new Error('Context未正确初始化');
  }
}

// 使用方式
app.get('/', (req, res) => {
  assertCtx(req);
  // 调用断言函数后，TS直接认可req.ctx存在
  console.log(req.ctx.someField);
});

总结 #

最推荐方案一，全局扩展类型既符合TypeScript的类型系统设计，又能避免重复的类型断言，开发体验最好。

内容的提问来源于stack exchange，提问作者Niteesh