使用nest搭建BFF项目

1. 全局安装 nestjs/cli#

1
npm install -g @nestjs/cli

2. 创建 nestjs 项目#

1
nest new bff-project

通过 pnpm start 启动项目，此时在浏览器中直接输入 http://localhost:3000/ 会出现 Hello world

修改 nest-cli.json，添加 generateOptions，设置 spec 为 false，这样生成代码的时候不会生成测试代码，和 nest g xxx —no-spec 效果一样

1
{
2
  "$schema": "https://json.schemastore.org/nest-cli",
3
  "collection": "@nestjs/schematics",
4
  "generateOptions": {
5
    "spec": false
6
  },
7
  "sourceRoot": "src",
8
  "compilerOptions": {
9
    "deleteOutDir": true
10
  }
11
}

3. 安装 TypeORM 相关包#

1
pnpm install --save @nestjs/typeorm typeorm mysql2

在 AppModule 引入 TypeOrmModule：

1
import { Module } from '@nestjs/common'
2
import { TypeOrmModule } from '@nestjs/typeorm'
3
import { AppController } from './app.controller'
4
import { AppService } from './app.service'
5
import { UserCountModule } from './user-count/user-count.module'
6

7
@Module({
8
  imports: [
9
    TypeOrmModule.forRoot({
10
      type: 'mysql',
11
      host: '114.116.234.221',
12
      port: 3309,
13
      username: 'test_server_see',
14
      password: 'xxx',
15
      database: 'passport',
16
      synchronize: true,
17
      logging: true,
18
      entities: [],
19
      poolSize: 10,
20
      connectorPackage: 'mysql2',
21
      extra: {
22
        authPlugin: 'sha256_password',
23
      },
24
    }),
25
    UserCountModule,
26
  ],
27
  controllers: [AppController],
28
  providers: [AppService],
29
})
30
export class AppModule {}

4. 创建数据库表的 entity#

使用命令生成 userCount 模块：

1
nest g resource userCount

可以看到此时生成的文件是没有 spec 相关的测试文件

1. 创建 entities 目录，新建 user-auth.entity.ts 文件。

   1
   import {
   2
     Entity,
   3
     Column,
   4
     PrimaryGeneratedColumn,
   5
     CreateDateColumn,
   6
     UpdateDateColumn,
   7
   } from 'typeorm'
   8
   
   9
   @Entity('user_auth')
   10
   export class UserAuth {
   11
     @PrimaryGeneratedColumn()
   12
     id: number
   13
   
   14
     @Column({ type: 'varchar', length: 50 })
   15
     src: string
   16
   
   17
     @Column({ type: 'varchar', length: 128 })
   18
     uuid: string
   19
   
   20
     @CreateDateColumn({ type: 'datetime', name: 'created_at' })
   21
     createdAt: Date
   22
   
   23
     @UpdateDateColumn({ type: 'datetime', name: 'updated_at', nullable: true })
   24
     updatedAt: Date
   25
   
   26
     @Column({ type: 'datetime', name: 'deleted_at', nullable: true })
   27
     deletedAt: Date
   28
   
   29
     @Column({ type: 'tinyint', width: 4, name: 'display_flag' })
   30
     displayFlag: number
   31
   
   32
     @Column({ type: 'varchar', length: 500, name: 'src_uuid' })
   33
     srcUuid: string
   34
   }

   展开收起

2. 在 AppModule 中导入并注册 UserAuth 实体类

   1
   ....import { UserAuth } from './user-count/entities/user-auth.entity';
   2
   
   3
   @Module({
   4
      imports: [
   5
        TypeOrmModule.forRoot({
   6
          type: 'mysql',
   7
          host: '114.116.234.221',
   8
          port: 3309,
   9
          username: 'test_server_see',
   10
          password: 'qmp20240126#dshk',
   11
          database: 'passport',
   12
          synchronize: false,
   13
          logging: true,
   14
          entities: [UserAuth],
   15
          poolSize: 10,
   16
          connectorPackage: 'mysql2',
   17
          extra: {
   18
            authPlugin: 'sha256_password',
   19
          },
   20
        }),
   21
        UserCountModule,
   22
      ],
   23
      controllers: [AppController],
   24
      providers: [AppService],
   25
    })
   26
    export class AppModule {}

   展开收起

   需要将 synchronize: false, 因为在库中已经有此表了，设置为 true 时会创建表

5. 使用实体类#

在 service 层(user-count.service.ts)中使用 UserAuth 实体类来执行数据库操作