:::tip{title="nestjs控制器Controller（四）"}
这篇文章详细介绍了在NestJS框架中如何定义控制器（Controller）以处理HTTP请求，如何通过装饰器（如`@Get`、`@Post`等）定义路由来响应不同的HTTP方法，并如何使用参数装饰器（如`@Body`、`@Query`、`@Param`等）从请求中提取信息。文章通过实例代码清晰展示了这些概念的应用，帮助开发者理解和使用NestJS进行Web应用开发。
:::
 

# 一、什么是 Controller？

什么是 **`Controller`**？语义化翻译就是 **控制器**，它负责处理传入的请求并将响应结果返回给客户端。

控制器的目的是接收应用程序的特定请求。其 **路由** 机制控制哪个控制器接收哪些请求。通常，每个控制器都有多个路由，不同的路由可以执行不同的操作。

# 二、如何将类定义为控制器？

在类声明上，定义 `@Controller()` 装饰器，即可将该类定义为控制器，在 `Nest` 中，几乎所有的装饰器都是以方法形式存在的，我们通过查看 `@Controller()` 装饰器的源码：

```bash
export function Controller(prefix?: string): ClassDecorator {
  const path = isUndefined(prefix) ? '/' : prefix;
  return (target: object) => {
    Reflect.defineMetadata(PATH_METADATA, path, target);
  };
}
```

可以看出，控制器装饰器有一个可选的方法参数，该参数默认值为 `/`，其作用就是定义当前控制器类下所有路由方法的前缀，这样以来，就可以避免我们在定义路由时出现多余的相同前缀。

现在，让我们定义一个前缀为 `cats` 的控制器：

```bash
import { Controller } from '@nestjs/common';

@Controller('cats')
export class CatsController { }
```

# 三、如何在类的方法上定义路由？

在类的方法声明上，定义 `@Get()`、`@Post()`、`@Put()`、`@Patch()`、`@Delete()`、`@Options()`、`@Head()`、`@All()`。这些装饰器都表示各自的 **HTTP** 请求方法。

现在，让我们在上述的 `CatsController` 类中定义实际开发中常用的几种路由映射：

```bash
import { Controller, Get, Post, Body, Put, Param, Delete } from '@nestjs/common';

@Controller('cats')
export class CatsController {
  @Post()
  async create(@Body() createCatDto: CreateCatDto) {
    return 'This action adds a new cat';
  }

  @Delete(':id')
  async remove(@Param('id') id) {
    return `This action removes a #${id} cat`;
  }

  @Put(':id')
  async update(@Param('id') id, @Body() updateCatDto: UpdateCatDto) {
    return `This action updates a #${id} cat`;
  }

  @Get(':id')
  async findOne(@Param('id') id) {
    return `This action returns a #${id} cat`;
  }

  @Get()
  async findAll(@Query() query) {
    return `This action returns all cats (limit: ${query.limit} items)`;
  }
}

// createCatDto 和 updateCatDto 可以使用类来定义其结构：
export class CreateCatDto {
    id: number;
    name: string;
}

