【Nest 学习笔记】AOP切片编程

2024-09-02 05:28
文章标签 切片 学习 笔记 编程 aop nest

本文主要是介绍【Nest 学习笔记】AOP切片编程，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

切片编程 AOP

把通用逻辑抽离出来，通过切面的方式添加到某个地方，可以复用和动态增删切面逻辑。

中间件 Middleware

Middleware 中间件属于全局中间件（Middleware 是 Express 的概念）

常用于对请求接口进行日志记录

// main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { NextFunction, Request, Response } from 'express';async function bootstrap() {const app = await NestFactory.create(AppModule);app.use(function(req: Request, res: Response, next: NextFunction) {console.log('=========== 中间件拦截 ===========')console.log('请求前');// TODO: 请求前的进行切片化处理next(); // 进入具体请求接口中// TODO：请求后的切片化处理console.log('请求后');});await app.listen(3000);
}
bootstrap();

// app.controller.ts
import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';@Controller()
export class AppController {constructor(private readonly appService: AppService) {}@Get()getHello(): string {console.log('getHello')return this.appService.getHello();}
}

在这里插入图片描述

鉴权 Guard

可以用于在调用某个 Controller 之前判断权限，返回 true 或者 false 来决定是否放行

常用于：请求鉴权（登录后，才能进行接口请求）

在这里插入图片描述

生成后的 Guard 文件

在这里插入图片描述

如何使用

1、局部使用 （单条请求）

// app.controller.ts
import { Controller, Get, UseGuards } from '@nestjs/common';
import { AppService } from './app.service';
import { LoginGuard } from './login.guard';@Controller()
export class AppController {constructor(private readonly appService: AppService) {}@Get('getHello')@UseGuards(LoginGuard) // 使用 GuardgetHello(): string {console.log('getHello')return this.appService.getHello();}
}

在这里插入图片描述

在这里插入图片描述

2、全局使用

方式一：在 main.ts 中进行全局使用

// main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { LoginGuard } from './login.guard';async function bootstrap() {const app = await NestFactory.create(AppModule);// * 全局鉴权app.useGlobalGuards(new LoginGuard())await app.listen(3000);
}
bootstrap();

方式二：在 AppModule 中进行全局使用

// app.module.ts
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { APP_GUARD } from '@nestjs/core';
import { LoginGuard } from './login.guard';@Module({imports: [],controllers: [AppController],providers: [AppService,{provide: APP_GUARD,useClass: LoginGuard}],
})
export class AppModule {}

两者的区别：

前者：手动 new 的 Guard 实例，不在 IoC 容器里

后者：用 provider 的方式声明的 Guard 是在 IoC 容器里的，可以注入别的 provider

如：

// login.guard.ts
import { CanActivate, ExecutionContext, Inject, Injectable } from '@nestjs/common';
import { Observable } from 'rxjs';
import { AppService } from './app.service';@Injectable()
export class LoginGuard implements CanActivate {// 注入 AppService  @Inject(AppService)private appService: AppService;canActivate(context: ExecutionContext,): boolean | Promise<boolean> | Observable<boolean> {console.log('登录检查', this.appService.getHello())return false;}
}

在这里插入图片描述

拦截器 Interceptor

在目标 Controller 方法前后加入一些逻辑

在这里插入图片描述

在这里插入图片描述

如何使用

方式一：某条请求

import { Controller, Get, UseGuards, UseInterceptors } from '@nestjs/common';
import { AppService } from './app.service';
import { TimeInterceptor } from './time.interceptor';@Controller()
export class AppController {constructor(private readonly appService: AppService) {}@Get('getNest')@UseInterceptors(TimeInterceptor)getNest():string {return 'getNest'}
}

方式二：作用于单个 Controller 

import { Controller, Get, UseGuards, UseInterceptors } from '@nestjs/common';
import { AppService } from './app.service';
import { TimeInterceptor } from './time.interceptor';@Controller()
@UseInterceptors(TimeInterceptor)
export class AppController {constructor(private readonly appService: AppService) {}@Get('getNest')getNest():string {return 'getNest'}
}

方式三：作用于所有 Controller 

// main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { TimeInterceptor } from './time.interceptor';async function bootstrap() {const app = await NestFactory.create(AppModule);app.useGlobalInterceptors(new TimeInterceptor());await app.listen(3000);
}
bootstrap();

或

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { APP_INTERCEPTOR } from '@nestjs/core';
import { TimeInterceptor } from './time.interceptor';@Module({imports: [],controllers: [AppController],providers: [AppService,{provide: APP_INTERCEPTOR,useClass: TimeInterceptor}],
})
export class AppModule {}

两者区别：在 Guard 已提到

在这里插入图片描述

Middleware 与 Intercepator 的区别：

  • Middleware：只能作用于所有 Controller；Intercepator ：不仅可以作用于所有 Controller，还可以作用于单个 Handler 或 Controller
  • Middleware：拿不到调用的 controller 和 handler；interceptor 可以拿到调用的 controller 和 handler

管道 Pipe

用来对参数做一些检验和转换

在这里插入图片描述

在这里插入图片描述

如何使用

import { Controller, Get, Query, UseGuards, UseInterceptors } from '@nestjs/common';
import { AppService } from './app.service';
import { ValidatePipe } from './validate.pipe';@Controller()
export class AppController {constructor(private readonly appService: AppService) {}@Get('savePhone')savePhone(@Query('phone', ValidatePipe) phone: string) {return phone}
}

在这里插入图片描述

在这里插入图片描述

异常 ExceptionFilter

在这里插入图片描述

在这里插入图片描述

如何使用

