【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。

相关文章

Python异步编程之await与asyncio基本用法详解

Python异步编程之await与asyncio基本用法详解

《Python异步编程之await与asyncio基本用法详解》在Python中,await和asyncio是异步编程的核心工具,用于高效处理I/O密集型任务（如网络请求、文件读写、数据库操作等）,接... 目录一、核心概念二、使用场景三、基本用法1. 定义协程2. 运行协程3. 并发执行多个任务四、关键
阅读更多...
AOP编程的基本概念与idea编辑器的配合体验过程

AOP编程的基本概念与idea编辑器的配合体验过程

《AOP编程的基本概念与idea编辑器的配合体验过程》文章简要介绍了AOP基础概念,包括Before/Around通知、PointCut切入点、Advice通知体、JoinPoint连接点等,说明它们... 目录BeforeAroundAdvise — 通知PointCut — 切入点Acpect — 切面
阅读更多...
Unity新手入门学习殿堂级知识详细讲解（图文）

Unity新手入门学习殿堂级知识详细讲解（图文）

《Unity新手入门学习殿堂级知识详细讲解（图文）》Unity是一款跨平台游戏引擎,支持2D/3D及VR/AR开发,核心功能模块包括图形、音频、物理等,通过可视化编辑器与脚本扩展实现开发,项目结构含A... 目录入门概述什么是 UnityUnity引擎基础认知编辑器核心操作Unity 编辑器项目模式分类工程
阅读更多...
Python学习笔记之getattr和hasattr用法示例详解

Python学习笔记之getattr和hasattr用法示例详解

《Python学习笔记之getattr和hasattr用法示例详解》在Python中,hasattr()、getattr()和setattr()是一组内置函数,用于对对象的属性进行操作和查询,这篇文章... 目录1.getattr用法详解1.1 基本作用1.2 示例1.3 原理2.hasattr用法详解2.
阅读更多...
C#异步编程ConfigureAwait的使用小结

C#异步编程ConfigureAwait的使用小结

《C#异步编程ConfigureAwait的使用小结》本文介绍了异步编程在GUI和服务器端应用的优势,详细的介绍了async和await的关键作用,通过实例解析了在UI线程正确使用await.Conf... 异步编程是并发的一种形式，它有两大好处：对于面向终端用户的GUI程序，提高了响应能力对于服务器端应
阅读更多...
C# async await 异步编程实现机制详解

C# async await 异步编程实现机制详解

《C#asyncawait异步编程实现机制详解》async/await是C#5.0引入的语法糖,它基于**状态机（StateMachine）**模式实现,将异步方法转换为编译器生成的状态机类,本... 目录一、async/await 异步编程实现机制1.1 核心概念1.2 编译器转换过程1.3 关键组件解析
阅读更多...
深入理解Go语言中二维切片的使用

深入理解Go语言中二维切片的使用

《深入理解Go语言中二维切片的使用》本文深入讲解了Go语言中二维切片的概念与应用,用于表示矩阵、表格等二维数据结构,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧... 目录引言二维切片的基本概念定义创建二维切片二维切片的操作访问元素修改元素遍历二维切片二维切片的动态调整追加行动态
阅读更多...
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. 完整代码实
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2