如何在NestJS中创建含公共参数前缀的嵌套路由

我来给你梳理下NestJS里实现这个需求的最佳实践，两种主流方式都能完美解决你的问题，根据项目复杂度选就行：

方式一：用RouterModule构建路由树（官方推荐，适合复杂结构） #

这是NestJS官方推崇的方案，能帮你把路由结构梳理得清清楚楚，父路由的参数会自动被子路由继承，不用在每个控制器里重复写前缀。

步骤： #

1. 在根模块AppModule里导入RouterModule，配置路由树，把/accounts/:account作为父节点，挂载各个资源模块作为子节点：

import { Module } from '@nestjs/common';
import { RouterModule } from '@nestjs/core';
import { AccountsModule } from './accounts/accounts.module';
import { Resource1Module } from './accounts/resource1/resource1.module';
import { Resource2Module } from './accounts/resource2/resource2.module';
// 导入其他资源模块

@Module({
  imports: [
    RouterModule.register([
      {
        path: 'accounts/:account',
        module: AccountsModule, // 父模块可以是一个空模块，用来共享服务/守卫
        children: [
          { path: 'resource1', module: Resource1Module },
          { path: 'resource2', module: Resource2Module },
          { path: 'resource3', module: Resource3Module },
          { path: 'resource4/subResource', module: Resource4SubModule },
        ],
      },
    ]),
    AccountsModule,
    Resource1Module,
    Resource2Module,
    // 注册其他资源模块
  ],
})
export class AppModule {}

2. 各个资源控制器不需要加全局前缀，只需要写相对路径就行，比如Resource1Controller：

import { Controller, Get, Param } from '@nestjs/common';

@Controller() // 这里不用加前缀，RouterModule已经帮你拼好了
export class Resource1Controller {
  @Get(':someParam')
  getResource(
    @Param('account') accountId: string, // 直接就能拿到父路由的account参数
    @Param('someParam') resourceId: string
  ) {
    return {
      account: accountId,
      resource: resourceId
    };
  }
}

这样一来，你的接口路径就完全符合需求，而且所有子路由都能直接获取account参数。

方式二：控制器前缀+自定义装饰器（适合小型项目） #

如果你的项目结构比较简单，不想额外配置RouterModule，可以用这种方式，把公共前缀抽成常量，再用自定义装饰器简化参数获取。

步骤： #

1. 定义公共前缀常量，避免重复书写：

// accounts.constants.ts
export const ACCOUNT_BASE_ROUTE = 'accounts/:account';

2. 每个资源控制器使用这个常量拼接路由：

import { Controller, Get, Param } from '@nestjs/common';
import { ACCOUNT_BASE_ROUTE } from '../accounts.constants';

@Controller(`${ACCOUNT_BASE_ROUTE}/resource1`)
export class Resource1Controller {
  @Get(':someParam')
  getResource(
    @Param('account') accountId: string,
    @Param('someParam') resourceId: string
  ) {
    return { accountId, resourceId };
  }
}

3. （可选）创建自定义装饰器简化account参数获取：

// get-account.decorator.ts
import { createParamDecorator, ExecutionContext } from '@nestjs/common';

export const GetAccount = createParamDecorator(
  (_: unknown, ctx: ExecutionContext) => {
    const request = ctx.switchToHttp().getRequest();
    return request.params.account;
  },
);

之后在控制器里就能这样用，代码更简洁：

@Get(':someParam')
getResource(
  @GetAccount() accountId: string,
  @Param('someParam') resourceId: string
) {
  return { accountId, resourceId };
}

额外优化：统一验证Account参数 #

如果需要对account参数做统一校验（比如检查账号是否存在），可以写一个守卫或者中间件，挂载到父模块上，所有子路由都会自动生效：

比如创建一个AccountGuard：

// account.guard.ts
import { Injectable, CanActivate, ExecutionContext, NotFoundException } from '@nestjs/common';
import { AccountService } from './account.service';

@Injectable()
export class AccountGuard implements CanActivate {
  constructor(private readonly accountService: AccountService) {}

  async canActivate(ctx: ExecutionContext): Promise<boolean> {
    const request = ctx.switchToHttp().getRequest();
    const accountId = request.params.account;
    
    const account = await this.accountService.findById(accountId);
    if (!account) {
      throw new NotFoundException(`Account ${accountId} not found`);
    }
    
    // 把账号对象挂载到request上，后续控制器直接用
    request.account = account;
    return true;
  }
}

然后在AccountsModule里注册为全局守卫：

@Module({
  providers: [
    AccountService,
    {
      provide: 'APP_GUARD',
      useClass: AccountGuard,
    },
  ],
})
export class AccountsModule {}

这样所有/accounts/:account下的路由都会自动校验账号合法性，控制器里还能直接通过request.account拿到完整账号信息。

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