import { Controller, Get, Query, UseGuards, UseInterceptors } from '@nestjs/common';
import { AppService } from './app.service';
import { ValidatePipe } from './validate.pipe';
import { TestFilter } from './test.filter';@Controller()
export class AppController {constructor(private readonly appService: AppService) {}@Get('savePhone')@UseFilters(TestFilter)  savePhone(@Query('phone', ValidatePipe) phone: string) {return phone}
}

或

import { Controller, Get, Query, UseGuards, UseInterceptors } from '@nestjs/common';
import { AppService } from './app.service';
import { ValidatePipe } from './validate.pipe';
import { TestFilter } from './test.filter';@Controller()
@UseFilters(TestFilter)  
export class AppController {constructor(private readonly appService: AppService) {}@Get('savePhone')savePhone(@Query('phone', ValidatePipe) phone: string) {return phone}
}

或

import { TestFilter } from './test.filter';
app.useGlobalFilters(new TestFilter())

或

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { APP_FILTER } from '@nestjs/core';
import { TestFilter } from './test.filter';@Module({imports: [],controllers: [AppController],providers: [AppService,{provide: APP_FILTER,useClass: TestFilter}],
})
export class AppModule {}

总结

几种 AOP 编程的调用顺序

  • 会先调用 Guard，判断是否有权限等，如果没有权限，抛出的 ForbiddenException 会被 ExceptionFilter 处理
  • 如果有权限，就会调用到拦截器，拦截器组织了一个链条，一个个的调用，最后会调用的 controller 的方法：
  • 调用 controller 方法之前，会使用 pipe 对参数做处理

这篇关于【Nest 学习笔记】AOP切片编程的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1129111。

相关文章

Go语言数据库编程GORM 的基本使用详解

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁
阅读更多...
Springboot如何正确使用AOP问题

Springboot如何正确使用AOP问题

《Springboot如何正确使用AOP问题》：本文主要介绍Springboot如何正确使用AOP问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录​一、AOP概念二、切点表达式​execution表达式案例三、AOP通知四、springboot中使用AOP导出
阅读更多...
深度解析Spring AOP @Aspect 原理、实战与最佳实践教程

深度解析Spring AOP @Aspect 原理、实战与最佳实践教程

《深度解析SpringAOP@Aspect原理、实战与最佳实践教程》文章系统讲解了SpringAOP核心概念、实现方式及原理,涵盖横切关注点分离、代理机制（JDK/CGLIB）、切入点类型、性能... 目录1. @ASPect 核心概念1.1 AOP 编程范式1.2 @Aspect 关键特性2. 完整代码实
阅读更多...
Go学习记录之runtime包深入解析

Go学习记录之runtime包深入解析

《Go学习记录之runtime包深入解析》Go语言runtime包管理运行时环境,涵盖goroutine调度、内存分配、垃圾回收、类型信息等核心功能,：本文主要介绍Go学习记录之runtime包的... 目录前言：一、runtime包内容学习1、作用：① Goroutine和并发控制：② 垃圾回收：③ 栈和
阅读更多...
Android学习总结之Java和kotlin区别超详细分析

Android学习总结之Java和kotlin区别超详细分析

《Android学习总结之Java和kotlin区别超详细分析》Java和Kotlin都是用于Android开发的编程语言,它们各自具有独特的特点和优势,：本文主要介绍Android学习总结之Ja... 目录一、空安全机制真题 1：Kotlin 如何解决 Java 的 NullPointerExceptio
阅读更多...
重新对Java的类加载器的学习方式

重新对Java的类加载器的学习方式

《重新对Java的类加载器的学习方式》：本文主要介绍重新对Java的类加载器的学习方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、介绍1.1、简介1.2、符号引用和直接引用1、符号引用2、直接引用3、符号转直接的过程2、加载流程3、类加载的分类3.1、显示
阅读更多...
Python 异步编程 asyncio简介及基本用法

Python 异步编程 asyncio简介及基本用法

《Python异步编程asyncio简介及基本用法》asyncio是Python的一个库,用于编写并发代码,使用协程、任务和Futures来处理I/O密集型和高延迟操作,本文给大家介绍Python... 目录1、asyncio是什么IO密集型任务特征2、怎么用1、基本用法2、关键字 async1、async
阅读更多...
SpringBoot中四种AOP实战应用场景及代码实现

SpringBoot中四种AOP实战应用场景及代码实现

《SpringBoot中四种AOP实战应用场景及代码实现》面向切面编程(AOP)是Spring框架的核心功能之一,它通过预编译和运行期动态代理实现程序功能的统一维护,在SpringBoot应用中,AO... 目录引言场景一：日志记录与性能监控业务需求实现方案使用示例扩展：MDC实现请求跟踪场景二：权限控制与
阅读更多...
Java并发编程之如何优雅关闭钩子Shutdown Hook

Java并发编程之如何优雅关闭钩子Shutdown Hook

《Java并发编程之如何优雅关闭钩子ShutdownHook》这篇文章主要为大家详细介绍了Java如何实现优雅关闭钩子ShutdownHook,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起... 目录关闭钩子简介关闭钩子应用场景数据库连接实战演示使用关闭钩子的注意事项开源框架中的关闭钩子机制1.
阅读更多...
Java学习手册之Filter和Listener使用方法

Java学习手册之Filter和Listener使用方法

《Java学习手册之Filter和Listener使用方法》：本文主要介绍Java学习手册之Filter和Listener使用方法的相关资料,Filter是一种拦截器,可以在请求到达Servl... 目录一、Filter（过滤器）1. Filter 的工作原理2. Filter 的配置与使用二、Listen
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2