利用NestJS构建高效的RESTful API接口_nest.js restful api-优快云博客

本文链接：https://blog.youkuaiyun.com/qiuyufeng/article/details/145521344

1. 引言

项目背景与目标

随着互联网应用的快速发展，RESTful API已成为前后端分离架构中的重要组成部分。本文将介绍如何使用NestJS构建一个高效且可维护的RESTful API接口。目标是通过NestJS的模块化和依赖注入特性，实现一个易于扩展和维护的API系统。

RESTful API的重要性

RESTful API是一种基于HTTP协议的架构风格，它通过标准的HTTP方法（GET、POST、PUT、DELETE等）来操作资源。RESTful API具有以下优点：

无状态性：每个请求都包含所有必要的信息，服务器不存储客户端状态。
可缓存性：响应可以被缓存，提高性能。
分层系统：客户端和服务器可以独立开发和部署。
统一接口：使用标准的HTTP方法和状态码，易于理解和实现。

选择NestJS的原因

NestJS是一个基于Node.js的渐进式框架，使用TypeScript构建。它具有以下优势：

模块化：支持模块化开发，便于代码组织和管理。
依赖注入：内置依赖注入容器，简化对象管理。
面向对象：支持面向对象编程，提高代码可读性和可维护性。
插件丰富：拥有丰富的插件和中间件，支持多种功能扩展。

2. NestJS简介

什么是NestJS

NestJS是一个用于构建高效、可扩展的Node.js服务器端应用程序的框架。它结合了OOP（面向对象编程）、FP（函数式编程）和FRP（函数式响应编程）的优点，提供了强大的工具和特性。

核心特性

模块化：通过模块组织代码，便于管理和扩展。
依赖注入：内置依赖注入容器，简化对象管理。
中间件：支持中间件，用于处理请求和响应。
管道：用于数据验证和转换。
守卫：用于权限控制和认证。
拦截器：用于拦截请求和响应，进行日志记录、缓存等操作。

3. RESTful API设计原则

REST架构风格介绍

REST（Representational State Transfer）是一种基于HTTP协议的架构风格，它通过标准的HTTP方法来操作资源。REST的核心原则包括：

统一接口：使用标准的HTTP方法和状态码。
无状态性：每个请求都包含所有必要的信息，服务器不存储客户端状态。
可缓存性：响应可以被缓存，提高性能。
分层系统：客户端和服务器可以独立开发和部署。
按需代码：服务器可以向客户端发送可执行代码，但通常不使用。

资源命名规范

资源命名应遵循以下规范：

名词复数：使用名词复数表示资源集合，如/users。
小写：资源名称应为小写。
避免动词：资源名称应避免使用动词，如/getUser应改为/users/{id}。

HTTP方法的选择

HTTP方法用于操作资源，常见的方法包括：

GET：获取资源。
POST：创建资源。
PUT：更新资源。
DELETE：删除资源。
PATCH：部分更新资源。

状态码的使用

HTTP状态码用于表示请求的处理结果，常见的状态码包括：

200 OK：请求成功。
201 Created：资源创建成功。
204 No Content：请求成功，但没有返回内容。
400 Bad Request：请求无效。
401 Unauthorized：未授权。
403 Forbidden：禁止访问。
404 Not Found：资源未找到。
500 Internal Server Error：服务器内部错误。

链接关系与HATEOAS

HATEOAS（Hypermedia as the Engine of Application State）是一种通过超媒体驱动应用程序状态的应用架构。在RESTful API中，响应中应包含资源的链接，以便客户端了解如何进一步操作。

4. 项目初始化

安装Node.js和NestJS CLI

首先，确保安装了Node.js和npm。然后安装NestJS CLI：

npm install -g @nestjs/cli

创建新的NestJS项目

使用NestJS CLI创建一个新的项目：

nest new my-api
cd my-api

项目结构概述

生成的项目结构如下：

my-api/
├── src/
│   ├── app.controller.spec.ts
│   ├── app.controller.ts
│   ├── app.module.ts
│   ├── app.service.ts
│   └── main.ts
├── test/
│   ├── app.e2e-spec.ts
│   └── jest-e2e.json
├── .gitignore
├── nest-cli.json
├── package.json
├── tsconfig.build.json
└── tsconfig.json

5. 模块化开发

模块的概念与作用

模块是NestJS中组织代码的基本单位。每个模块可以包含控制器、服务、实体等组件。模块通过@Module装饰器定义。

创建核心模块（如用户模块、订单模块）

使用NestJS CLI创建一个新的模块：

nest generate module users
nest generate module orders

模块间的依赖管理

模块可以通过imports属性导入其他模块。例如，UsersModule可以导入OrdersModule：

// users.module.ts
import {
    Module } from '@nestjs/common';
import {
    OrdersModule } from '../orders/orders.module';

@Module({
   
  imports: [OrdersModule],
  controllers: [UsersController],
  providers: [UsersService],
  exports: [UsersService],
})
export class UsersModule {
   }

6. 路由与控制器

路由定义与参数解析

控制器用于处理HTTP请求。使用@Controller装饰器定义控制器，并使用@Get, @Post, @Put, @Delete等装饰器定义路由。

控制器的基本用法

创建一个新的控制器：

nest generate controller users

路由装饰器详解（`@Get`, `@Post`, `@Put`, `@Delete`等）

示例控制器代码：

// users.controller.ts
import {
    Controller, Get, Post, Body, Param, Put, Delete } from '@nestjs/common';
import {
    UsersService } from './users.service';
import {
    CreateUserDto } from './dto/create-user.dto';
import {
    UpdateUserDto } from './dto/update-user.dto';

@Controller('users')
export class UsersController {
   
  constructor(private readonly usersService: UsersService) {
   }

  @Post()
  create(@Body() createUserDto: CreateUserDto) {
   
    return this.usersService.create(createUserDto);
  }

  @Get()
  findAll() {
   
    return this.usersService.findAll();
  }

  @Get(':id')
  findOne(@Param('id') id: string) {
   
    return this.usersService.findOne(id);
  }

  @Put(':id')
  update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) {
   
    return this.usersService.update(id, updateUserDto);
  }

  @Delete(':id')
  remove(@Param('id') id: string) {
   
    return this.usersService.remove(id);
  }
}

7. 服务层设计

服务类的作用与职责

服务类用于封装业务逻辑。使用@Injectable装饰器定义服务。

业务逻辑封装

创建一个新的服务：

nest generate service users

异步操作处理（Promises, async/await）

示例服务代码：

// users.service.ts
import {
    Injectable } from '@nestjs/common';
import {
    InjectRepository } from '@nestjs/typeorm';
import {
    Repository } from 'typeorm';
import {
    User } from './entities/user.entity';
import {
    CreateUserDto } from './dto/create-user.dto';
import {
    UpdateUserDto } from './dto/update-user.dto';

@Injectable()
export class UsersService {
   
  constructor(
    @InjectRepository(User)
    private usersRepository: Repository<User>,
  ) {
   }

  create(createUserDto: CreateUserDto) {
   
    const user = this.usersRepository.create(createUserDto);
    return this.usersRepository.save(user);
  }

  findAll() {
   
    return this.usersRepository.find();
  }

  findOne(id: string) {
   
    return this.usersRepository.findOneBy({
    id });
  }

  update(id: string, updateUserDto: UpdateUserDto) {
   
    return this.usersRepository.update(id, updateUserDto);
  }

  remove(id: string) {
   
    return this.usersRepository.delete(id);
  }
}