如何在NestJS模块中通过Passport JS访问.env文件？

问题场景 #

我正在用NestJS和Passport开发小型API，想在Auth模块里访问.env文件的内容，却卡壳了。

我的代码：

import { userService } from 'src/user/services/user.service';
import { AuthService } from './auth.service';
import { PassportModule } from '@nestjs/passport';
import { LocalStrategy } from './local.strategy';
import { JwtModule } from '@nestjs/jwt';
import { JwtStrategy } from './jwt.strategy';
import { ConfigService } from '@nestjs/config';

@Module({
  providers: [AuthService, userService, LocalStrategy, JwtStrategy],
  imports: [
    TypeOrmModule.forFeature([UserEntity, SpotEntity, SpotUserEntity]),
    UserModule,
    PassportModule,
    JwtModule.register({
      secret: ConfigService.get('JWT_SECRET'),
      signOptions: { expiresIn: '600s' },
    }),
  ],
  exports: [AuthService],
})
export class AuthModule {}

这段代码跑不起来，因为直接调用了ConfigService.get()，而模块没有构造函数没法实例化ConfigService，不知道该怎么处理。

解决步骤 #

核心问题是JwtModule.register()是同步方法，没法注入ConfigService。改用NestJS提供的异步注册方式JwtModule.registerAsync()就能解决。

1. 修改Auth模块里的JwtModule注册 #

把JwtModule.register()替换成JwtModule.registerAsync()，配置工厂函数来获取ConfigService实例：

import { userService } from 'src/user/services/user.service';
import { AuthService } from './auth.service';
import { PassportModule } from '@nestjs/passport';
import { LocalStrategy } from './local.strategy';
import { JwtModule } from '@nestjs/jwt';
import { JwtStrategy } from './jwt.strategy';
import { ConfigService } from '@nestjs/config';
// 如果ConfigModule不是全局的，要在这里导入
import { ConfigModule } from '@nestjs/config';

@Module({
  providers: [AuthService, userService, LocalStrategy, JwtStrategy],
  imports: [
    TypeOrmModule.forFeature([UserEntity, SpotEntity, SpotUserEntity]),
    UserModule,
    PassportModule,
    JwtModule.registerAsync({
      // 如果ConfigModule是全局的，可以删掉这行
      imports: [ConfigModule],
      // 工厂函数注入ConfigService，返回JWT配置
      useFactory: (configService: ConfigService) => ({
        secret: configService.get<string>('JWT_SECRET'),
        signOptions: { expiresIn: '600s' },
      }),
      // 指定要注入的依赖
      inject: [ConfigService],
    }),
  ],
  exports: [AuthService],
})
export class AuthModule {}

2. 确保根模块配置了ConfigModule #

如果你的AppModule还没导入ConfigModule，得先配置它，让整个应用能读取.env文件：

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { AuthModule } from './auth/auth.module';

@Module({
  imports: [
    // 全局导入ConfigModule，读取.env文件
    ConfigModule.forRoot({
      isGlobal: true, // 设为全局后，其他模块不用重复导入
    }),
    AuthModule,
  ],
})
export class AppModule {}

关键说明 #

• registerAsync()支持异步加载配置，允许依赖注入
• useFactory是工厂函数，接收注入的ConfigService实例，返回JWT的配置参数
• inject数组指定要传入工厂函数的依赖，这里就是ConfigService
• 若ConfigModule已设为全局，JwtModule.registerAsync()里的imports: [ConfigModule]可以省略

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