nestjs的拦截器 —— 面向切面编程(AOP)

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: nestjs的拦截器 —— 面向切面编程(AOP)

什么是AOP

AOP (Aspect-Oriented Programming) 是一种编程范式,它旨在通过将横切关注点(cross-cut concern)从主要业务逻辑中分离出来,以提高代码的可维护性和可重用性。


后端的架构基本都是MVC风格,一个请求过来可能会经过controller(控制器)、service(服务)、repository(数据库访问)的逻辑


image.png


在 AOP 中,横切关注点是指那些在一个应用程序中跨越多个模块或层的功能,例如日志记录、事务管理、安全性、异常处理等。这些关注点通常不能直接归类到单个模块或类中,而是散布在整个应用程序中。


AOP 使用装饰器、拦截器、代理等技术来实现横切关注点的分离和重用。通过 AOP,可以将与关注点相关的代码抽象成一个或多个横切面(aspects),它们可以在应用程序中的不同位置进行织入(weave),插入到目标代码中。


image.png


什么是拦截器

在 Nest.js 中,拦截器(Interceptors)是一种可用于在处理请求之前、之后或处理过程中干预和转换数据的强大机制。它们允许你在执行路由处理程序之前和之后,以及在异常抛出时对请求和响应对象进行操作。拦截器有以下几种作用


日志记录: 拦截器可以用于记录请求和响应数据,以便跟踪应用程序的活动、调试问题或分析性能。


验证和转换数据: 通过拦截器,你可以验证请求的有效性,转换请求数据或响应数据的格式,以适应特定的需求。


权限控制: 拦截器可以用于检查用户的权限、角色或其他访问控制要求,以确保只有有权限的用户可以访问特定的路由或资源。


异常处理: 拦截器可以用于捕获和处理异常,通过统一处理异常情况,你可以避免重复的错误处理逻辑,并提供一致的错误响应。


缓存: 拦截器可以用于实现缓存机制,将某些请求的响应缓存起来,提高系统的性能和响应时间。


使用拦截器,可以在整个请求-响应生命周期中执行各种操作,例如:


在请求到达路由处理程序之前,对请求进行预处理或验证。

在路由处理程序执行之前或之后,对请求和响应进行操作。

在异常发生时,捕获并统一处理异常。

基本使用

通过命令,创建一个拦截器,  在nestjs中拦截器依赖于rxjs实现对数据的转换,处理


Interceptor 要实现 Nest Interceptor 接口,实现 intercept 方法,调用 next.handle() 就会调用目标 Controller,可以在之前和之后加入一些处理逻辑。


nest g itc data

image.png


在controller中使用,用法同pipe,guard,也可以全局使用


image.png

image.png


实例应用

接下来让我们通过几个小案例来加深对拦截器的理解


数据转换以及验证

在前后端交互的过程中,很常见的一个应用场景,后端返回的数据的格式,比如返回的json数据外面再包一层data,当然,这个要看个人和公司开发习惯,这样我们可以用拦截器对响应后的数据进行处理


通过rxjs中的pipe对响应后的数据进行处理


image.png


当我们发起一个post请求来获取请求体时,就可以看到如下 包裹的数据格式

image.png

因为拦截器有context,我们可以获取上下文,因此可以对请求的数据进行拦截,验证


image.png


我们对请求前的密码进行检验


image.png


打印日志

我们首先从 中获取请求对象,并提取出请求的方法和 URL,并打印请求接收的日志。然后,调用 方法获取被拦截路由处理后的结果,并通过 操作符添加一个回调函数。在回调函数中,我们打印响应发送的日志。


image.png


image.png

总结

通过使用拦截器,你可以对请求和响应进行统一的处理和干预,从而实现更高级的功能,例如日志记录、验证、权限控制等,同时提高代码的可重用性和模块化。