export class UpdateCatDto {
    name: string;
}
```

在定义路由时，方法参数中，我们使用到了 `@Body()`、`@Query()`、`@Param()` 这样的参数装饰器，他们是什么意思呢？用过 `express` 的同学都会经常接触到：`req`、`res`、`next`、`req.body`、`req.query`、`req.params`等等，诸如此类的特性，下面我们列举出，在 **Nest** 框架中，这些装饰器与 `express` 中的使用方法是如何对应的

# 四、NestJS参数装饰器详细说明

| 装饰器全称 | 缩写 | 对应Express对象属性 | 描述 | 常用请求类型 | 应用场景示例 |
| --- | --- | --- | --- | --- | --- |
| @Request() | @Req() | req | 获取整个请求对象。 | 所有请求类型 | 当需要访问请求的元数据或执行非标准操作时。 |
| @Response() | @Res() | res | 获取响应对象。 | 所有请求类型 | 自定义响应，如设置特定的HTTP状态码或头部。 |
| @Next() | 无 | nest | 获取next函数，用于执行中间件链中的下一个函数。 | 所有请求类型 | 在处理请求的过程中，手动控制和调用中间件链中的下一个中间件函数。 |
| @Query() | 无 | req.query / req.query[param] | 获取请求的查询参数（URL中的查询字符串）。 | GET | 分页参数、搜索条件等。 |
| @Body() | 无 | req.body / req.body[param] | 获取请求体中的数据。 | POST, PUT, PATCH | 提交表单数据，如用户注册信息、文章内容等。 |
| @Param() | 无 | req.params / req.params[param] | 获取请求路径中的参数，例如在RESTful API中通过资源ID访问资源。 | GET, DELETE | 访问特定资源的详情或删除操作，如/users/:userId。 |
| @Headers() | 无 | req.headers / req.headers[param] | 获取请求头中的数据。 | 所有请求类型 | 认证（如Bearer Token）、自定义头部等。 |
| @Session() | 无 | req.session | 获取当前会话对象。这依赖于你的应用是否使用了会话管理。 | 所有请求类型 | 用户登录状态、购物车内容等会话级别的数据管理。 |
| @Ip() | 无 | req.ip | 获取发起请求的客户端IP地址。 | 所有请求类型 | 使用@Ip()装饰器可以为安全审计、定位服务或请求来源限制等场景提供客户端IP地址。 |
| @HostParam() | 无 | req.hosts | 获取请求的主机参数（注意：@HostParam()并非Express的标准属性，此处可能需要特别处理或自定义实现）。 | 所有请求类型 | @HostParam()装饰器用于获取请求的主机名参数，常见于需要基于不同主机名或子域名提供不同逻辑处理的多租户应用场景。 |

> Tips：Nest 底层默认使用了 `express` 作为 web 层的框架
> 
> 
> 注意：如果在方法参数中定义了 @Res() 或 @Next()，此时该方法的 return 语句会被阻塞，因为 return 形式的返回是 nest 标准形式，而一但使用了上述两个装饰器后，nest 不会在用标准 形式返回数据，此时必须使用 res.send / res.end / res.json 等，这种 `express` 特定的写法返回数据。
> 

# 二、常用的装饰器

## (1)常用的方法装饰器

NestJS 通过一系列方法装饰器，简化了路由的定义，使得创建RESTful API变得直观和高效。

- **`@Get()`**：定义一个处理GET请求的路由。用于获取资源。
- **`@Post()`**：定义一个处理POST请求的路由。常用于创建资源。
- **`@Patch()`**：定义一个处理PATCH请求的路由。用于对资源进行部分更新。
- **`@Delete()`**：定义一个处理DELETE请求的路由。用于删除资源。

这些装饰器通过明确的HTTP方法指示，使得API的意图和行为变得清晰易懂。

## （2）常用的方法参数装饰器

方法参数装饰器用于从请求中提取信息，极大地简化了数据处理过程。

- **`@Body()`**：从请求体中提取数据，常用于处理POST和PATCH请求中的内容。
- **`@Query()`**：从URL查询字符串中提取参数，常用于过滤GET请求的结果。
- **`@Param()`**：从路由参数中提取特定的值，常用于获取资源的标识符。
- **`@Request()`**, **`@Req()`**：提取整个请求对象，使得可以访问请求的所有细节。
- **`@Response()`**, **`@Res()`**：提取响应对象，用于自定义响应的发送。

这些装饰器使得从请求中获取所需的任何信息变得非常直接和方便。

## （3）其他有用但不常用的装饰器

虽然在日常开发中可能不常用，但以下装饰器在特定场景下非常有用：

- **`@HttpCode()`**：自定义响应的HTTP状态码。
- **`@Header()`**：自定义响应头。
- **`@Redirect()`**：对请求进行重定向。

这些装饰器提供了额外的控制，使得可以根据需求定制响应的行为。

# 三、调试工具

调试工具可以使用[**postMan](https://www.postman.com/)  [ApiFox](https://apifox.com/?utm_source=baidu_sem1)** 等

## （1）获取get请求传参

可以使用`**Request装饰器**` 或者 `**Query 装饰器**` 跟 **express** 完全一样

![https://image.myxuechao.com/NestJs/3.png](https://image.myxuechao.com/NestJs/3.png)

也可以使用`**Query**` 直接获取 不需要在通过`**req.query**` 了

![https://image.myxuechao.com/NestJs/4.png](https://image.myxuechao.com/NestJs/4.png)

```bash
import { Controller, Get, Post, Body, Patch, Param, Delete, Request, Query, Headers, HttpCode } from '@nestjs/common';

import { UserService } from './user.service';

