小满nestjs(第八章 控制器参数解析实战:从装饰器到业务应用)

news2026/5/13 18:40:16
1. 控制器参数装饰器基础入门刚开始接触NestJS时最让我困惑的就是如何优雅地获取前端传递的参数。传统Express开发中我们需要手动从req对象里提取数据而NestJS提供的一系列参数装饰器简直就像开了外挂。记得我第一次用Query()直接拿到URL参数时那种原来还能这样的惊喜感至今难忘。先来看个最简单的例子。假设我们要开发一个用户搜索接口传统Express写法是这样的Get(search) searchUser(req) { const keyword req.query.keyword const page req.query.page // ...业务逻辑 }而在NestJS中我们可以简化为Get(search) searchUser(Query(keyword) keyword: string, Query(page) page: number) { // ...直接使用keyword和page }这种写法不仅更简洁还能利用TypeScript的类型提示。实际开发中我发现合理使用这些装饰器能让代码可读性提升至少50%。常用的基础装饰器包括Query()获取URL查询参数Body()获取POST请求体Param()获取路由参数Headers()获取请求头信息HttpCode()设置响应状态码每个装饰器都可以单独使用也可以组合使用。比如处理用户登录接口时我通常会同时用到Body()获取账号密码和Headers()获取设备信息。2. GET请求参数处理实战在实际项目中GET请求的参数处理看似简单却暗藏玄机。先分享一个我踩过的坑有次接口突然报错排查半天发现是前端传了个数组参数而我没有做特殊处理。后来才知道Query()对数组参数需要特殊配置。2.1 基础查询参数处理最基本的用法就是获取单个查询参数Get(list) getUserList(Query(page) page: number) { // 获取?page1中的page值 }但实际业务中我们经常需要获取多个参数。这时可以有两种写法// 方式一逐个获取 Get(list) getUserList( Query(page) page: number, Query(size) size: number ) {...} // 方式二获取整个query对象 Get(list) getUserList(Query() params: {page: number; size: number}) {...}我个人的经验是当参数少于3个时用方式一更清晰参数多时用方式二更合适。特别是需要把参数直接传递给service层时方式二会更方便。2.2 处理特殊类型参数对于数组参数需要特别注意// 前端传参?ids1,2,3 Get(detail) getDetails(Query(ids) ids: string) { // ids是字符串1,2,3 const idArray ids.split(,) }更优雅的写法是使用class-transformerimport { Type } from class-transformer class GetDetailsDto { Type(() Number) ids: number[] } Get(detail) getDetails(Query() query: GetDetailsDto) { // query.ids已经是number数组[1,2,3] }3. POST请求体处理技巧POST请求的参数处理是API开发的重头戏。这里我强烈推荐结合DTO数据传输对象来使用Body()装饰器这能让代码更健壮、更易维护。3.1 基础表单数据处理最简单的POST接口可以这样写Post(create) createUser(Body() body: any) { // body就是前端传来的JSON对象 }但这种写法没有任何类型校验实际项目中我们应该定义明确的DTOclass CreateUserDto { username: string password: string age?: number // 可选参数 } Post(create) createUser(Body() createUserDto: CreateUserDto) { // 现在createUserDto有完整的类型提示 }3.2 结合class-validator做数据校验光有类型还不够我们还需要数据校验。NestJS完美支持class-validatorimport { IsString, IsNotEmpty, IsOptional, IsInt } from class-validator class CreateUserDto { IsString() IsNotEmpty() username: string IsString() IsNotEmpty() password: string IsOptional() IsInt() age?: number } Post(create) createUser(Body() createUserDto: CreateUserDto) { // 参数会自动校验无效请求会被拦截 }这种组合使用DTO和校验装饰器的模式在我的项目中减少了约70%的参数校验代码。校验失败时NestJS会自动返回400错误和详细的错误信息。4. 动态路由与请求头处理动态路由参数和请求头信息在RESTful API中也很常见NestJS提供了专门的装饰器来处理这些场景。4.1 动态路由参数处理假设我们要实现一个用户详情接口路由是/user/:idGet(:id) getUserDetail(Param(id) id: string) { // 获取路由中的id参数 }这里有个实用技巧如果路由中有多个参数可以一次性获取Get(:type/:id) getDetail( Param() params: {type: string; id: string} ) { // params包含type和id两个属性 }4.2 请求头信息获取获取请求头信息同样简单Get(profile) getProfile(Headers(authorization) token: string) { // 获取Authorization头 }或者获取全部请求头Get(profile) getProfile(Headers() headers: Recordstring, string) { // headers对象包含所有请求头 }在实际项目中我常用这种方式获取客户端信息、认证token等。比如移动端API可能需要区分iOS和AndroidGet(version) checkVersion(Headers(user-agent) ua: string) { if (ua.includes(Android)) { // 返回Android专用逻辑 } // ... }5. 响应状态码与高级技巧控制响应状态码是API开发的重要环节NestJS提供了多种方式来实现。5.1 使用HttpCode设置状态码最简单的设置状态码的方式Post(create) HttpCode(201) // 设置创建成功的状态码 createUser(Body() createUserDto: CreateUserDto) { // ... }5.2 动态状态码处理有时我们需要根据业务逻辑动态返回状态码。这时可以注入Res()装饰器Post(login) async login(Body() loginDto: LoginDto, Res() res) { const user await this.authService.validateUser(loginDto) if (!user) { return res.status(401).json({message: 认证失败}) } return res.status(200).json(user) }不过要注意使用Res()后会接管整个响应对象NestJS的许多响应拦截特性将失效。所以除非必要我建议尽量使用HttpCode()。5.3 自定义装饰器实战当标准装饰器不能满足需求时我们可以创建自定义装饰器。比如实现一个获取客户端IP的装饰器import { createParamDecorator } from nestjs/common export const ClientIp createParamDecorator((data, ctx) { const request ctx.switchToHttp().getRequest() return request.headers[x-forwarded-for] || request.connection.remoteAddress }) // 使用 Get(ip) getIp(ClientIp() ip: string) { console.log(客户端IP: ${ip}) }这个技巧在我做风控系统时特别有用可以轻松获取各种客户端信息。自定义装饰器的可能性几乎是无限的你可以根据业务需求创造各种便利工具。6. 综合实战用户管理API开发现在我们把所有知识综合起来开发一个完整的用户管理API。这个例子来自我的真实项目经验包含了最常见的API开发场景。6.1 用户CRUD接口实现Controller(users) export class UsersController { constructor(private readonly usersService: UsersService) {} Get() HttpCode(200) async listUsers(Query() query: PaginationDto) { return this.usersService.findAll(query) } Post() HttpCode(201) async createUser(Body() createUserDto: CreateUserDto) { return this.usersService.create(createUserDto) } Get(:id) HttpCode(200) async getUser(Param(id) id: string) { return this.usersService.findOne(id) } Patch(:id) HttpCode(200) async updateUser( Param(id) id: string, Body() updateUserDto: UpdateUserDto ) { return this.usersService.update(id, updateUserDto) } Delete(:id) HttpCode(204) async deleteUser(Param(id) id: string) { return this.usersService.remove(id) } }6.2 复杂查询接口示例实际项目中经常需要实现复杂查询比如带过滤、排序和分页的用户列表class UserListQueryDto { IsOptional() IsString() name?: string IsOptional() IsInt() Min(1) page?: number 1 IsOptional() IsIn([ASC, DESC]) order?: ASC | DESC DESC } Get(complex-list) async complexList(Query() query: UserListQueryDto) { // 实际项目中这里通常会调用service方法 return { data: [], pagination: { page: query.page, total: 100 } } }这个例子展示了如何通过组合多个装饰器和DTO构建出既健壮又易用的API接口。在我的实践中这种模式极大地提高了代码的可维护性和开发效率。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2609919.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

SpringBoot-17-MyBatis动态SQL标签之常用标签

文章目录 1 代码1.1 实体User.java1.2 接口UserMapper.java1.3 映射UserMapper.xml1.3.1 标签if1.3.2 标签if和where1.3.3 标签choose和when和otherwise1.4 UserController.java2 常用动态SQL标签2.1 标签set2.1.1 UserMapper.java2.1.2 UserMapper.xml2.1.3 UserController.ja…

wordpress后台更新后 前端没变化的解决方法

使用siteground主机的wordpress网站,会出现更新了网站内容和修改了php模板文件、js文件、css文件、图片文件后,网站没有变化的情况。 不熟悉siteground主机的新手,遇到这个问题,就很抓狂,明明是哪都没操作错误&#x…

网络编程(Modbus进阶)

思维导图 Modbus RTU(先学一点理论) 概念 Modbus RTU 是工业自动化领域 最广泛应用的串行通信协议,由 Modicon 公司(现施耐德电气)于 1979 年推出。它以 高效率、强健性、易实现的特点成为工业控制系统的通信标准。 包…

UE5 学习系列(二)用户操作界面及介绍

这篇博客是 UE5 学习系列博客的第二篇,在第一篇的基础上展开这篇内容。博客参考的 B 站视频资料和第一篇的链接如下: 【Note】:如果你已经完成安装等操作,可以只执行第一篇博客中 2. 新建一个空白游戏项目 章节操作,重…

IDEA运行Tomcat出现乱码问题解决汇总

最近正值期末周,有很多同学在写期末Java web作业时,运行tomcat出现乱码问题,经过多次解决与研究,我做了如下整理: 原因: IDEA本身编码与tomcat的编码与Windows编码不同导致,Windows 系统控制台…

利用最小二乘法找圆心和半径

#include <iostream> #include <vector> #include <cmath> #include <Eigen/Dense> // 需安装Eigen库用于矩阵运算 // 定义点结构 struct Point { double x, y; Point(double x_, double y_) : x(x_), y(y_) {} }; // 最小二乘法求圆心和半径 …

使用docker在3台服务器上搭建基于redis 6.x的一主两从三台均是哨兵模式

一、环境及版本说明 如果服务器已经安装了docker,则忽略此步骤,如果没有安装,则可以按照一下方式安装: 1. 在线安装(有互联网环境): 请看我这篇文章 传送阵>> 点我查看 2. 离线安装(内网环境):请看我这篇文章 传送阵>> 点我查看 说明&#xff1a;假设每台服务器已…

XML Group端口详解

在XML数据映射过程中&#xff0c;经常需要对数据进行分组聚合操作。例如&#xff0c;当处理包含多个物料明细的XML文件时&#xff0c;可能需要将相同物料号的明细归为一组&#xff0c;或对相同物料号的数量进行求和计算。传统实现方式通常需要编写脚本代码&#xff0c;增加了开…

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器的上位机配置操作说明

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器专为工业环境精心打造&#xff0c;完美适配AGV和无人叉车。同时&#xff0c;集成以太网与语音合成技术&#xff0c;为各类高级系统&#xff08;如MES、调度系统、库位管理、立库等&#xff09;提供高效便捷的语音交互体验。 L…

(LeetCode 每日一题) 3442. 奇偶频次间的最大差值 I (哈希、字符串)

题目&#xff1a;3442. 奇偶频次间的最大差值 I 思路 &#xff1a;哈希&#xff0c;时间复杂度0(n)。 用哈希表来记录每个字符串中字符的分布情况&#xff0c;哈希表这里用数组即可实现。 C版本&#xff1a; class Solution { public:int maxDifference(string s) {int a[26]…

【大模型RAG】拍照搜题技术架构速览:三层管道、两级检索、兜底大模型

摘要 拍照搜题系统采用“三层管道&#xff08;多模态 OCR → 语义检索 → 答案渲染&#xff09;、两级检索&#xff08;倒排 BM25 向量 HNSW&#xff09;并以大语言模型兜底”的整体框架&#xff1a; 多模态 OCR 层 将题目图片经过超分、去噪、倾斜校正后&#xff0c;分别用…

【Axure高保真原型】引导弹窗

今天和大家中分享引导弹窗的原型模板&#xff0c;载入页面后&#xff0c;会显示引导弹窗&#xff0c;适用于引导用户使用页面&#xff0c;点击完成后&#xff0c;会显示下一个引导弹窗&#xff0c;直至最后一个引导弹窗完成后进入首页。具体效果可以点击下方视频观看或打开下方…

接口测试中缓存处理策略

在接口测试中&#xff0c;缓存处理策略是一个关键环节&#xff0c;直接影响测试结果的准确性和可靠性。合理的缓存处理策略能够确保测试环境的一致性&#xff0c;避免因缓存数据导致的测试偏差。以下是接口测试中常见的缓存处理策略及其详细说明&#xff1a; 一、缓存处理的核…

龙虎榜——20250610

上证指数放量收阴线&#xff0c;个股多数下跌&#xff0c;盘中受消息影响大幅波动。 深证指数放量收阴线形成顶分型&#xff0c;指数短线有调整的需求&#xff0c;大概需要一两天。 2025年6月10日龙虎榜行业方向分析 1. 金融科技 代表标的&#xff1a;御银股份、雄帝科技 驱动…

观成科技:隐蔽隧道工具Ligolo-ng加密流量分析

1.工具介绍 Ligolo-ng是一款由go编写的高效隧道工具&#xff0c;该工具基于TUN接口实现其功能&#xff0c;利用反向TCP/TLS连接建立一条隐蔽的通信信道&#xff0c;支持使用Let’s Encrypt自动生成证书。Ligolo-ng的通信隐蔽性体现在其支持多种连接方式&#xff0c;适应复杂网…

铭豹扩展坞 USB转网口 突然无法识别解决方法

当 USB 转网口扩展坞在一台笔记本上无法识别,但在其他电脑上正常工作时,问题通常出在笔记本自身或其与扩展坞的兼容性上。以下是系统化的定位思路和排查步骤,帮助你快速找到故障原因: 背景: 一个M-pard(铭豹)扩展坞的网卡突然无法识别了,扩展出来的三个USB接口正常。…

未来机器人的大脑:如何用神经网络模拟器实现更智能的决策?

编辑&#xff1a;陈萍萍的公主一点人工一点智能 未来机器人的大脑&#xff1a;如何用神经网络模拟器实现更智能的决策&#xff1f;RWM通过双自回归机制有效解决了复合误差、部分可观测性和随机动力学等关键挑战&#xff0c;在不依赖领域特定归纳偏见的条件下实现了卓越的预测准…

Linux应用开发之网络套接字编程(实例篇)

服务端与客户端单连接 服务端代码 #include <sys/socket.h> #include <sys/types.h> #include <netinet/in.h> #include <stdio.h> #include <stdlib.h> #include <string.h> #include <arpa/inet.h> #include <pthread.h> …

华为云AI开发平台ModelArts

华为云ModelArts&#xff1a;重塑AI开发流程的“智能引擎”与“创新加速器”&#xff01; 在人工智能浪潮席卷全球的2025年&#xff0c;企业拥抱AI的意愿空前高涨&#xff0c;但技术门槛高、流程复杂、资源投入巨大的现实&#xff0c;却让许多创新构想止步于实验室。数据科学家…

深度学习在微纳光子学中的应用

深度学习在微纳光子学中的主要应用方向 深度学习与微纳光子学的结合主要集中在以下几个方向&#xff1a; 逆向设计 通过神经网络快速预测微纳结构的光学响应&#xff0c;替代传统耗时的数值模拟方法。例如设计超表面、光子晶体等结构。 特征提取与优化 从复杂的光学数据中自…