TypeScript中JWT认证中间件RequestHandlerParams类型不兼容错误求助

问题 #

在TypeScript中编写JWT认证中间件时，将auth函数作为Express路由中间件使用出现类型错误，提示参数类型无法赋值给RequestHandlerParams，具体为Request类型缺少IGetUserAuthInfoRequest接口要求的user属性。

中间件代码 #

export interface IGetUserAuthInfoRequest extends Request {
  user: any;
}

const tokenDecode = (req: Request) => {
  try {
    const bearerHeader = req.headers["authorization"];
    if (bearerHeader) {
      const token = bearerHeader.split(" ")[1];
      return jsonwebtoken.verify(token, process.env.TOKEN_SECRET) as JwtPayload;
    }
    return false;
  } catch {
    return false;
  }
};

const auth = async (
  req: IGetUserAuthInfoRequest,
  res: Response,
  next: NextFunction
): Promise<any> => {
  const tokenDecoded = tokenDecode(req);
  if (!tokenDecoded) return responseHandler.unauthorized(res);
  const user = await userModel.findById(tokenDecoded.data);
  if (!user) return responseHandler.unauthorized(res);

  req.user = user;
  next();
};

路由代码 #

const router = express.Router({ mergeParams: true });

router.get("/", tokenMiddleware.auth, reviewController.getReviewsOfUser);

错误信息 #

No overload matches this call.
  The last overload gave the following error.
    Argument of type '(req: IGetUserAuthInfoRequest, res: Response, next: NextFunction) => Promise<any>' is not assignable to parameter of type 'RequestHandlerParams<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
      Type '(req: IGetUserAuthInfoRequest, res: Response, next: NextFunction) => Promise<any>' is not assignable to type 'RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
        Types of parameters 'req' and 'req' are incompatible.
          Property 'user' is missing in type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>' but required in type 'IGetUserAuthInfoRequest'.

解决方案 #

方法1：将user属性设为可选 #

修改自定义接口，把user定义为可选属性，适配Express默认Request类型的结构：

export interface IGetUserAuthInfoRequest extends Request {
  user?: any; // 添加问号标记为可选属性
}

中间件执行前req.user本就不存在，设为可选更符合实际流程，直接解决类型不兼容问题。

方法2：使用类型断言转换请求对象 #

在中间件内部对请求对象做类型转换，参数仍使用Express默认的Request类型：

const auth = async (
  req: Request, // 参数用默认Request类型
  res: Response,
  next: NextFunction
): Promise<any> => {
  const tokenDecoded = tokenDecode(req);
  if (!tokenDecoded) return responseHandler.unauthorized(res);
  const user = await userModel.findById(tokenDecoded.data);
  if (!user) return responseHandler.unauthorized(res);

  // 断言为自定义接口后赋值user
  (req as IGetUserAuthInfoRequest).user = user;
  next();
};

这种方式既保留了参数类型的兼容性，又能在需要时扩展请求对象属性。

方法3：全局扩展Express的Request类型（推荐） #

直接扩展Express的全局Request类型，让所有路由的请求对象自动包含user属性，同时替换any为具体类型提升安全性：

1. 在项目中创建类型声明文件，比如types/express/index.d.ts：

// 替换成你实际的User模型类型
import { User } from '../../models/user';

declare global {
  namespace Express {
    interface Request {
      user?: User;
    }
  }
}

2. 在tsconfig.json中配置类型文件路径，确保TypeScript能识别：

{
  "compilerOptions": {
    "typeRoots": ["./node_modules/@types", "./types"]
  }
}

3. 修改中间件参数为默认Request类型：

const auth = async (
  req: Request,
  res: Response,
  next: NextFunction
): Promise<any> => {
  // 原有逻辑不变
  req.user = user; // 此时不会报错，Request类型已全局扩展
  next();
};

这种方式最优雅，能统一管理请求对象的扩展属性，避免重复声明自定义接口。

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