nestjs从零开始

基础概念

控制器Controller

路由

import { Controller, Get } from '@nestjs/common';

@Controller('cats')
export class CatsController {
  @Get()
  findAll(): string {
    return 'This action returns all cats'
  }
}

状态码

@Post()
@HttpCode(204)
create() {
  return 'This action adds a new cat';
}

@Post()
  @UseInterceptors(FileInterceptor('file'))
  @ApiConsumes('multipart/form-data')
  @ApiBody({
    description: '图片文件',
    type: FileUploadDto,
  })
  update(@UploadedFile() file: Express.Multer.File) {
    const reg = /^image/;
    if (!reg.test(file.mimetype)) {
      throw new HttpException('只接受图片文件', HttpStatus.FORBIDDEN);
    }
    if (file.size > IMAGE_SIZE) {
      throw new HttpException('图片不能大于10MB', HttpStatus.FORBIDDEN);
    }
    try {
      this.imageService.saveImage(file);
      return new ResponseJSON(true);
    } catch {
      throw new HttpException('上传失败', 500);
    }
  }

• response 参数定义 JSON 响应体。它可以是 string 或 object，如下所述。

• status参数定义HTTP状态代码。

参数

• Param 路由参数

• Query 查询字符串

• Body 请求体

Get(':img')
findOne(@Param('img') img): string {
  return `返回${img}图片`;
}

@Get()
getDocs(@Query() query) {
    return query;
}

@Post()
async create(@Body() createCatDto) {
  return 'This action adds a new cat';
}

控制器中的装饰器

Headers

@Post()
@Header('Cache-Control', 'none')
create() {
  return 'This action adds a new cat';
}
// 或者
const imageCacheTime = 100000
@Get(':imagePath')
  fetchImage(@Param() param: FetchImageDto, @Res() res) {
    res
      .set('cache-control', `public, max-age=${imageCacheTime}`)
      .sendFile(join(__dirname, '../../../public/images/' + param.imagePath));
}

提供者Provider

import { Injectable } from '@nestjs/common';
import { Cat } from './interfaces/cat.interface';

@Injectable()
export class CatsService {
  private readonly cats: Cat[] = [];

  create(cat: Cat) {
    this.cats.push(cat);
  }

  findAll(): Cat[] {
    return this.cats;
  }
}

// cat.controller.ts
// 控制器关注路由、HTTP相关的逻辑
@Controller(APIBase + 'aircle')
export class CatController {
	constructor(private readonly catsService : CatsService ) {} // 依赖注入
	@Get()
	  findAll() {
	    return this.catsService.findAll();
	}
}

// cat.service.ts
// 而提供者通常负责更复杂的任务
@Injectable()
export class CatsService {
  private readonly cats: Cat[] = [];

  create(cat: Cat) {
    this.cats.push(cat);
  }

  findAll(): Cat[] {
    return this.cats;
  }
}

constructor(private readonly catsService: CatsService) {}

模块Module

import { Module } from '@nestjs/common';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';

@Module({
  controllers: [CatsController],
  providers: [CatsService],
})
export class CatsModule {}

根模块

@Module({
  imports: [
    MongooseModule.forRoot('mongodb://localhost/myblog'),
    DocsModule,
    ImageModule,
    LoginModule,
    AircleModule,
  ],
  controllers: [AppController],
  providers: [AppService],
})

实践总结

Typescript

Joi or class-validator

// 这是一个typescript类，可以在编译时提供类型支持
// 同时也能在运行时进行数据验证
export class LoginDto {
  @IsEmail()
  email: string;
  @IsString()
  password: string;
}

参数验证

• 转换：将输入数据转换成所需的数据输出

• 验证：对输入数据进行验证，只有验证成功的数据才能输出

• ValidationPipe

• ParseIntPipe

• ParseBoolPipe

• ParseArrayPipe

• ParseUUIDPipe

• DefaultValuePipe

• ParseEnumPipe

• ParseFloatPipe

type: 'body' | 'query' | 'param' | 'custom';
metatype?: Type<unknown>;
data?: string;

import {
  ArgumentMetadata,
  HttpException,
  HttpStatus,
  Injectable,
  PipeTransform,
} from '@nestjs/common';
import { plainToClass } from 'class-transformer';
import { validate } from 'class-validator';

@Injectable()
export class validRequest implements PipeTransform {
  async transform(value: any, metadata: ArgumentMetadata) {
    const metatype = metadata.metatype;
		// 如果没有DTO，或者DTO是String等，则直接通过
    if (!metatype || !this.toValidate(metatype)) {
      return value;
    }
		/*
		* metatype是参数对象的类
		* plainToClass函数将value转换成metatype的实例
		* validate进行验证
		*/
    const object = plainToClass(metatype, value);
    const errors = await validate(object);

		// 存在异常，返回参数错误响应
    if (errors.length > 0) {
      throw new HttpException('参数错误', HttpStatus.BAD_REQUEST);
    }
    return value;
  }

  private toValidate(metatype: any): boolean {
    const types: any[] = [String, Boolean, Number, Array, Object];
    return !types.includes(metatype);
  }
}

// login.dto.ts
// 这是一个typescript类，可以在编译时提供类型支持
// 同时也能在运行时进行数据验证
export class LoginDto {
  @IsEmail()
  email: string;
  @IsString()
  password: string;
}
// login.controller.ts
@Controller('user')
export class LoginController {
  constructor(private readonly loginService: LoginService) {}

  @Post('login')
  login(@Body() body: LoginDto) {
    return this.loginService.login(body);
  }
}

app.useGlobalPipes(new validRequest());

文件上传与下载

数据库

日志

压缩

鉴权

安全

自定义装饰器

拦截器

Swagger文档

参考

Nest.js 中文文档

更优雅的 node.js 框架-用于构建高效且可伸缩的服务端应用程序的渐进式 Node.js 框架。完美支持 Typescript,面向 AOP 编程 支持 typeorm,Node.js 版的 spring,构建微服务应用

https://docs.nestjs.cn/

Documentation | NestJS - A progressive Node.js framework

Nest is a framework for building efficient, scalable Node.js server-side applications. It uses progressive JavaScript, is built with TypeScript and combines elements of OOP (Object Oriented Progamming), FP (Functional Programming), and FRP (Functional Reactive Programming).

https://docs.nestjs.com/