Spring Cloud实战 | 第十一篇:Spring Cloud Gateway网关实现对RESTful接口权限和按钮权限细粒度控制

简介: Spring Cloud实战 | 第十一篇:Spring Cloud Gateway网关实现对RESTful接口权限和按钮权限细粒度控制

一. 前言

hi,大家好,这应该是农历年前的关于开源项目有来商城 的最后一篇文章了。


有来商城 是基于 Spring Cloud OAuth2 + Spring Cloud Gateway + JWT实现的统一认证鉴权,Spring Cloud & Alibaba + vue-element-admin实现的微服务、前后端分离的全栈开源项目。


有来商城 的权限设计主要是为了实现以下几点目标:


实现RBAC模式的权限管理设计


实现基于vue-element-admin后台菜单权限管理系统


Spring Cloud Gateway网关针对RESTful接口权限控制


Vue自定义指令实现按钮级别权限控制


二. 项目介绍

1. 项目简介

有来商城 是基于Spring Boot 2.4、Spring Cloud 2020 & Alibaba、Vue、element-ui、uni-app快速构建的一套全栈开源商城平台,包括微服务应用、管理平台、微信小程序及APP应用。


2. 项目地址

项目预览地址: http://www.youlai.store


微信小程序体验码:


源码地址:


项目名称       Github                   码云

微服务后台 youlai-mall       youlai-mall

管理前端   youlai-mall-admin youlai-mall-admin

微信小程序 youlai-mall-weapp youlai-mall-weapp

APP应用          youlai-mall-app youlai-mall-app

3. 项目往期文章

后台微服务


Spring Cloud实战 | 第一篇:Windows搭建Nacos服务

Spring Cloud实战 | 第二篇:Spring Cloud整合Nacos实现注册中心

Spring Cloud实战 | 第三篇:Spring Cloud整合Nacos实现配置中心

Spring Cloud实战 | 第四篇:Spring Cloud整合Gateway实现API网关

Spring Cloud实战 | 第五篇:Spring Cloud整合OpenFeign实现微服务之间的调用

Spring Cloud实战 | 第六篇:Spring Cloud Gateway+Spring Security OAuth2+JWT实现微服务统一认证授权

Spring Cloud实战 | 最七篇:Spring Cloud Gateway+Spring Security OAuth2集成统一认证授权平台下实现注销使JWT失效方案

Spring Cloud实战 | 最八篇:Spring Cloud +Spring Security OAuth2+ Vue前后端分离模式下无感知刷新实现JWT续期

Spring Cloud实战 | 最九篇:Spring Security OAuth2认证服务器统一认证自定义异常处理

Spring Cloud实战 | 第十篇 :Spring Cloud + Nacos整合Seata 1.4.1最新版本实现微服务架构中的分布式事务,进阶之路必须要迈过的槛

后台管理前端


vue-element-admin实战 | 第一篇: 移除mock接入微服务接口,搭建SpringCloud+Vue前后端分离管理平台

vue-element-admin实战 | 第二篇: 最小改动接入后台实现根据权限动态加载菜单

微信小程序


vue+uni-app商城实战 | 第一篇:从0到1快速开发一个商城微信小程序,无缝接入Spring Cloud OAuth2认证授权登录

应用部署


Docker实战 | 第一篇:Linux 安装 Docker

Docker实战 | 第二篇:Docker部署nacos-server:1.4.0

Docker实战 | 第三篇:IDEA集成Docker插件实现一键自动打包部署微服务项目,一劳永逸的技术手段值得一试

Docker实战 | 第四篇:Docker安装Nginx,实现基于vue-element-admin框架构建的项目线上部署

Docker实战 | 第五篇:Docker启用TLS加密解决暴露2375端口引发的安全漏洞,被黑掉三台云主机的教训总结

三. 数据库设计

RBAC(Role-Based Access Control)基于角色访问控制,目前使用最为广泛的权限模型。


此模型有三个角色用户、角色和权限,在传统的权限模型用户直接关联加了角色层,解耦了用户和权限,使得权限系统有了更清晰的职责划分和更高的灵活度。


以下是有来系统关于RBAC权限模型的数据库


微信图片_20230709231706.png


用户和角色关系不用过多说明,这里重点说下权限,首先系统的权限分为3类,具体如下表:

权限名称

表名

字段

权限标识

菜单权限

sys_menu



接口权限

sys_permission

type=1

