feat: config module

QuarkGluonPlasma · QuarkGluonPlasma · commit b2f63e565663 · 2023-06-17T12:48:07.000+08:00
diff --git a/README.md b/README.md
@@ -58,5 +58,11 @@
 
 [jwt、session](./jwt-and-session)
 
+[Node 里读取 env、yaml 配置文件](./config-test)
+
+[Nest 的 Config 模块读取配置文件](./nest-config-test)
+
 [typeorm + jwt + ValidationPipe 实现登录注册](./login-and-register)
 
+
+
diff --git a/config-test/.env b/config-test/.env
@@ -0,0 +1,2 @@
+aaa=1
+bbb=2
diff --git a/config-test/.production.env b/config-test/.production.env
@@ -0,0 +1,2 @@
+aaa=111
+bbb=222
diff --git a/config-test/README.md b/config-test/README.md
@@ -0,0 +1,6 @@
+npm install
+
+node ./index.js
+
+node ./index2.js
+
diff --git a/config-test/hello.yaml b/config-test/hello.yaml
@@ -0,0 +1,10 @@
+application:
+  host: 'localhost'
+  port: 8080
+
+db:
+   mysql:
+    url: 'localhost'
+    port: 3306
+    database: 'aaa'
+    password: 'guang'
diff --git a/config-test/index.js b/config-test/index.js
@@ -0,0 +1,6 @@
+require('dotenv').config({
+    path: process.env.NODE_ENVIRONMENT === 'production' ? '.production.env' : '.env',
+})
+
+console.log('aaa', process.env.aaa);
+console.log('bbb', process.env.bbb)
diff --git a/config-test/index2.js b/config-test/index2.js
@@ -0,0 +1,6 @@
+const yaml = require('js-yaml');
+const fs = require('fs');
+
+const config = fs.readFileSync('./hello.yaml');
+
+console.log(yaml.load(config));
diff --git a/config-test/package.json b/config-test/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "config-test",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "dotenv": "^16.3.0",
+    "js-yaml": "^4.1.0"
+  }
+}
diff --git a/nest-config-test/.aaa.env b/nest-config-test/.aaa.env
@@ -0,0 +1 @@
+aaa=3
diff --git a/nest-config-test/.env b/nest-config-test/.env
@@ -0,0 +1,2 @@
+aaa=1
+bbb=2
diff --git a/nest-config-test/.eslintrc.js b/nest-config-test/.eslintrc.js
@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};
diff --git a/nest-config-test/.gitignore b/nest-config-test/.gitignore
@@ -0,0 +1,35 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
diff --git a/nest-config-test/.prettierrc b/nest-config-test/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}
diff --git a/nest-config-test/README.md b/nest-config-test/README.md
@@ -0,0 +1,5 @@
+# 配置
+
+npm install
+
+npm run start:dev
diff --git a/nest-config-test/aaa.yaml b/nest-config-test/aaa.yaml
@@ -0,0 +1,8 @@
+application:
+  host: 'localhost'
+  port: 8080
+
+aaa:
+   bbb:
+    ccc: 'ccc'
+    port: 3306
diff --git a/nest-config-test/nest-cli.json b/nest-config-test/nest-cli.json
@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}
diff --git a/nest-config-test/package.json b/nest-config-test/package.json
@@ -0,0 +1,71 @@
+{
+  "name": "nest-config-test",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json"
+  },
+  "dependencies": {
+    "@nestjs/common": "^9.0.0",
+    "@nestjs/config": "^3.0.0",
+    "@nestjs/core": "^9.0.0",
+    "@nestjs/mapped-types": "*",
+    "@nestjs/platform-express": "^9.0.0",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.2.0"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^9.0.0",
+    "@nestjs/schematics": "^9.0.0",
+    "@nestjs/testing": "^9.0.0",
+    "@types/express": "^4.17.13",
+    "@types/jest": "29.5.0",
+    "@types/node": "18.15.11",
+    "@types/supertest": "^2.0.11",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "eslint": "^8.0.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "29.5.0",
+    "prettier": "^2.3.2",
+    "source-map-support": "^0.5.20",
+    "supertest": "^6.1.3",
+    "ts-jest": "29.0.5",
+    "ts-loader": "^9.2.3",
+    "ts-node": "^10.0.0",
+    "tsconfig-paths": "4.2.0",
+    "typescript": "^4.7.4"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}
diff --git a/nest-config-test/src/app.controller.spec.ts b/nest-config-test/src/app.controller.spec.ts
@@ -0,0 +1,22 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+describe('AppController', () => {
+  let appController: AppController;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+
+    appController = app.get<AppController>(AppController);
+  });
+
+  describe('root', () => {
+    it('should return "Hello World!"', () => {
+      expect(appController.getHello()).toBe('Hello World!');
+    });
+  });
+});
diff --git a/nest-config-test/src/app.controller.ts b/nest-config-test/src/app.controller.ts
@@ -0,0 +1,21 @@
+import { Controller, Get, Inject } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Inject(ConfigService)
+  private configService: ConfigService;
+
+  @Get()
+  getHello() {
+    return {
+      // aaa: this.configService.get('aaa'),
+      // bbb: this.configService.get('bbb'),
+      // db: this.configService.get('db')
+      config: this.configService.get('aaa.bbb.ccc')
+    }
+  }
+}
diff --git a/nest-config-test/src/app.module.ts b/nest-config-test/src/app.module.ts
@@ -0,0 +1,22 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { BbbModule } from './bbb/bbb.module';
+import * as path from 'path';
+import config from './config';
+import config2 from './config2';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      // envFilePath: [path.join(process.cwd(), '.aaa.env'), path.join(process.cwd(), '.env')]
+      load: [config2, config]
+    }),
+    BbbModule
+  ],
+  controllers: [AppController],
+  providers: [AppService],
+})
+export class AppModule {}
diff --git a/nest-config-test/src/app.service.ts b/nest-config-test/src/app.service.ts
@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  getHello(): string {
+    return 'Hello World!';
+  }
+}
diff --git a/nest-config-test/src/bbb/bbb.controller.ts b/nest-config-test/src/bbb/bbb.controller.ts
@@ -0,0 +1,41 @@
+import { Controller, Get, Post, Body, Patch, Param, Delete, Inject } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { BbbService } from './bbb.service';
+import { CreateBbbDto } from './dto/create-bbb.dto';
+import { UpdateBbbDto } from './dto/update-bbb.dto';
+
+@Controller('bbb')
+export class BbbController {
+  constructor(private readonly bbbService: BbbService) {}
+
+  @Inject(ConfigService)
+  private configService: ConfigService;
+
+  @Post()
+  create(@Body() createBbbDto: CreateBbbDto) {
+    return this.bbbService.create(createBbbDto);
+  }
+
+  @Get()
+  findAll() {
+    return {
+      ccc: this.configService.get('aaa.bbb.ccc'),
+      ddd: this.configService.get('ddd')
+    }
+  }
+
+  @Get(':id')
+  findOne(@Param('id') id: string) {
+    return this.bbbService.findOne(+id);
+  }
+
+  @Patch(':id')
+  update(@Param('id') id: string, @Body() updateBbbDto: UpdateBbbDto) {
+    return this.bbbService.update(+id, updateBbbDto);
+  }
+
+  @Delete(':id')
+  remove(@Param('id') id: string) {
+    return this.bbbService.remove(+id);
+  }
+}
diff --git a/nest-config-test/src/bbb/bbb.module.ts b/nest-config-test/src/bbb/bbb.module.ts
@@ -0,0 +1,17 @@
+import { Module } from '@nestjs/common';
+import { BbbService } from './bbb.service';
+import { BbbController } from './bbb.controller';
+import { ConfigModule } from '@nestjs/config';
+
+@Module({
+  imports: [
+    ConfigModule.forFeature(() => {
+      return {
+        ddd: 222
+      }
+    })
+  ],
+  controllers: [BbbController],
+  providers: [BbbService]
+})
+export class BbbModule {}
diff --git a/nest-config-test/src/bbb/bbb.service.ts b/nest-config-test/src/bbb/bbb.service.ts
diff --git a/nest-config-test/src/bbb/dto/create-bbb.dto.ts b/nest-config-test/src/bbb/dto/create-bbb.dto.ts
diff --git a/nest-config-test/src/bbb/dto/update-bbb.dto.ts b/nest-config-test/src/bbb/dto/update-bbb.dto.ts
diff --git a/nest-config-test/src/bbb/entities/bbb.entity.ts b/nest-config-test/src/bbb/entities/bbb.entity.ts
diff --git a/nest-config-test/src/config.ts b/nest-config-test/src/config.ts
diff --git a/nest-config-test/src/config2.ts b/nest-config-test/src/config2.ts
diff --git a/nest-config-test/src/main.ts b/nest-config-test/src/main.ts
diff --git a/nest-config-test/test/app.e2e-spec.ts b/nest-config-test/test/app.e2e-spec.ts
diff --git a/nest-config-test/test/jest-e2e.json b/nest-config-test/test/jest-e2e.json
diff --git a/nest-config-test/tsconfig.build.json b/nest-config-test/tsconfig.build.json
diff --git a/nest-config-test/tsconfig.json b/nest-config-test/tsconfig.json