@Controller('user')
export class UserController {
  constructor(private readonly userService: UserService) {}
  // ################# 获取GET请求参数的方式 ##################
  /**
   * @description 处理GET请求，使用@Request()获取整个请求对象
   * @param {*} req 请求对象
   * @return {*} 返回userService的findAllWithRequest方法的结果
   */
  @Get('request')
  findAllWithRequest(@Request() req) {
    return this.userService.findAllWithRequest(req);
  }

  /**
   * @description 处理GET请求，使用@Query()获取URL查询参数
   * @param {*} query 查询参数
   * @return {*} 返回userService的findAllWithQuery方法的结果
   */
  @Get('query')
  findAllWithQuery(@Query() query) {
    return this.userService.findAllWithQuery(query);
  }
}

```

## （2）post 获取参数

可以使用`**Request装饰器**` 或者 `**Body 装饰器**` 跟express 完全一样

![https://image.myxuechao.com/NestJs/5.png](https://image.myxuechao.com/NestJs/5.png)

**或者直接使用`Body 装饰器`**

![https://image.myxuechao.com/NestJs/6.png](https://image.myxuechao.com/NestJs/6.png)

```bash
import { Controller, Get, Post, Body, Patch, Param, Delete, Request, Query, Headers, HttpCode } from '@nestjs/common';

import { UserService } from './user.service';

@Controller('user')
export class UserController {
  constructor(private readonly userService: UserService) {}

  @Post()
  create(@Body() body) {
    console.log('body: ', body);
    return {
      code: 200,
      message: 'success',
      data: body,
    };
  }
}

```

## (3)**动态路由**

可以使用`**Request装饰器**` 或者 `**Param 装饰器**` 跟express 完全一样

![https://image.myxuechao.com/NestJs/7.png](https://image.myxuechao.com/NestJs/7.png)

**或者直接使用`Param 装饰器`**

![https://image.myxuechao.com/NestJs/8.png](https://image.myxuechao.com/NestJs/8.png)

```bash
import { Controller, Get, Post, Body, Patch, Param, Delete, Version, Request, Query } from '@nestjs/common';
import { UserService } from './user.service';
 
@Controller('user')
export class UserController {
  constructor(private readonly userService: UserService) { }
 
  @Get(':id')
  findId (@Param() param) {
     
    console.log(param)
 
    return {
       code:200
    }
  }
}
```

nestjs控制器Controller（四）

:::tip{title="nestjs cli 常用命令（三）"}
本文介绍了如何使用 Nest.js CLI 命令创建 Nest.js 项目和生成常见模块，并演示了通过命令行快速生成 CURD 模板。简洁明了，总结为一句话：本文介绍了 Nest.js CLI 的常用命令和快速生成 CURD 模板的方法。
:::


# 一、查看nestjs所有的命令

**（1）`nest --help` 可以查看nestjs所有的命令**

| name | alias | description | 名称 | 别名 | 描述 |
| --- | --- | --- | --- | --- | --- |
| application | application | Generate a new application workspace | 应用程序 | 应用程序 | 生成一个新的应用程序工作空间 |
| class | cl | Generate a new class | 类 | cl | 生成一个新的类 |
| configuration | config | Generate a CLI configuration file | 配置 | config | 生成一个 CLI 配置文件 |
| controller | co | Generate a controller declaration | 控制器 | co | 生成一个控制器声明 |
| decorator | d | Generate a custom decorator | 装饰器 | d | 生成一个自定义装饰器 |
| filter | f | Generate a filter declaration | 过滤器 | f | 生成一个过滤器声明 |
| gateway | ga | Generate a gateway declaration | 网关 | ga | 生成一个网关声明 |
| guard | gu | Generate a guard declaration | 守卫 | gu | 生成一个守卫声明 |
| interceptor | itc | Generate an interceptor declaration | 拦截器 | itc | 生成一个拦截器声明 |
| interface | itf | Generate an interface | 接口 | itf | 生成一个接口 |
| library | lib | Generate a new library within a monorepo | 库 | lib | 在一个 monorepo 中生成一个新的库 |
| middleware | mi | Generate a middleware declaration | 中间件 | mi | 生成一个中间件声明 |
| module | mo | Generate a module declaration | 模块 | mo | 生成一个模块声明 |
| pipe | pi | Generate a pipe declaration | 管道 | pi | 生成一个管道声明 |
| provider | pr | Generate a provider declaration | 提供者 | pr | 生成一个提供者声明 |
| resolver | r | Generate a GraphQL resolver declaration | 解析器 | r | 生成一个 GraphQL 解析器声明 |
| resource | res | Generate a new CRUD resource | 资源 | res | 生成一个新的 CRUD 资源 |
| service | s | Generate a service declaration | 服务 | s | 生成一个服务声明 |
| sub-app | app | Generate a new application within a monorepo | 子应用 | app | 在一个 monorepo 中生成一个新的应用程序 |

# 二、案例生成一个用户模块

> **我们可以直接使用一个命令生成`CURD`**
> 

```bash
# 使用 Nest CLI 生成新的资源
nest g resource [模块名称]

