NestJS

• nestjs/nestGitHubnestjs/nestnestjs/nest · 设计来自 Angular + SpringFramework · http-errors · 核心概念 · Module · - · Controller · request -> response · - · , - , ,笔记：NestJS
  • 设计来自 Angular + SpringFramework
  • http-errors
• 核心概念
  • Module
    • @Module()
  • Controller
    • request -> response
    • @Controller('user/me')
    • @Get(),@Post - @HttpCode(204), @Header('Cache-Control', 'none'), @Redirect('https://nestjs.com', 301)
    • @Request(), @Req() req: Request
    • @Response(), @Res() res: Response
    • @Param(key?: string) - req.params
    • @Body(key?: string) - req.body
    • @Query(key?: string) - req.query
    • @Headers(name?: string) - req.headers
    • @Next() next
    • @Ip() - req.ip
    • @HostParam() - req.hosts
    • @Session()
  • Provider
    • @Injectable()
    • @Optional(), @Inject(key?:string)
  • Middleware
  • Exception filter
  • Pipe
  • Guard
  • Interceptor
  • decorator
• 特性
  • 底层平台无关 - 默认 Express，可用 Fastify
  • 支持 GraphQL、WebSocket
  • combine your config and your code seamlessly by making use of TypeScript decorators
• 集成
  • NextJS
    • nestjs/nest#1122GitHub Issuenestjs/nest#1122
    • kyle-mccarthy/nest-nextGitHubkyle-mccarthy/nest-next
    • 因为 Next 可能在构建时有一些请求，两者共存可能会有些问题
    • 可能前后端分离更好
  • 数据库
    • @nestjs/typeorm
    • @nestjs/sequelize
  • 配置
    • @nestjs/config - dotenv
  • 校验
    • class-validatornpm Packageclass-validatorNPM
  • 缓存
    • cache-managernpm Packagecache-managerNPM - Flexible NodeJS cache module
  • 序列化
    • class-transformernpm Packageclass-transformerNPM
  • 任务调度
    • @nestjs/schedule - node-cronnpm Packagenode-cronNPM
  • 安全
    • helmetnpm PackagehelmetNPM
    • CSRF csurfnpm PackagecsurfNPM
    • 限流 express-rate-limitnpm Packageexpress-rate-limitNPM
  • 队列
    • @nestjs/bull - bull
  • 日志
    • winstonjs/winstonGitHubwinstonjs/winston
  • 文件上传
    • expressjs/multerGitHubexpressjs/multer
  • HTTP 客户端
    • axios
  • GraphQL
    • @nestjs/graphql
    • @nestjs/apollo
      • apollo-server-express
    • @nestjs/mercurius

📂 src
├─ 📄 app.controller.spec.ts
├─ 📄 app.controller.ts
├─ 📄 app.module.ts
├─ 📄 app.service.ts
└─ 📄 main.ts

GraphQL

# Express + Apollo 默认
npm i @nestjs/graphql @nestjs/apollo @apollo/server graphql

# Fastify + Apollo
npm i @nestjs/graphql @nestjs/apollo @apollo/server @as-integrations/fastify graphql

# Fastify + Mercurius
npm i @nestjs/graphql @nestjs/mercurius graphql mercurius

Packages@nestjs/graphqlnpm Package@nestjs/graphqlNPM@nestjs/apollonpm Package@nestjs/apolloNPM@apollo/servernpm Package@apollo/serverNPMgraphqlnpm PackagegraphqlNPM@as-integrations/fastifynpm Package@as-integrations/fastifyNPM@nestjs/mercuriusnpm Package@nestjs/mercuriusNPMmercuriusnpm PackagemercuriusNPM

Standalone

作为 IoC 容器

• @nestjs/core
  • 172.1kB, 43.9kB
• @nestjs/common
  • 86.9kB, 19.4kB

import { NestFactory } from '@nestjs/core';

const app = await NestFactory.createApplicationContext(AppModule);
const userService = app.get(UserService);

await app.close();

FAQ

Reflection metadata 'design

' returning undefined

• 需要 emitDecoratorMetadata
• esbuild 不支持 emitDecoratorMetadata，swc 支持

# 推荐 swc + tsx
pnpm swc --watch ./src -d ./dist/out
pnpm tsx watch ./dist/out/main.js

# 或 ts-node
ts-node --esm --swc