Nodejs Nestjs国际化插件nestjs-i18n的使用

Nodejs Nestjs国际化插件nestjs-i18n的使用
nestjs-i18n 是一个在 NestJS 项目中实现国际化（i18n）功能的插件。以下是如何安装和配置 nestjs-i18n 的步骤：

安装

首先，你需要安装 nestjs-i18n 及其依赖项：

npm install @golevelup/nestjs-i18n i18n

配置

接下来，你需要在你的 NestJS 应用中配置 nestjs-i18n。

1. 创建配置文件：你可以在项目根目录下创建一个 i18n.config.ts 文件来配置 nestjs-i18n：

import { I18nConfig } from '@golevelup/nestjs-i18n';

export default <I18nConfig> {
  path: './src/i18n/__lng__/__ns__.json', // 路径模式
  fallbackLanguage: 'en', // 默认语言
};

1. 注册模块：在你的主模块（通常是 app.module.ts）中导入并配置 I18nModule：

import { Module } from '@nestjs/common';
import { I18nModule } from '@golevelup/nestjs-i18n';

@Module({
  imports: [
    I18nModule.forRoot({
      config: require('./i18n.config'),
    }),
  ],
})
export class AppModule {}

创建翻译文件

根据你在配置文件中设置的路径模式，你需要创建相应的翻译文件。例如，如果你的路径模式是 ./src/i18n/__lng__/__ns__.json，那么你应该创建如下文件结构：

src/
└── i18n/
    ├── en/
    │   └── common.json
    └── zh/
        └── common.json

每个 .json 文件的内容应该是一个 JSON 对象，包含键值对。例如：

// src/i18n/en/common.json
{
  "hello": "Hello",
  "welcome": "Welcome to our app!"
}

// src/i18n/zh/common.json
{
  "hello": "你好",
  "welcome": "欢迎来到我们的应用！"
}

使用

现在你可以在控制器或服务中注入 I18nService 来使用国际化功能：

import { Controller, Get } from '@nestjs/common';
import { I18nService } from '@golevelup/nestjs-i18n';

@Controller('example')
export class ExampleController {
  constructor(private readonly i18n: I18nService) {}

  @Get()
  getExample() {
    const hello = this.i18n.translate('common.hello');
    return { message: hello };
  }
}

这样，当你访问 /example 路由时，它会返回当前语言环境下的 "hello" 翻译。

设置语言

你还可以通过请求头或其他方式动态设置当前的语言环境。例如，在拦截器中设置：

import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
import { Observable } from 'rxjs';
import { I18nService } from '@golevelup/nestjs-i18n';

@Injectable()
export class LanguageInterceptor implements NestInterceptor {
  constructor(private readonly i18n: I18nService) {}

  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const req = context.switchToHttp().getRequest();
    const lang = req.headers['x-lang'] || 'en'; // 从请求头获取语言
    this.i18n.setLocale(lang);
    return next.handle();
  }
}

然后在模块中注册这个拦截器：

import { Module } from '@nestjs/common';
import { APP_INTERCEPTOR } from '@nestjs/core';
import { LanguageInterceptor } from './language.interceptor';

@Module({
  providers: [
    {
      provide: APP_INTERCEPTOR,
      useClass: LanguageInterceptor,
    },
  ],
})
export class AppModule {}

这样，你可以通过设置 x-lang 请求头来改变当前的语言环境。