# 示例:
# 生成一个名为 'user' 的新资源
nest g resource user
```

![https://image.myxuechao.com/NestJs/1.png](https://image.myxuechao.com/NestJs/1.png)

首次运行此命令时，除了生成文件外，`**Nest CLI**` 还会自动执行 `**npm install**` 以更新资源并安装必要的插件。这些操作仅在首次运行命令时执行，后续再次运行命令时则不会重复更新。

![https://image.myxuechao.com/NestJs/2.png](https://image.myxuechao.com/NestJs/2.png)

**此时！完美生成了一套标准的CURD 模板**

nestjs cli 常用命令（三）

:::tip{title="介绍nestjs cli（二）"}
本文介绍了如何使用 Nest.js CLI 创建和管理 Nest.js 项目，并详细介绍了项目结构和关键文件的作用。
:::
 


# 一、创建nestjs项目

## （1）先决条件

**请确保您的操作系统上安装了[Node.js （版本 >= 16）](https://nodejs.org/)**

## （2）**通过cli创建nestjs项目**

```bash
# 在全局安装 Nest.js 的命令行工具（CLI）
npm i -g @nestjs/cli

# 创建一个新的 Nest.js 项目，项目的根目录将会被命名为 `project-name`
nest new project-name
```

启动项目 我们需要[热更新](https://so.csdn.net/so/search?q=%E7%83%AD%E6%9B%B4%E6%96%B0&spm=1001.2101.3001.7020) 就启动npm run start:dev就可以了

```jsx
    "start": "nest start",
    "start:dev": "nest start --watch",
    "start:debug": "nest start --debug --watch",
    "start:prod": "node dist/main",
```

# 二、目录介绍

## （1）min.js

1、**`min.js`** 是 Nest.js 应用程序的入口文件，用于启动应用程序。类似于`**vue`** 的`**main.ts**`

2、它通过 **`NestFactory`** 创建一个 AppModule 实例，并指定应用程序监听的端口号（通常是 3000）。。然后，通过调用 **`app.listen()`** 方法来启动应用程序，使其开始监听客户端的请求。

```jsx
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

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

```

## （2）Controller.ts 控制器

在 **`Controller.ts`** 文件中，控制器的作用相当于 Vue 中的路由。而 **`private readonly appService: AppService`** 这行代码利用了依赖注入的概念，它指示 Nest.js 在运行时自动实例化 **`AppService`**，而不需要手动实例化。这种方法使代码更简洁、可维护性更高，因为我们只需要声明依赖，而不必担心它们的实例化过程。

```jsx
import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }
}

