NestJS中的守卫-常用于实现授权的Guard

介绍守卫

守卫有单一的责任。它们根据运行时存在的某些条件(如权限、角色、ACL 等)确定给定请求是否将由路由处理程序处理。这通常称为授权。授权(及其通常与之合作的身份验证)通常由传统 Express 应用中的 中间件 处理。中间件是身份验证的不错选择,因为诸如令牌验证和将属性附加到 request 对象之类的事情与特定路由上下文(及其元数据)没有紧密联系。

在Express开发中,我们会使用中间件的方式来实现鉴权。举个例子,在Express应用中,我们会开发一个叫做auth.middleware的文件,并且让每一个进入的http请求都走一遍这个中间件。 在这个中间件中,我们会实现鉴权操作。比如token是否过期、丢失等情况,如果鉴权成功,就可以继续下一步操作。

而在NestJS开发中,由于守卫的出现,我们不再使用中间件的方式, 因为我们觉得这两个是马牛不相及的,所以我们会放在守卫中执行,因为守卫是可以全局的。

配置守卫

当你使用了nest/cli创建项目的时候,可以使用下面的指令创建守卫

javascript 复制代码
 nest g guard guards/auth

由于该守卫的作用是校验token的,所以就称之为auth,且创建之后的地址为src/guards/auth

守卫是一个用 @Injectable() 装饰器注释的类,它实现了 CanActivate 接口。

初始化的文件内容如下

javascript 复制代码
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
import { Observable } from 'rxjs';
​
@Injectable()
export class AuthGuard implements CanActivate {
  canActivate(
    context: ExecutionContext,
  ): boolean | Promise<boolean> | Observable<boolean> {
    return true;
  }
}

我们的AuthGuard 类实现了CanActivate 接口,在canActivate方法中,我们通过一系列的判断,最终返回ture/false,来决定是否继续下一步操作​。 下面的代码,获取到了请求,并且将路径打印出来。

javascript 复制代码
  const request = context.switchToHttp().getRequest();
    console.log('request==================>');
    console.log(request.url);
    //return true means continue
    return true;

绑定守卫​

与管道和异常过滤器一样,守卫可以是控制器范围、方法范围或全局作用域。

守卫的作用域可以作用在全局范围,比如我们所说的鉴权,或者是对某一个特定的控制类或者是控制类的方法中做判断,由于守卫的权限比较高,即

守卫在所有中间件之后、任何拦截器或管道之前执行。​

所以我们可以在该守卫中做一些对请求的预先处理,比如解析token,判断是否过期等。

绑定守卫使用的是@UseGuards()方法。​

下面的例子中,在全局绑定了一个守卫。

javascript 复制代码
async function bootstrap() {
  const app = await NestFactory.create<NestExpressApplication>(AppModule);
  app.useGlobalGuards(new AuthGuard());
  //ejs
  app.setBaseViewsDir('views');
  app.setViewEngine('ejs');
​
  await app.listen(3000);
}
bootstrap();
​

此时,对于整个应用下的http请求,都会经过我们的守卫。

但是,很多时候我们并不想将我们的守卫设置在全局,而只是作为某一个控制类的时候,我们可以这么使用它​

javascript 复制代码
@Controller('list')
@UseGuards(new AuthGuard())
export class ListController {}

上述代码表示该守卫只在该控制类中执行。

公众号链接

大佬们好~求关注​

相关推荐
bysking34 分钟前
【前端-组件】定义行分组的表格表单实现-bysking
前端·react.js
王哲晓1 小时前
第三十章 章节练习商品列表组件封装
前端·javascript·vue.js
fg_4111 小时前
无网络安装ionic和运行
前端·npm
理想不理想v1 小时前
‌Vue 3相比Vue 2的主要改进‌?
前端·javascript·vue.js·面试
酷酷的阿云1 小时前
不用ECharts!从0到1徒手撸一个Vue3柱状图
前端·javascript·vue.js
微信:137971205871 小时前
web端手机录音
前端
齐 飞1 小时前
MongoDB笔记01-概念与安装
前端·数据库·笔记·后端·mongodb
神仙别闹1 小时前
基于tensorflow和flask的本地图片库web图片搜索引擎
前端·flask·tensorflow
GIS程序媛—椰子2 小时前
【Vue 全家桶】7、Vue UI组件库(更新中)
前端·vue.js
DogEgg_0012 小时前
前端八股文(一)HTML 持续更新中。。。
前端·html