如何扩展Auth0的Express中间件？添加自定义用户数据库属性

你的核心问题是Auth0认证中间件是异步回调式的，直接调用后无法立即拿到结果，必须在它的回调阶段执行后续的数据库查询和属性添加操作。下面给出两种可行的实现方案：

方案1：链式中间件（推荐） #

先执行原Auth0认证中间件，认证通过后再追加自定义数据查询逻辑：

import { Request, Response, NextFunction } from 'express';
import { auth } from 'express-openid-connect';

// 原Auth0认证中间件
export const checkJwt = auth({
  audience: process.env.AUTH0_AUDIENCE,
  issuerBaseURL: process.env.AUTH0_ISSUERBASEURL,
});

// 扩展后的中间件
export const checkJwtWithCustomData = async (req: Request, res: Response, next: NextFunction) => {
  // 先完成Auth0认证，将回调转为Promise处理异步
  await new Promise<void>((resolve, reject) => {
    checkJwt(req, res, (err) => {
      if (err) return reject(err);
      resolve();
    });
  });

  // 认证通过后，从自定义数据库获取用户额外信息
  try {
    const auth0UserId = req.auth?.sub;
    if (!auth0UserId) {
      return res.status(401).send('Unauthorized: 用户标识缺失');
    }

    // 替换为你的数据库查询逻辑（示例用SQL查询）
    const userExtraInfo = await yourDbClient.query(
      'SELECT user_id, organization FROM custom_users WHERE auth0_sub = ?',
      [auth0UserId]
    );

    // 将自定义属性添加到req.auth或单独的req.user对象中
    if (userExtraInfo.rows.length > 0) {
      req.auth = {
        ...req.auth,
        customUserId: userExtraInfo.rows[0].user_id,
        organization: userExtraInfo.rows[0].organization
      };
      // 或者单独存到req.user避免修改原auth对象：
      // req.user = { ...req.auth, ...userExtraInfo.rows[0] };
    }

    next();
  } catch (dbError) {
    next(dbError); // 将数据库错误传给Express错误处理中间件
  }
};

方案2：包装Auth0中间件 #

直接封装Auth0的auth函数，在其内部回调中处理后续逻辑：

import { Request, Response, NextFunction } from 'express';
import { auth } from 'express-openid-connect';

export const checkJwtWithCustomData = (req: Request, res: Response, next: NextFunction) => {
  const authOpts = {
    audience: process.env.AUTH0_AUDIENCE,
    issuerBaseURL: process.env.AUTH0_ISSUERBASEURL,
  };

  // 调用Auth0中间件，在它的完成回调中执行自定义逻辑
  auth(authOpts)(req, res, async (err) => {
    if (err) return next(err); // 认证失败直接传递错误

    try {
      const auth0UserId = req.auth?.sub;
      if (!auth0UserId) {
        return res.status(401).send('Unauthorized: 用户标识缺失');
      }

      const userExtraInfo = await yourDbClient.query(
        'SELECT user_id, organization FROM custom_users WHERE auth0_sub = ?',
        [auth0UserId]
      );

      if (userExtraInfo.rows.length > 0) {
        req.auth = {
          ...req.auth,
          customUserId: userExtraInfo.rows[0].user_id,
          organization: userExtraInfo.rows[0].organization
        };
      }

      next();
    } catch (dbError) {
      next(dbError);
    }
  });
};

关键注意事项 #

• 异步处理：必须等待Auth0认证完成（回调触发）后再执行数据库查询，中间件的异步逻辑要正确用async/await或Promise处理
• 错误处理：认证错误、数据库查询错误都要传递给Express的错误处理中间件，避免请求挂起
• 数据存储选择：如果不想修改原req.auth对象，可以新增req.user存储合并后的完整用户信息
• 性能优化：高频请求场景下，可以用Redis缓存用户的自定义信息，以Auth0的sub字段为key，减少数据库查询次数

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