学习NestJS开发小程序后台（一）

2024-09-12 10:19:13 浏览数 (2)

前言

前一篇写NestJS的特点，使用NestJS，开启我们的Hello World! 以及NestJS各种热更新方法，本篇会写NestJS在实际项目中的应用。（ORM、参数校验、全局错误处理等等）

NestJS 中使用 TypeORM

一、安装依赖

代码语言：bash复制
npm install @nestjs/typeorm typeorm mysql2

这里假设使用 MySQL 数据库，你可以根据实际情况选择其他数据库驱动。

二、配置数据库连接

  1. 在项目根目录下创建一个文件 ormconfig.js，内容如下：
代码语言：javascript复制
module.exports = {
    type: 'mysql',
    host: 'localhost',
    port: 3306,
    username: 'your_username',
    password: 'your_password',
    database: 'your_database_name',
    entities: [__dirname   '/**/*.entity{.ts,.js}'],
    synchronize: true, // 在生产环境中不要设置为 true，可能会导致数据丢失
};

将 your_username、your_password 和 your_database_name 替换为你的实际数据库连接信息。

  1. 在 main.ts 文件中引入并配置 TypeORM：
代码语言：typescript复制
  import { NestFactory } from '@nestjs/core';
  import { AppModule } from './app.module';
  import { TypeOrmModule } from '@nestjs/typeorm';

  async function bootstrap() {
     const app = await NestFactory.create(AppModule);
     app.useGlobalPipes();

     await app.listen(3000);
   }

  bootstrap();

三、创建实体

在 src/entities 目录下创建一个实体文件，例如 user.entity.ts：

代码语言：typescript复制
import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm'; 

@Entity() 
export class User { 
    @PrimaryGeneratedColumn() 
    id: number; 
    @Column() 
    name: string; 
    @Column() 
    email: string; 
}

四、创建数据访问层（Repository）

在 src/repositories 目录下创建一个文件，例如 user.repository.ts：

代码语言：typescript复制
import { Repository } from 'typeorm'; 
import { User } from '../entities/user.entity'; 
export class UserRepository extends Repository<User> {}

五、在模块中配置 TypeORM 和使用数据访问层

在对应的模块文件中，例如 app.module.ts：

代码语言：typescript复制
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { UserEntity } from './entities/user.entity';
import { UserRepository } from './repositories/user.repository';
import { UsersService } from './services/users.service';
import { UsersController } from './controllers/users.controller';

@Module({
  imports: [TypeOrmModule.forFeature([UserEntity])],
  providers: [UsersService, UserRepository],
  controllers: [UsersController],
})
export class AppModule {}

六、使用数据访问层进行数据库操作

在服务文件中注入数据访问层并进行数据库操作，例如在 users.service.ts：

代码语言：typescript复制
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { User } from './entities/user.entity';
import { UserRepository } from './repositories/user.repository';

@Injectable()
export class UsersService {
  constructor(
    @InjectRepository(UserRepository)
    private readonly userRepository: UserRepository,
  ) {}

  async findAll(): Promise<User[]> {
    return this.userRepository.find();
  }

  async create(user: User): Promise<User> {
    return this.userRepository.save(user);
  }
}

这样就可以在 NestJS 项目中使用 TypeORM 进行数据库操作了。

NestJS中全局错误处理

一、创建全局错误过滤器

  1. 创建一个类来实现ExceptionFilter接口，用于处理全局错误。例如，创建一个文件global-exception.filter.ts：
代码语言：typescript复制
   import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
   import { Request, Response } from 'express';

   @Catch()
   export class GlobalExceptionFilter implements ExceptionFilter {
     catch(exception: any, host: ArgumentsHost) {
       const ctx = host.switchToHttp();
       const response = ctx.getResponse<Response>();
       const request = ctx.getRequest<Request>();
       const status = exception instanceof HttpException? exception.getStatus() : 500;
       const message =
         exception instanceof HttpException
          ? exception.getResponse()['message'] || exception.message
           : 'Internal server error';

       response.status(status).json({
         statusCode: status,
         message,
         timestamp: new Date().toISOString(),
         path: request.url,
       });
     }
   }

这个过滤器会捕获所有的异常，并返回一个统一格式的错误响应。

二、注册全局错误过滤器

  1. 在main.ts文件中注册全局错误过滤器：
代码语言：typescript复制
   import { NestFactory } from '@nestjs/core';
   import { AppModule } from './app.module';
   import { GlobalExceptionFilter } from './global-exception.filter';

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

   bootstrap();

现在，所有在应用程序中抛出的异常都会被全局错误过滤器捕获，并返回统一格式的错误响应。你可以根据实际需求进一步扩展错误处理逻辑，例如记录错误日志、发送通知等。

错误日志

在 NestJS 中可以添加错误日志来记录应用程序中的错误信息，以便于调试和故障排查。以下是一种添加错误日志的方法：

一、安装日志库

可以使用winston和winston-daily-rotate-file库来实现日志记录。

代码语言：bash复制
npm install winston winston-daily-rotate-file

二、创建日志服务

创建一个日志服务来处理日志记录。例如，创建一个文件logger.service.ts：

代码语言：typescript复制
import { Injectable, LoggerService as NestLoggerService } from '@nestjs/common';
import * as winston from 'winston';
import 'winston-daily-rotate-file';

@Injectable()
export class LoggerService implements NestLoggerService {
  private logger: winston.Logger;

