NestJS Elasticsearch 项目教程

NestJS Elasticsearch 项目教程

1. 项目的目录结构及介绍

nestjs-elasticsearch/
├── src/
│   ├── app.module.ts
│   ├── main.ts
│   ├── elasticsearch.module.ts
│   ├── elasticsearch.service.ts
│   └── ...
├── test/
│   └── ...
├── .env
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

目录结构说明

• src/: 包含项目的源代码文件。
  • app.module.ts: 应用程序的主模块。
  • main.ts: 应用程序的入口文件。
  • elasticsearch.module.ts: Elasticsearch 模块的定义。
  • elasticsearch.service.ts: Elasticsearch 服务的实现。
  • ...: 其他辅助文件和模块。
• test/: 包含项目的测试文件。
• .env: 环境变量配置文件。
• .gitignore: Git 忽略文件配置。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 编译配置。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

main.ts

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

文件说明

• NestFactory.create(AppModule): 创建 NestJS 应用程序实例。
• app.listen(3000): 启动应用程序并监听 3000 端口。

3. 项目的配置文件介绍

.env

ELASTICSEARCH_NODE=http://localhost:9200
ELASTICSEARCH_USERNAME=elastic
ELASTICSEARCH_PASSWORD=changeme

文件说明

• ELASTICSEARCH_NODE: Elasticsearch 节点地址。
• ELASTICSEARCH_USERNAME: Elasticsearch 用户名。
• ELASTICSEARCH_PASSWORD: Elasticsearch 密码。

elasticsearch.module.ts

import { Module } from '@nestjs/common';
import { ElasticsearchModule } from '@nestjs/elasticsearch';
import { ConfigModule, ConfigService } from '@nestjs/config';

@Module({
  imports: [
    ConfigModule.forRoot(),
    ElasticsearchModule.registerAsync({
      imports: [ConfigModule],
      useFactory: async (configService: ConfigService) => ({
        node: configService.get('ELASTICSEARCH_NODE'),
        auth: {
          username: configService.get('ELASTICSEARCH_USERNAME'),
          password: configService.get('ELASTICSEARCH_PASSWORD'),
        },
      }),
      inject: [ConfigService],
    }),
  ],
  exports: [ElasticsearchModule],
})
export class ElasticsearchConfigModule {}

文件说明

• ConfigModule.forRoot(): 加载环境变量配置。
• ElasticsearchModule.registerAsync(): 异步注册 Elasticsearch 模块，并从配置服务中获取 Elasticsearch 连接参数。

以上是 NestJS Elasticsearch 项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用该项目。