一次搞定Nest装饰器

前言


🐔我们正在写Nest的时候会发现我们不论是实现IOC还是AOP的架构又或者声明接口的路由我们使用的都是装饰器,Nest给我们提供了很多装饰器,我们可以使用装饰器来很方便的实现一些功能,这篇文章就一次性搞定Nest中所有的装饰器~

一.@Module


😳@Module用来声明Nest中的模块。

二.@Controller


🤣@Controller装饰器主要用来声明Nest中的controller

三.@Injectable


😳@Injectable表示当前模块是可以被注入的,一般用来声明Service层,并且service会出现在Module中的provider数组中便是这个东西被提供出来了,可供其他模块或者controller注入使用。

四.@Inject


🙈@Inject表示一个注入的动作,我们知道在controller中注入service的时候有两种注入方式,一种是在构造函数中注入,另一种是通过属性@Inject的方式注入的。

五.@Optional


🐻‍❄️@Optional的作用是当在注入的时候提供者并没有提供这个数据按照正常的情况代码是会报错的,但是这个可选装饰器就类似与TS中的可选的操作。

六.@Catch


🐸我们处理异常是使用ExceptionFilter这个方式,当抛出异常的时候我们就进行相应的处理,而@Catch可以处理指定的异常

七.@UseFilters/Use*


🐣当我们使用了上述异常处理的方式之后我们可以将错误处理应用到具体接口上去(handler)然后接口收到请求就会通过TestFilter

🐲除了UseFilters之外其他几个例如UseGuards``UseInterceptors等等都是这么使用的

八.@Query/@Param


😗@Query 是取 url 后的 ?bbb=true,而 @Param 是取路径中的参数,比如 /xxx/111 种的 111

九.@Body


🦝@Body就是如果是POST请求的话就可以通过这个装饰器来取到body中的值,另外除了 @Get、@Post 外,还可以用 @Put、@Delete、@Patch、@Options、@Head 装饰器分别接受 put、delete、patch、options、head 请求:

十.@SetMetadata


🐔handler 和 class 可以通过 @SetMetadata 指定 metadata,然后在 guard 或者 interceptor 里取出来。

十一.@Headers


😳@Headers 装饰器取某个请求头 或者全部请求头。

十二.@Ip


🙈@Ip 拿到请求的 ip

十三.Nest中的全部装饰器


less 复制代码
@Module: 声明 Nest 模块
@Controller:声明模块里的 controller
@Injectable:声明模块里可以注入的 provider
@Inject:通过 token 手动指定注入的 provider,token 可以是 class 或者 string
@Optional:声明注入的 provider 是可选的,可以为空
@Global:声明全局模块
@Catch:声明 exception filter 处理的 exception 类型
@UseFilters:路由级别使用 exception filter
@UsePipes:路由级别使用 pipe
@UseInterceptors:路由级别使用 interceptor
@SetMetadata:在 class 或者 handler 上添加 metadata
@Get、@Post、@Put、@Delete、@Patch、@Options、@Head:声明 get、post、put、delete、patch、options、head 的请求方式
@Param:取出 url 中的参数,比如 /aaa/:id 中的 id
@Query: 取出 query 部分的参数,比如 /aaa?name=xx 中的 name
@Body:取出请求 body,通过 dto class 来接收
@Headers:取出某个或全部请求头
@Session:取出 session 对象,需要启用 express-session 中间件
@HostParm: 取出 host 里的参数
@Req、@Request:注入 request 对象
@Res、@Response:注入 response 对象,一旦注入了这个 Nest 就不会把返回值作为响应了,除非指定 passthrough 为true
@Next:注入调用下一个 handler 的 next 方法
@HttpCode: 修改响应的状态码
@Header:修改响应头
@Redirect:指定重定向的 url
@Render:指定渲染用的模版引擎

十四.总结


🐔Nest中有非常多的装饰器,我们在进行Nest开发的时候会使用的非常的频繁,在一定意义上讲掌握了装饰器就基本掌握了Nest的开发技能~

相关推荐
utmhikari1 天前
【日常随笔】深入回答纯Vibe Coding写后端项目的几个问题
后端·ai编程·vibecoding
尚早立志1 天前
Spring Boot 源码研读之ConfigurableEnvironment 环境准备
java·spring boot·后端
布朗克1681 天前
Go 入门到精通-08-复合类型之数组与切片
开发语言·后端·golang·数组与切片
fliter1 天前
从手写 HTTP/1.1 到拆开 HTTP/2
后端
CaffeinePro1 天前
FastAPI自动接口文档定制与美化、权限管控
后端·fastapi
AI人工智能+电脑小能手1 天前
【大白话说Java面试题 第151题】【06_Spring篇】第11题:说一下 Spring Bean 的生命周期?
java·开发语言·后端·spring·面试
赫媒派1 天前
Gin 12年零破坏API,架构哲学如何练成?
后端·go·gin
fliter1 天前
Arborium:把 tree-sitter 语法高亮打包成 Rust 文档生态的基础设施
后端
张三丰21 天前
不会写代码的高管用Claude Code两天上线新程序,工程师接手后发现:一个Bug,让AI一天烧掉一个月服务器费!
后端
Ai拆代码的曹操1 天前
从一条转账 SQL 到分布式事务:5 种方案的全方位对比与实战
后端