  constructor() {
    this.logger = winston.createLogger({
      level: 'info',
      format: winston.format.combine(
        winston.format.timestamp(),
        winston.format.json(),
      ),
      transports: [
        new winston.transports.Console(),
        new winston.transports.DailyRotateFile({
          filename: 'logs/application-�TE%.log',
          datePattern: 'YYYY-MM-DD',
          zippedArchive: true,
          maxSize: '20m',
          maxFiles: '14d',
        }),
      ],
    });
  }

  log(message: string) {
    this.logger.info(message);
  }

  error(message: string, trace: string) {
    this.logger.error({ message, trace });
  }

  warn(message: string) {
    this.logger.warn(message);
  }

  debug(message: string) {
    this.logger.debug(message);
  }

三、在全局错误过滤器中使用日志服务

修改全局错误过滤器，在捕获到错误时使用日志服务记录错误信息。文件global-exception.filter.ts：

代码语言：typescript复制
import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
import { Request, Response } from 'express';
import { LoggerService } from './logger.service';

@Catch()
export class GlobalExceptionFilter implements ExceptionFilter {
  constructor(private readonly logger: LoggerService) {}

  catch(exception: any, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse<Response>();
    const request = ctx.getRequest<Request>();
    const status = exception instanceof HttpException? exception.getStatus() : 500;
    const message =
      exception instanceof HttpException
       ? exception.getResponse()['message'] || exception.message
        : 'Internal server error';

    this.logger.error({
      statusCode: status,
      message,
      timestamp: new Date().toISOString(),
      path: request.url,
    });

    response.status(status).json({
      statusCode: status,
      message,
      timestamp: new Date().toISOString(),
      path: request.url,
    });
  }
}

在 main.ts 中注册全局错误过滤器和日志服务：

代码语言：typescript复制
   import { NestFactory } from '@nestjs/core';
   import { AppModule } from './app.module';
   import { GlobalExceptionFilter } from './global-exception.filter';
   import { LoggerService } from './logger.service';

   async function bootstrap() {
     const app = await NestFactory.create(AppModule);
     app.useGlobalFilters(new GlobalExceptionFilter(app.get(LoggerService)));
     await app.listen(3000);
   }

   bootstrap();

四、在其他地方使用日志服务

可以在其他服务、控制器等地方注入日志服务，并使用它来记录日志信息。例如，在一个服务中：

代码语言：typescript复制
import { Injectable } from '@nestjs/common';
import { LoggerService } from './logger.service';

@Injectable()
export class SomeService {
  constructor(private readonly logger: LoggerService) {}

  someMethod() {
    this.logger.log('This is a log message.');
    //...
    try {
      // 一些可能会出错的代码
    } catch (error) {
      this.logger.error('An error occurred in someMethod', error.stack);
    }
  }
}

这样，在应用程序中发生错误时，错误信息会被记录到日志文件中，同时也可以在其他地方使用日志服务记录各种信息，方便调试和故障排查。

NestJS参数校验 zod

因为之前koa用的Joi，想找一个类似的。zod 是一个强大的类型安全和数据验证库。

优点：

  • 提供了简洁直观的 API 来定义和验证数据结构。
  • 支持类型推导，使得类型安全更加可靠。

Joi和zod都是 JavaScript 和 TypeScript 中常用的用于数据验证和校验的库，它们有一些相似之处，但也存在一些不同点：

一、相似之处

1.数据验证功能

  • 两者都可以对输入数据进行各种类型的验证，包括字符串长度、数值范围、数据格式（如电子邮件地址）等。
  • 例如，都可以验证一个字符串是否为有效的电子邮件地址，或者一个数值是否在特定的范围内。

2.链式调用语法

  • Joi和zod都提供了一种链式调用的语法，使得可以方便地组合多个验证规则。
  • 例如，可以通过连续调用方法来添加多个验证条件，使代码更加清晰和易读。
代码语言：typescript复制
import { z } from 'zod';

const userSchema = z.object({
  name: z.string().min(3),
  email: z.string().email(),
});

export class CreateUserDto {
  constructor(data: z.infer<typeof userSchema>) {
    Object.assign(this, data);
  }

  name: string;
  email: string;
}

1.安装 zod 库：

代码语言：bash复制
   npm install zod

2.创建数据验证 schema：

例如，创建一个用于用户创建的 schema：

代码语言：typescript复制
   import { z } from 'zod';

   const createUserSchema = z.object({
     name: z.string().min(3),
     email: z.string().email(),
   });
  1. 在控制器中使用：
代码语言：typescript复制
   import { Controller, Post, Body } from '@nestjs/common';
   import { createUserSchema } from './schemas/user.schema';

   @Controller('users')
   export class UserController {
     @Post()
     async createUser(@Body() body: any) {
       const parsedData = createUserSchema.safeParse(body);
       if (!parsedData.success) {
         // 处理校验失败的情况，返回错误信息
         return { error: parsedData.error };
       }
       // 继续处理成功校验后的数据
       const { name, email } = parsedData.data;
       //...
       return { message: 'User created successfully' };
     }
   }

这样，当有 POST 请求到 /users 路径时，会使用 zod schema 对请求体进行校验，如果校验不通过，会返回校验错误信息。

后面把koa项目使用Nestjs重构完，就把代码开源。

参考：

https://nest.nodejs.cn

https://cloud.tencent.com/developer/article/1907958

https://blog.csdn.net/weixin_47121832/article/details/136691434

https://cloud.tencent.com/developer/article/2397800

node.js nestjs 腾讯技术创作特训营S9

0 人点赞