Apollo Graphql 优雅权限管理

最近一直在写一些graphql方面的东西, 在做项目的过程中会有一些是关于权限管理的部分,于是发现了一个十分优雅的方式来做权限方面的处理.

简而言之, 先讲下需求背景, 该项目是一个商城,商城会有三个角色,分别为ROOT(管理员), MERCHANT(商户)CUSTOMER(用户)

每个角色能够访问和控制的资源显然是不一样的,在过去的项目中,我们可能会使用一些Validator来校验当前请求的用户是否具备相应的权限,而在Graphql这套体系中,我们可以使用Directive 更加声明式地来鉴权

我们先来看个Directive来鉴权的sample

"鉴权指令"
directive @auth(requires: Role = CUSTOMER) on OBJECT | FIELD_DEFINITION


extend type Mutation {
 "用户删除"
  deleteUser(userDeleteInput: UserDeleteInput!): UserActionResult!
    @auth(requires: ROOT)
}

通过上面的@auth(requires: ROOT)我们就可以很轻松地限制仅ROOT权限才可以进行删除用户的行为, 这样就能够很声明式地去做权限管理部分的功能,同时对于开发者而言,也能够很清晰地看到哪个部分的资源需要什么样子的权限才能进行访问

既然我们可以这么优雅地干权限管理这间事情, 那么怎么在Apollo Graphql中实现?

首先我们需要先看下如何实现一个指令相关文档点这里

import { SchemaDirectiveVisitor } from 'graphql-tools';
import { defaultFieldResolver } from 'graphql';
import { Role } from '../status';

// 继承Apollo Graphql提供的SchemaDirectiveVisitor
export class AuthDriective extends SchemaDirectiveVisitor {
 /**
 *   此处便是定义了访问filed的方法
 */
  visitFieldDefinition(field) {
    const { resolve = defaultFieldResolver } = field;
    };
  }
}

我们可以看到在此处可以拿到对应的filed的resolve方法,那只需要将resolve进行改造,在调用resolve之前进行鉴权即可

import { SchemaDirectiveVisitor } from 'graphql-tools';
import { defaultFieldResolver } from 'graphql';
import { Role } from '../status';


export class AuthDriective extends SchemaDirectiveVisitor {
  visitFieldDefinition(field) {
    const { resolve = defaultFieldResolver } = field;
    const { requires } = this.args;
    field.resolve = function resolver(...args) {
      const context = args[2];
      if (!context.currentUser || context.currentUser.role < Role[requires]) {
        throw new Error('账号权限不足');
      }

      return resolve.apply(this, args);
    };
  }
}

在上面的代码中,我们通过this.args可以获取到指令当前的参数,也就是requires
, 然后我们通过重新定义filed.resolve, 在进入业务流程前进行权限校验, context是上下文的意思,通过context, 我们可以知道当前的用户的相关信息,如果校验鉴权失败,就抛出对应的鉴权错误

指令部分的实现先到这里,我们还有一件事情需要处理 将用户信息设置到context中

import { tradeTokenForUser } from '../encode';

export const setGraphqlContext = ({ ctx: { request, session } }) => {
  let authToken = null;
  let currentUser = null;

  try {
   // 获取token
     authToken = request.headers.authorization;
    if (authToken) {
     // 解开token获取当前请求的用户信息
      currentUser = tradeTokenForUser(authToken);
    }
  } catch (e) {
    throw e;
  }

  return {
    authToken,
    currentUser,
  };
};

同时要在 Apollo中注入,还有别忘了 指令

 new ApolloServer({
    context:  setGraphqlContext,
    schemaDirectives: {
      auth: AuthDriective,
    },
})

完成上面的步骤,最后我们还需要在声明下指令

"鉴权指令"
directive @auth(requires: Role = CUSTOMER) on OBJECT | FIELD_DEFINITION

好的,整个Apollo Graphql 到这里就完成了, 后续的话,我在更新一个demo的链接就完美了

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,980评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,178评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,868评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,498评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,492评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,521评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,910评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,569评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,793评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,559评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,639评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,342评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,931评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,904评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,144评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,833评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,350评论 2 342

推荐阅读更多精彩内容