PUT_/users/**

按钮权限

sys_permission

type=2

system:user:add

权限名称 表名 字段 权限标识

菜单权限 sys_menu  

接口权限 sys_permission type=1 权限标识

按钮权限 sys_permission type=2 权限标识

其实了解过目前主流开源系统的权限设计,大概率的把菜单和按钮放一块然后根据类别字段区分,以下就关于这种方式优劣发表下个人意见,仅供大家参考下不必较真:


优势:


理论上合理,按钮肯定属于某个菜单之下

省去了权限表(sys_permission)和关联中间表这两张表

劣势:


菜单模块变的复杂了,菜单表多了和菜单无关联的类型字段和权限标识字段

菜单和按钮查询要区分类型,给代码开发带来复杂和影响查询性能

不能同时满足按钮权限控制和网关根据请求路径Ant匹配鉴权(具体下文说)

四. 权限管理系统

先看下vue-element-admin下的RBAC模型下的后台权限管理界面,体验地址:http://www.youlai.store


菜单权限管理

微信图片_20230709231720.png


角色分配权限

微信图片_20230709231723.png


五. RESTful接口权限控制

1. 接口和按钮的权限标识的区别

上文说到的关于权限表的拆分,菜单单独一张表,按钮权限和接口权限合为一张表根据类型type字段区分,之所以这样因为接口和按钮权限有些共性,都有一个权限标识字段。


至于按钮和接口为什么要区分呢?都使用system:user:add权限标识不可以吗?


具体做法是接口方法加上Spring Security的注解@PreAuthorize(“hasPermission(‘system:user:add’)”),在执行方法前判断用户时候拥有该权限。


答案是一般场景这样设计绝对没问题。但这里使用网关作为统一鉴权的入口,肯定希望网关一次性把鉴权的活做的干脆利落,这样就不需要在各个微服务单独的把Spring Security权限模块引入鉴权,通过网关鉴权能把职责分工明确,减少开发工作量,无权限的请求直接被网关拦截返回,不会走到微服务那里再被告知无权访问,提高请求效率。


Spring Cloud Gateway网关使用请求路径Ant匹配请求标识进行权限判断的,例如/users/1经过Ant匹配到权限标识/users/**,而/users/**是被用户所持有的权限标识,这就标识用户允许访问/users/1的请求,所以和按钮的权限标识system:user:add是有区别的。


这样就完事了吗?当然还没,因为 有来系统 较于其他系统它是比较严格遵守REST接口设计规范,所以如果仅仅是上面根据请求路径URL判断权限肯定是不合理的,/users/1这个请求路径在RESTful接口下可能是GET类型的请求也有可能是PUT类型的请求,那该如何处理?


所以在sys_permission表里还有一个method字段来标识请求方法类型,值可能会是*、GET、POST、PUT、PATCH、DELETE等HTTP请求方法类型,其中*是不限请求方法类型的意思,然后将请求方法类型和请求路径组合得到接口的权限标识是这样的PUT_users/1。


接下来就通过对 有来系统 的实战操作来演示网关如何细粒度对RESTful接口的权限控制。


2. 添加权限

新增用户管理的增删改查权限

微信图片_20230709231743.png



3. 角色授权

赋予系统管理员(admin)用户查询权限,无其他权限


微信图片_20230709231748.png

微信图片_20230709231751.png



4. 加载角色权限规则数据至缓存

项目启动查看Redis中的角色权限规则:


微信图片_20230709231754.png


看到系统管理员这个角色是没有用户修改权限的。你可以给角色添加用户修改权限后尝试是否可以修改成功。


5. 接口权限控制演示

admin系统管理员登录执行一个用户修改的提交的请求,看一下网关鉴权的流程:

微信图片_20230709231756.png



结果可想而知,系统管理员不具有修改用户PUT_/youlai-admin/v1/users/2权限,从缓存查询只有超级管理员具有该接口请求方法访问权限。页面结果显示如下:

微信图片_20230709231837.png



六. 按钮权限控制

1. 什么是Vue自定义指令?

Vue除了核心功能默认内置的指令 (v-model 和 v-show),Vue 也允许注册自定义指令。


这里主要使用Vue.directive注册一个全局自定义指令v-has- permission用于权限判断,然后在模板中的任何元素使用v-has- permission属性。


自定义指令学习传送门


2. 添加按钮权限


微信图片_20230709231847.png

3. 角色授权

微信图片_20230709231849.png


4. 加载角色按钮权限数据

完整代码:youlai-mall-admin


登录成功时获取用户信息,其中包含该用户拥有的权限字符串集合如下:

微信图片_20230709231852.png



这里将用户权限拥有的字符串集合缓存到vuex的perms属性中:

微信图片_20230709231854.png



5. 自定义和注册全局指令

有来管理前端 是基于vue-element-admin后台前端解决方案,在vue-element-admin项目我们可以看到自定义指令的应用。如下:

微信图片_20230709231930.png



然后复制一份permission.js重命名为hasPermission.js,修改后如下:


import store from '@/store'


// 校验用户是否拥有按钮权限


function hasPermission(el, binding) {

 const {value} = binding

 const perms = store.getters && store.getters.perms

 if (value && value instanceof Array) {

   if (value.length > 0) {

     const requiredPerms = value

     const hasPermission = perms.some(perm => {

       return requiredPerms.includes(perm)

     })

     if (!hasPermission) {

       el.parentNode && el.parentNode.removeChild(el)

     }

   }

 } else {

   throw new Error(`need perms! Like v-has-permission="['system:user:add','system:user:edit']"`)

 }

}


export default {

 inserted(el, binding) {

   hasPermission(el,binding)

 },

 update(el, binding) {

   hasPermission(el,binding)

 }

}


注册hasPermission至全局指令:


微信图片_20230709231933.png微信图片_20230709231936.png




指令在组件上的应用:

微信图片_20230709232001.png



6. 按钮权限控制演示

系统管理员是没有修改按钮的权限的,结果如下页面不显示修改按钮。

微信图片_20230709232004.png



那给系统管理员添加修改按钮的权限,再看看用户页面的显示情况


微信图片_20230709232023.png微信图片_20230709232025.png




此时用户页面的修改按钮已经显示出来了,至此完成了系统的按钮权限控制。


七. 结语

本篇通过实战的方式讲述如何基于Spring Cloud Gateway + vue-element-admin技术设计一套符合RBAC规范的权限管理系统,通过网关就可以轻易实现RESTful接口方法细粒度的控制,无需将Spring Security模块引入各个微服务;以及使用Vue的自定义指令在组件中使用实现细粒度的按钮权限控制。


如果你对此系统权限设计有更好的建议,欢迎留言给我,在此感谢!如果对项目感兴趣的话,欢迎加我微信和项目交流群。


相关文章
|
1月前
|
XML Java 数据格式
如何使用 Spring Cloud 实现网关
如何使用 Spring Cloud 实现网关
34 3
|
2月前
|
负载均衡 Java Nacos
SpringCloud基础2——Nacos配置、Feign、Gateway
nacos配置管理、Feign远程调用、Gateway服务网关
SpringCloud基础2——Nacos配置、Feign、Gateway
|
2月前
|
Java 开发者 Spring
Spring Cloud Gateway 中,过滤器的分类有哪些?
Spring Cloud Gateway 中,过滤器的分类有哪些?
52 3
|
2月前
|
负载均衡 Java 网络架构
实现微服务网关:Zuul与Spring Cloud Gateway的比较分析
实现微服务网关:Zuul与Spring Cloud Gateway的比较分析
106 5
|
2月前
|
安全 API 开发者
Web 开发新风尚!Python RESTful API 设计与实现,让你的接口更懂开发者心!
在当前的Web开发中,Python因能构建高效简洁的RESTful API而备受青睐,大大提升了开发效率和用户体验。本文将介绍RESTful API的基本原则及其在Python中的实现方法。以Flask为例,演示了如何通过不同的HTTP方法(如GET、POST、PUT、DELETE)来创建、读取、更新和删除用户信息。此示例还包括了基本的路由设置及操作,为开发者提供了清晰的API交互指南。
109 6
|
1月前
|
负载均衡 Java API
【Spring Cloud生态】Spring Cloud Gateway基本配置
【Spring Cloud生态】Spring Cloud Gateway基本配置
37 0
|
2月前
|
安全 Java 开发者
强大!Spring Cloud Gateway新特性及高级开发技巧
在微服务架构日益盛行的今天,网关作为微服务架构中的关键组件,承担着路由、安全、监控、限流等多重职责。Spring Cloud Gateway作为新一代的微服务网关,凭借其基于Spring Framework 5、Project Reactor和Spring Boot 2.0的强大技术栈,正逐步成为业界的主流选择。本文将深入探讨Spring Cloud Gateway的新特性及高级开发技巧,助力开发者更好地掌握这一强大的网关工具。
230 6
|
3月前
|
XML JSON API
RESTful API设计最佳实践:构建高效、可扩展的接口
【8月更文挑战第17天】RESTful API设计是一个涉及多方面因素的复杂过程。通过遵循上述最佳实践,开发者可以构建出更加高效、可扩展、易于维护的API。然而,值得注意的是,最佳实践并非一成不变,随着技术的发展和业务需求的变化,可能需要不断调整和优化API设计。因此,保持对新技术和最佳实践的关注,是成为一名优秀API设计师的关键。
|
4月前
|
负载均衡 Java Spring
Spring cloud gateway 如何在路由时进行负载均衡
Spring cloud gateway 如何在路由时进行负载均衡
505 15
|
4月前
|
Java Spring
spring cloud gateway在使用 zookeeper 注册中心时,配置https 进行服务转发
spring cloud gateway在使用 zookeeper 注册中心时,配置https 进行服务转发
112 3