拦截器用法和guard,pipe类似,所以学习成本不高,容易理解,拦截器主要依赖于rxjs,有很多方法这里拓展不到,如果想了解更多,希望去看看rxjs,  最后,希望对大家有帮助!

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
2天前
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
AOP(面向切面编程)能够帮助我们在不修改现有代码的前提下,为应用程序添加新的功能或行为。Micronaut框架中的AOP模块通过动态代理机制实现了这一目标。AOP将横切关注点(如日志记录、事务管理等)从业务逻辑中分离出来,提高模块化程度。在Micronaut中,带有特定注解的类会在启动时生成代理对象,在运行时拦截方法调用并执行额外逻辑。例如,可以通过创建切面类并在目标类上添加注解来记录方法调用信息,从而在不侵入原有代码的情况下增强应用功能,提高代码的可维护性和可扩展性。
12 1
|
12天前
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
【9月更文挑战第9天】AOP(面向切面编程)通过分离横切关注点提高模块化程度,如日志记录、事务管理等。Micronaut AOP基于动态代理机制,在应用启动时为带有特定注解的类生成代理对象,实现在运行时拦截方法调用并执行额外逻辑。通过简单示例展示了如何在不修改 `CalculatorService` 类的情况下记录 `add` 方法的参数和结果,仅需添加 `@Loggable` 注解即可。这不仅提高了代码的可维护性和可扩展性,还降低了引入新错误的风险。
33 13
|
1月前
|
XML Java 数据格式
Spring5入门到实战------11、使用XML方式实现AOP切面编程。具体代码+讲解
这篇文章是Spring5框架的AOP切面编程教程,通过XML配置方式,详细讲解了如何创建被增强类和增强类,如何在Spring配置文件中定义切入点和切面,以及如何将增强逻辑应用到具体方法上。文章通过具体的代码示例和测试结果,展示了使用XML配置实现AOP的过程,并强调了虽然注解开发更为便捷,但掌握XML配置也是非常重要的。
Spring5入门到实战------11、使用XML方式实现AOP切面编程。具体代码+讲解
|
20天前
|
Java Spring XML
掌握面向切面编程的秘密武器:Spring AOP 让你的代码优雅转身,横切关注点再也不是难题!
【8月更文挑战第31天】面向切面编程(AOP)通过切面封装横切关注点,如日志记录、事务管理等,使业务逻辑更清晰。Spring AOP提供强大工具,无需在业务代码中硬编码这些功能。本文将深入探讨Spring AOP的概念、工作原理及实际应用,展示如何通过基于注解的配置创建切面,优化代码结构并提高可维护性。通过示例说明如何定义切面类、通知方法及其应用时机,实现方法调用前后的日志记录,展示AOP在分离关注点和添加新功能方面的优势。
30 0
|
29天前
|
监控 安全 数据库
面向方面编程(AOP)的概念
【8月更文挑战第22天】
43 0
|
2月前
|
Java Spring 容器
Spring问题之Spring AOP是如何实现面向切面编程的
Spring问题之Spring AOP是如何实现面向切面编程的
|
1月前
|
XML Java 数据库
Spring5入门到实战------10、操作术语解释--Aspectj注解开发实例。AOP切面编程的实际应用
这篇文章是Spring5框架的实战教程,详细解释了AOP的关键术语,包括连接点、切入点、通知、切面,并展示了如何使用AspectJ注解来开发AOP实例,包括切入点表达式的编写、增强方法的配置、代理对象的创建和优先级设置,以及如何通过注解方式实现完全的AOP配置。
|
2月前
|
监控 安全 Java
Java中的AOP编程实践与应用场景
Java中的AOP编程实践与应用场景
|
2月前
|
安全 Java C++
Java中的AOP编程详解
Java中的AOP编程详解
|
3月前
|
Java Maven 数据安全/隐私保护
详解 Java AOP:面向方面编程的核心概念与 Spring 实现
详解 Java AOP:面向方面编程的核心概念与 Spring 实现
62 1