在Express中设置路由前缀 如何适配现有自定义RouteConfig结构

方案1：入口统一配置全局路由前缀（适配现有结构，改造成本极低） #

你的结构可以直接通过修改RouteConfig基类实现全局前缀统一管理，不需要调整每个业务模块的核心逻辑：

1. 调整基类RouteConfig构造逻辑，自动拼接全局前缀和模块前缀，同时处理斜杠重复问题：

export class RouteConfig {
  protected app: Application;
  protected fullModulePrefix: string;

  constructor(
    app: Application, 
    modulePrefix: string, 
    // 全局前缀默认取环境变量，也支持入口传入自定义值
    globalPrefix: string = process.env.PREFIX || ''
  ) {
    this.app = app;
    // 自动拼接前缀，替换多余斜杠避免路径错误
    this.fullModulePrefix = `${globalPrefix}${modulePrefix}`.replace(/\/+/g, '/');
  }

  // 原getName方法直接返回拼接好的完整前缀
  getName() {
    return this.fullModulePrefix;
  }

  abstract configureRoutes(): Application;
}

2. 业务模块（以Role模块为例）删除重复的process.env.PREFIX拼接逻辑即可：

export class RoleRoutes extends RouteConfig {
  constructor(app: Application) {
    super(app, "/role"); // 原有代码不用修改
  }

  configureRoutes() {
    this.app.route(this.getName() + '/:id').get([JWT.authenticateJWT, RoleController.getOne.bind(RoleController)]);
    this.app.route(this.getName()).get([JWT.authenticateJWT, RoleController.getAll.bind(RoleController)]);
    this.app.route(this.getName()).post([JWT.authenticateJWT, RoleController.create.bind(RoleController)]);
    this.app.route(this.getName()).put([JWT.authenticateJWT, RoleController.update.bind(RoleController)]);
    return this.app;
  }
}

3. 入口文件统一配置全局前缀，所有模块自动生效：

// 自定义全局前缀，优先级高于环境变量
const GLOBAL_API_PREFIX = '/api/v1';
const routes: Array<RouteConfig> = [];
// 所有模块实例化时传入统一前缀即可
routes.push(new RoleRoutes(app, GLOBAL_API_PREFIX));
routes.push(new UserRoutes(app, GLOBAL_API_PREFIX));
// 后续新增模块不需要单独处理前缀，统一走入口配置

方案2：支持单个模块单独自定义前缀 #

如果有特殊模块不需要使用全局前缀，或者要单独指定前缀，只要扩展基类参数即可：

1. 扩展RouteConfig构造参数，支持自定义模块前缀覆盖全局规则：

export class RouteConfig {
  protected app: Application;
  protected fullModulePrefix: string;

  constructor(
    app: Application, 
    modulePrefix: string, 
    globalPrefix: string = process.env.PREFIX || '',
    // 新增自定义模块前缀参数，传值则忽略全局前缀
    customModulePrefix?: string
  ) {
    this.app = app;
    if (customModulePrefix) {
      this.fullModulePrefix = customModulePrefix.replace(/\/+/g, '/');
    } else {
      this.fullModulePrefix = `${globalPrefix}${modulePrefix}`.replace(/\/+/g, '/');
    }
  }
  // 其余逻辑不变
}

2. 入口文件给特殊模块传自定义前缀即可：

const GLOBAL_API_PREFIX = '/api/v1';
const routes: Array<RouteConfig> = [];
// 普通模块走全局前缀
routes.push(new RoleRoutes(app, GLOBAL_API_PREFIX));
// 特殊公共模块单独指定前缀，不使用全局规则
routes.push(new PublicRoutes(app, '/public', GLOBAL_API_PREFIX, '/open/api/v2/public'));

改造优势 #

• 完全兼容现有代码结构，业务模块除了删除重复的前缀拼接代码外不需要做其他调整
• 全局前缀统一管理，后续升级接口版本只要修改入口一个配置
• 灵活度高，同时满足全局统一规则和特殊模块自定义需求

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