```

## （3）app.service.ts 具有单一方法的基本服务

`**app.service.ts**` 是 Nest.js 应用中用于封装业务逻辑和功能的服务文件。尽管控制器`**Controller**`可以实现逻辑，但通常是单一且难以复用的。将逻辑放置在`**app.service.ts**`服务中可以实现可复用性，并且能够在应用的不同模块中轻松调用。

```jsx
import { Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  getHello(): string {
    return 'Hello World lxc!';
  }
}
```

介绍nestjs cli（二）

:::tip{title="介绍nestjs"}
 本文介绍了nestjs是啥？用来做什么
:::

# NestJS 入门介绍

## 什么是NestJS?

NestJS是一个高效、可扩展的Node.js服务端应用程序开发框架，完全支持TypeScript。它结合了面向切面编程（AOP）、依赖注入（IOC）等概念，借鉴了Angular的设计。

## 核心特点

- **高性能**: 基于Express和Fastify，提供抽象层同时暴露原生API。
- **可扩展性**: 通过钩子、插件和装饰器等机制实现。
- **TypeScript支持**: 为TypeScript社区提供了完善的类型声明文件。

## NestJS内置框架

- **Express**: 默认使用，易于上手。
- **Fastify**: 知名的高性能web框架，特色包括高性能、基于Schema的路由验证等。

## 快速开始

1. 安装Nest CLI：`npm i -g @nestjs/cli`
2. 创建新项目：`nest new project-name`
3. 进入项目目录，启动应用：`cd project-name && npm run start:dev`

## 核心概念

- **控制器**：处理传入的请求和返回响应
- **提供者**：可以注入到控制器和其他服务中的类
- **模块**：组织应用结构的单元

## 如何开始?

可以访问NestJS的[官方文档](https://nestjs.com/)和[中文文档](https://nestjs.bootcss.com/)来了解如何开始使用NestJS进行开发。

介绍nestjs

:::tip{title="Flutter安装 SDK MacOS"}
本文介绍了Flutter的SDK安装配置
:::

 
## 本节目标

- 采用 下载 方式安装 SDK
- 编译代码 flutter tool
- 检查环境 flutter doctor

## 1. 安装 SDK

### 1.1 方式一：下载SDK包

- [SDK包下载](https://flutter.dev/docs/development/tools/sdk/releases)

> 这里的解压目录看个人需求放在哪里
> 

```jsx
解压到 ~/Documents/sdk/flutter
# 我个人是放的目录
/Users/liuxuechao/global/personage/project/flutter/sdk/flutter
```

## 2. 配置环境变量

```jsx
# 打开 ~/.bash_profile 文件
open ~/.bash_profile
# 复制下面的句子放在 ~/.bash_profile 文件

# 设置 Flutter 的根目录，注意没有单引号
export FLUTTER_HOME=/Users/liuxuechao/global/personage/project/flutter/sdk/flutter

# 将 Flutter 可执行文件所在目录添加到 PATH 环境变量中
export PATH=$PATH:$FLUTTER_HOME/bin

# 将 Flutter 的 Dart SDK 可执行文件所在目录添加到 PATH 环境变量中
export PATH=$PATH:$FLUTTER_HOME/bin/cache/dart-sdk/bin

# 以下两行适合国内
# 使用国内镜像加速 Flutter 包的下载和更新
# 设置 Flutter 包的官方镜像地址为 https://pub.flutter-io.cn
export PUB_HOSTED_URL=https://pub.flutter-io.cn

# 设置 Flutter SDK 的存储库镜像地址为 https://storage.flutter-io.cn
export FLUTTER_STORAGE_BASE_URL=https://storage.flutter-io.cn
```

## 2.1 使 bash_profile 文件的修改生效

```jsx
source ~/.bash_profile
```

## 2.2 查看$PATH 环境变量

> 这条命令将会输出 **`$PATH`** 环境变量中的所有路径，每个路径占据一行。
> 

```jsx
echo $PATH | tr ':' '\n'
```

## 3. zsh 用户修改配置文件

```jsx
# 打开 ~/.zshrc 文件
open ~/.zshrc

# 在文件的最后一行添加以下内容，用于引入 ~/.bash_profile 文件
source ~/.bash_profile

# 重新在终端使用 source 命令加载 ~/.zshrc 文件中的更改
source ~/.zshrc
```

## 4. 检查环境 flutter doctor

```jsx
# 终端输入命令
flutter doctor
# 结果
Doctor summary (to see all details, run flutter doctor -v):
[✓] Flutter (Channel stable, 3.0.5, on macOS 14.2.1 23C71 darwin-arm (Rosetta), locale zh-Hans-CN)
[✓] Android toolchain - develop for Android devices (Android SDK version 33.0.0)
[✓] Xcode - develop for iOS and macOS (Xcode 15.2)
[✓] Chrome - develop for the web
[✓] Android Studio (version 2021.2)
[✓] IntelliJ IDEA Ultimate Edition (version 2022.1.4)
[✓] VS Code (version 1.86.2)
[✓] Connected device (3 available)
[✓] HTTP Host Availability

• No issues found!
```

## 5. 查看版本 version

```jsx
# 终端输入命令
flutter --version
# 结果
Flutter 3.0.5 • channel stable • https://github.com/flutter/flutter.git
Framework • revision f1875d570e (1 year, 7 months ago) • 2022-07-13 11:24:16 -0700
Engine • revision e85ea0e79c
Tools • Dart 2.17.6 • DevTools 2.12.2
```