如何在 ServeStaticModule 中定义路径前缀？

Question

我想根据这个文档https://docs.nestjs.com/recipes/serve-static#serve-static 提供一些静态目录结构，但可以找到这些简单问题的答案：

1. 如何设置像'/some/path/to/files'这样的路径前缀？
2. 如何设置运行时服务（文件路径是动态的，不能硬编码）？

提前致谢。

附：我看到了一些关于 app.useStaticAssets() 的答案，但据我所知，这是 Express 特定的解决方案，无论如何都不会用最新版本编译 (Property 'useStaticAssets' does not exist on type 'INestApplication')...

更新

例如，我有这些目录：

1. /var/lib/app/data1
2. /var/lib/app/data2
3. /home/user/some/path

我希望它被用作：

1. http://localhost:3000/path1
2. http://localhost:3000/path333
3. http://localhost:3000/my/funny/cats

Answer 1

这是一个老问题，但我遇到了同样的问题。

这是我的，所以在@Jay 的回答的帮助下，它提供了github 上所有可用选项的链接，当使用 NestJS ServeStaticModule 时，我能够找到正确的选项，即serveRoot .

这是我使用它的用例：

ServeStaticModule.forRoot({rootPath: '/media/avatar', serveRoot: '/avatar'})

上面的这一行是在你的 app.module 中引入的，基本上我是说位于/media/avatar 的文件应该在localhost:1234/avatar 上提供。

Answer 2

你问

这如何帮助我为来自不同路径的许多不同文件夹提供服务，其中一些应该在运行时确定？

您可以有多个 ServeRoot 声明，如下所示：

ServeStaticModule.forRoot({
  serveRoot: '/path1',
  rootPath: `/var/lib/app/data1`,
}),
ServeStaticModule.forRoot({
  serveRoot: '/path333',
  rootPath: `/var/lib/app/data2`,
}),
ServeStaticModule.forRoot({
  serveRoot: '/my/funny/cats',
  rootPath: `/home/user/some/path`,
}),

至于“在运行时确定”，也许ServeStaticModule 不能做到这一点。其他人应该请纠正我。

Answer 3

您可以在ServeStaticModule 上设置renderPath 选项。通常路径是'*'，因此任何与您定义的其他路由不匹配的东西都会尝试通过res.sendFile() 发送。如果你想让它成为some/path/to/file，你可以设置renderPath: 'some/path/to/files/*，它应该会成功。

Answer 4

如果有人想从配置服务中获取静态文件根路径，那么我们可以这样做

ServeStaticModule.forRootAsync({
     imports: [ConfigModule],
     inject: [ConfigService],
     useFactory: (configService: ConfigService) => [
     {
       rootPath: configService.get<string>('rootPath'),
     },
   ],
})

Answer 5

rootPath 确定静态内容所在的根：

@Module({
    imports: [
        ServeStaticModule.forRoot({
            rootPath: join(__dirname, '..', 'static'),
        }),
    ],
})

在这种情况下，根目录是 static 文件夹。

例如，您可以具有以下结构：

static
    page
      png
        sky.png
      index.html

为了获得 sky.png，请求将是：http://localhost:3000/page/png/sky.png

为了获取 index.html，请求将是：http://localhost:3001/page/index.html

此外，这里是ServeStaticModuleOptions 的文档： https://github.com/nestjs/serve-static/blob/master/lib/interfaces/serve-static-options.interface.ts

我会将您的注意力指向renderPath。我没有发现renderPath 的文档非常清楚，但在此错误报告中，预期的行为是renderPath 按照您的需要重新映射到 URL 的本地路径：https://github.com/nestjs/serve-static/issues/26

您还可以查看 Express/Fastify 以了解如何处理该选项，因为这些是在封面下使用的服务器。