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

相关文章

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
阅读更多...
shell编程之函数与数组的使用详解

shell编程之函数与数组的使用详解

《shell编程之函数与数组的使用详解》：本文主要介绍shell编程之函数与数组的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录shell函数函数的用法俩个数求和系统资源监控并报警函数函数变量的作用范围函数的参数递归函数shell数组获取数组的长度读取某下的
阅读更多...
利用Python快速搭建Markdown笔记发布系统

利用Python快速搭建Markdown笔记发布系统

《利用Python快速搭建Markdown笔记发布系统》这篇文章主要为大家详细介绍了使用Python生态的成熟工具,在30分钟内搭建一个支持Markdown渲染、分类标签、全文搜索的私有化知识发布系统... 目录引言：为什么要自建知识博客一、技术选型：极简主义开发栈二、系统架构设计三、核心代码实现（分步解析
阅读更多...
揭秘Python Socket网络编程的7种硬核用法

揭秘Python Socket网络编程的7种硬核用法

《揭秘PythonSocket网络编程的7种硬核用法》Socket不仅能做聊天室,还能干一大堆硬核操作,这篇文章就带大家看看Python网络编程的7种超实用玩法,感兴趣的小伙伴可以跟随小编一起... 目录1.端口扫描器：探测开放端口2.简易 HTTP 服务器：10 秒搭个网页3.局域网游戏：多人联机对战4.
阅读更多...
Java并发编程必备之Synchronized关键字深入解析

Java并发编程必备之Synchronized关键字深入解析

《Java并发编程必备之Synchronized关键字深入解析》本文我们深入探索了Java中的Synchronized关键字,包括其互斥性和可重入性的特性,文章详细介绍了Synchronized的三种... 目录一、前言二、Synchronized关键字2.1 Synchronized的特性1. 互斥2.
阅读更多...
Python异步编程中asyncio.gather的并发控制详解

Python异步编程中asyncio.gather的并发控制详解

《Python异步编程中asyncio.gather的并发控制详解》在Python异步编程生态中,asyncio.gather是并发任务调度的核心工具,本文将通过实际场景和代码示例,展示如何结合信号量... 目录一、asyncio.gather的原始行为解析二、信号量控制法：给并发装上"节流阀"三、进阶控制
阅读更多...
Java进阶学习之如何开启远程调式

Java进阶学习之如何开启远程调式

《Java进阶学习之如何开启远程调式》Java开发中的远程调试是一项至关重要的技能,特别是在处理生产环境的问题或者协作开发时,：本文主要介绍Java进阶学习之如何开启远程调式的相关资料,需要的朋友... 目录概述Java远程调试的开启与底层原理开启Java远程调试底层原理JVM参数总结&nbsMbKKXJx
阅读更多...
Spring-AOP-ProceedingJoinPoint的使用详解

Spring-AOP-ProceedingJoinPoint的使用详解

《Spring-AOP-ProceedingJoinPoint的使用详解》：本文主要介绍Spring-AOP-ProceedingJoinPoint的使用方式,具有很好的参考价值,希望对大家有所帮... 目录ProceedingJoinPoijsnt简介获取环绕通知方法的相关信息1.proceed()2.g
阅读更多...
Java深度学习库DJL实现Python的NumPy方式

Java深度学习库DJL实现Python的NumPy方式

《Java深度学习库DJL实现Python的NumPy方式》本文介绍了DJL库的背景和基本功能,包括NDArray的创建、数学运算、数据获取和设置等,同时,还展示了如何使用NDArray进行数据预处理... 目录1 NDArray 的背景介绍1.1 架构2 JavaDJL使用2.1 安装DJL2.2 基本操
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2