ABP入门系列（9）——权限管理

2024-01-02 01:18
文章标签 入门 管理 系列 权限 abp

本文主要是介绍ABP入门系列（9）——权限管理，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1.引言

完成了简单的增删改查和分页功能，是不是觉得少了点什么？
是的，少了权限管理。既然涉及到了权限，那我们就细化下任务清单的功能点：

  • 登录的用户才能查看任务清单
  • 用户可以无限创建任务并分配给自己，但只能对自己创建的任务进行查找、修改
  • 管理员可以创建任务并分配给他人
  • 管理员具有删除任务的权限

从以上的信息中，我们可以提取出以下权限：

  1. 任务分配权限
  2. 任务删除权限

那我们下面就来实现针对这两个权限的管理：

2. ABP权限管理的实现

2.1. 先来看看权限定义相关类型

权限定义及获取相关类型依赖图

从该类型依赖图中我们可以看出：

  • Permission：权限类，定义了权限的属性。
  • PermissionDictionary：继承自Dictionary<string, Permission>类，存储permission对象的字典。
  • IPermisssionDefinitionContext：定义了CreatePermission和GetPermissionOrNull方法，分别用来创建和获取权限。
  • AuthorizationProvider：抽象类，在Module中实现该接口来定义权限。
  • PermissionManager：权限管理类，继承自PermissionDefinitionContextBase主要提供了获取权限的系列方法。

2.2. 再来看看权限检查相关类型

权限检查相关类型依赖图

从该类型依赖图中简要梳理下核心类：

  • IPermissionChecker：从接口命名就明白，这个是用来进行权限检查的。我们可以自己实现它，也可以使用module-zero中给出的实现。
  • NullPermissionChecker：当未实现IPermissionChecker，系统会默认使用此类将权限赋予给每个用户。
  • AbpAuthorizeAttribute：权限检查特性，在应用服务层标注需要的权限。
  • AbpAllowAnonymousAttribute：匿名访问特性，忽略权限检查，用于应用服务层。在mvc和webapi中使用[AllowAnonymous]。
  • AuthorizationInterceptor：授权拦截器，用来拦截定义了AbpAuthorizeAttribute特性的方法。

核心的几个类就讲到这里，具体的实现，可以自行查看源码一探究竟。

3. 定义权限

从上节中我们知道在不同的Module中通过继承AuthorizationProvider来定义权限。ABP模板项目中已经在领域层，也就是.Core结尾的项目中，定义了xxxxxxAuthorizationProvider类继承自AuthorizationProvider。

3.1. 权限包含哪些属性

  • Name：系统中 唯一的名字。最好为权限的名字定义一个const字符串而不是变量字符串。我们偏向使用“.”符号用于有层次的名字，但这不是强制的。你可以设置任何你喜欢的名字，唯一的一点是保证它必须是唯一的。
  • DisplayName：用于以后在UI上显示权限的本地化字符串。
  • Description：用于以后在UI上显示权限定义的本地化字符串。
  • IsGrantedByDefault：表示该权限是否授予给所有登录的用户，除非该权限显式禁止未授予给用户。该值一般默认为false。
  • MultiTenancySides：对于多租户应用，租户或者租主可以使用同一个权限。这是一个Flags枚举，因此一个权限可以用于租户和租主。
  • featureDependency：可以用于声明一个功能的依赖。因此，只有功能依赖满足了，该权限才会被授予。

3.2. 定义任务分配和任务删除权限

ABP模板项目默认已经在.Core/Authorization/目录下创建了AuthorizationProvider的派生类xxxxAuthorizationProvider.cs
其中代码为：

 

public override void SetPermissions(IPermissionDefinitionContext context)
{//Common permissionsvar pages = context.GetPermissionOrNull(PermissionNames.Pages);if (pages == null)pages = context.CreatePermission(PermissionNames.Pages, L("Pages"));var users = pages.CreateChildPermission(PermissionNames.Pages_Users, L("Users"));//Host permissionsvar tenants = pages.CreateChildPermission(PermissionNames.Pages_Tenants, L("Tenants"),multiTenancySides: MultiTenancySides.Host);
}

可以看出主要添加了三个权限，Pages、Users、Tenants。
依葫芦画瓢，咱们创建一个TaskAuthorizationProvider继承自AuthorizationProvider。
代码如下：

 

public class TaskAuthorizationProvider : AuthorizationProvider
{public override void SetPermissions(IPermissionDefinitionContext context){//Common permissionsvar pages = context.GetPermissionOrNull(PermissionNames.Pages);if (pages == null)pages = context.CreatePermission(PermissionNames.Pages, L("Pages"));//Tasksvar tasks = pages.CreateChildPermission(PermissionNames.Pages_Tasks, L("Tasks"));tasks.CreateChildPermission(PermissionNames.Pages_Tasks_AssignPerson, L("AssignTaskToPerson"));tasks.CreateChildPermission(PermissionNames.Pages_Tasks_Delete, L("DeleteTask"));}private static ILocalizableString L(string name){return new LocalizableString(name, LearningMpaAbpConsts.LocalizationSourceName);}
}

并在常量PermissionNames类中维护唯一用户名。

 

public const string Pages_Tasks = "Pages.Pages.Tasks";public const string Pages_Tasks_AssignPerson = "Pages.Pages.Tasks.AssignPerson";public const string Pages_Tasks_Delete = "Pages.Pages.Tasks.Delete";

需要本地化显示的，则需要分别维护本地化xml文件，这里忽略此步。

3.3. 注册TaskAuthorizationProvider

定位到.Core/xxxCoreModule.cs文件中发现Abp已经注册了默认实现的xxxxAuthorizationProvider.cs。
Configuration.Authorization.Providers.Add<LearningMpaAbpAuthorizationProvider>();
因为ABP是模块化的，当你需要为自己自定义的模块定义权限时，
不要忘记在自己定义的Module中注册自己实现的AuthorizationProvider（授权提供器）。
所以，还是依葫芦画瓢，注册TaskAuthorizationProvider：
Configuration.Authorization.Providers.Add<TaskAuthorizationProvider>();

4. 权限检查

4.1. 使用[AbpAuthorize]特性

在应用服务层中直接使用[AbpAuthorize]特性，但在MVC控制器中使用[AbpMvcAuthorize]特性，Web API控制器中使用[AbpApiAuthorize]。

我们在应用服务层给删除操作定义权限检查：

 

[AbpAuthorize(PermissionNames.Pages_Tasks_Delete)]
public void DeleteTask(int taskId)
{var task = _taskRepository.Get(taskId);if (task != null)_taskRepository.Delete(task);
}

F5运行，去删除某一任务，将获得以下提示：

未授权提示

4.2. 使用IPermissionChecker

删除任务是一个独立的操作，所以我们可以直接使用上面特性声明的方式来进行权限检查。
但是针对【任务分配】这个操作，它其实是任务创建、编辑中的一个子操作。所以我们不能直接使用特性声明的方式来进行权限检查。这一次我们使用IPermissionChecker来进行检查。

4.2.1. 应用服务层注入了PermissionChecker属性

因为授权一般在应用服务层中进行，所以ABP默认在ApplicationService基类注入并定义了PermissionChecker属性。这样，在应用服务层就可以直接使用PermissionChecker属性进行权限检查。

4.2.2. 修改创建任务方法，加入权限检查

 

public int CreateTask(CreateTaskInput input)
{//We can use Logger, it's defined in ApplicationService class.Logger.Info("Creating a task for input: " + input);//获取当前用户var currentUser = AsyncHelper.RunSync(this.GetCurrentUserAsync);//判断用户是否有权限if (input.AssignedPersonId.HasValue && input.AssignedPersonId.Value != currentUser.Id)PermissionChecker.Authorize(PermissionNames.Pages_Tasks_AssignPerson);var task = Mapper.Map<Task>(input);int result = _taskRepository.InsertAndGetId(task);//只有创建成功才发送邮件和通知if (result > 0){task.CreationTime = Clock.Now;if (input.AssignedPersonId.HasValue){task.AssignedPerson = _userRepository.Load(input.AssignedPersonId.Value);var message = "You hava been assigned one task into your todo list.";//TODO:需要重新配置QQ邮箱密码//SmtpEmailSender emailSender = new SmtpEmailSender(_smtpEmialSenderConfig);//emailSender.Send("ysjshengjie@qq.com", task.AssignedPerson.EmailAddress, "New Todo item", message);_notificationPublisher.Publish("NewTask", new MessageNotificationData(message), null,NotificationSeverity.Info, new[] { task.AssignedPerson.ToUserIdentifier() });}}

其中权限检查代码为：PermissionChecker.Authorize(PermissionNames.Pages_Tasks_AssignPerson);这种方式当没有权限时，将直接抛出异常。当启用<customErrors mode="On" />时，将跳转至Error视图并显示以下信息。

授权提示

 

4.2.3. 修改编辑任务方法，加入权限检查

 

public void UpdateTask(UpdateTaskInput input)
{//We can use Logger, it's defined in ApplicationService base class.Logger.Info("Updating a task for input: " + input);//获取当前用户var currentUser = AsyncHelper.RunSync(this.GetCurrentUserAsync);//获取是否有权限bool canAssignTaskToOther = PermissionChecker.IsGranted(PermissionNames.Pages_Tasks_AssignPerson);//如果任务已经分配且未分配给自己，且不具有分配任务权限，则抛出异常if (input.AssignedPersonId.HasValue && input.AssignedPersonId.Value != currentUser.Id && !canAssignTaskToOther){throw new AbpAuthorizationException("没有分配任务给他人的权限！");}var updateTask = Mapper.Map<Task>(input);_taskRepository.Update(updateTask);
}

其中权限检查代码为PermissionChecker.IsGranted(PermissionNames.Pages_Tasks_AssignPerson);，IsGranted()方法返回true or false。

权限提示

 

4.2.4. Razor页面如何进行权限检查

视图基类定义了IsGranted方法来检查当前用户是否具有权限。我们可以在_List.cshtml.cs中加入以下代码来控制是否显示删除按钮。

 

@if (IsGranted(PermissionNames.Pages_Tasks_Delete))
{<button type="button" class="btn btn-success" onclick="deleteTask(@task.Id);">Delete</button>
}

4.2.5 js代码如何进行权限检查

abp.auth命名空间下定义了权限相关的API，在js中我们可以直接使用。
这里不再举例。

5. 将新增的权限赋予给Admin

完成了权限的定义和检查，我们如何进行权限设置呢，如何为角色或用户赋予权限呢？
在ABP模板项目中暂未提供用户角色权限管理功能，但在AbpZero中提供了该功能，支持按用户或角色赋予权限。那咋办呢？
咱们退而求其次，在数据库初始化的时候，将权限赋给Admin。
但是我们的数据库已经建立好了啊？
反正是测试库，删掉重建呗。

5.1. 删除数据库

怎么删数据库，自己应该知道吧。

5.2. 代码中为Admin赋予权限

打开基础设施层，即以EntityFramework结尾的项目中，定位到Migrations\SeedData文件夹，分别在
HostRoleAndUserCreator和TenantRoleAndUserBuilder两个类中添加以下代码：

 

var taskPermissions = PermissionFinder.GetAllPermissions(new TaskAuthorizationProvider()).ToList();
permissions.AddRange(taskPermissions);

5.3. 重新编译整个项目，执行Update-Database

查看数据库，发现已经将Permission赋予给了admin

6.总结

本节主要讲解了ABP权限管理的基本实现方式，以及如何定义、使用和添加权限。

在ABP模板项目中暂未提供用户角色权限管理功能，但在AbpZero中提供了该功能，支持按用户或角色赋予权限。这一节先暂时不表，等我研究通彻了再和大家娓娓道来。

遗留问题：

  1. 在模态框上如何弹出异常信息?



作者：圣杰
链接：https://www.jianshu.com/p/870938be9ec2
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

这篇关于ABP入门系列（9）——权限管理的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/560980。

相关文章

Java访问修饰符public、private、protected及默认访问权限详解

Java访问修饰符public、private、protected及默认访问权限详解

《Java访问修饰符public、private、protected及默认访问权限详解》：本文主要介绍Java访问修饰符public、private、protected及默认访问权限的相关资料,每... 目录前言1. public 访问修饰符特点：示例：适用场景：2. private 访问修饰符特点：示例：
阅读更多...
高效管理你的Linux系统: Debian操作系统常用命令指南

高效管理你的Linux系统: Debian操作系统常用命令指南

《高效管理你的Linux系统:Debian操作系统常用命令指南》在Debian操作系统中，了解和掌握常用命令对于提高工作效率和系统管理至关重要，本文将详细介绍Debian的常用命令，帮助读者更好地使... Debian是一个流行的linux发行版，它以其稳定性、强大的软件包管理和丰富的社区资源而闻名。在使用
阅读更多...
Linux中chmod权限设置方式

Linux中chmod权限设置方式

《Linux中chmod权限设置方式》本文介绍了Linux系统中文件和目录权限的设置方法,包括chmod、chown和chgrp命令的使用,以及权限模式和符号模式的详细说明,通过这些命令,用户可以灵活... 目录设置基本权限命令：chmod1、权限介绍2、chmod命令常见用法和示例3、文件权限详解4、ch
阅读更多...
SpringBoot使用minio进行文件管理的流程步骤

SpringBoot使用minio进行文件管理的流程步骤

《SpringBoot使用minio进行文件管理的流程步骤》MinIO是一个高性能的对象存储系统,兼容AmazonS3API,该软件设计用于处理非结构化数据,如图片、视频、日志文件以及备份数据等,本文... 目录一、拉取minio镜像二、创建配置文件和上传文件的目录三、启动容器四、浏览器登录 minio五、
阅读更多...
IDEA中的Kafka管理神器详解

IDEA中的Kafka管理神器详解

《IDEA中的Kafka管理神器详解》这款基于IDEA插件实现的Kafka管理工具,能够在本地IDE环境中直接运行,简化了设置流程,为开发者提供了更加紧密集成、高效且直观的Kafka操作体验... 目录免安装：IDEA中的Kafka管理神器！简介安装必要的插件创建 Kafka 连接第一步：创建连接第二步：选
阅读更多...
Mybatis拦截器如何实现数据权限过滤

Mybatis拦截器如何实现数据权限过滤

《Mybatis拦截器如何实现数据权限过滤》本文介绍了MyBatis拦截器的使用,通过实现Interceptor接口对SQL进行处理,实现数据权限过滤功能,通过在本地线程变量中存储数据权限相关信息,并... 目录背景基础知识MyBATis 拦截器介绍代码实战总结背景现在的项目负责人去年年底离职，导致前期规
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
综合安防管理平台LntonAIServer视频监控汇聚抖动检测算法优势

综合安防管理平台LntonAIServer视频监控汇聚抖动检测算法优势

LntonAIServer视频质量诊断功能中的抖动检测是一个专门针对视频稳定性进行分析的功能。抖动通常是指视频帧之间的不必要运动，这种运动可能是由于摄像机的移动、传输中的错误或编解码问题导致的。抖动检测对于确保视频内容的平滑性和观看体验至关重要。 优势 1. 提高图像质量 - 清晰度提升：减少抖动，提高图像的清晰度和细节表现力，使得监控画面更加真实可信。 - 细节增强：在低光条件下，抖
阅读更多...
科研绘图系列：R语言扩展物种堆积图（Extended Stacked Barplot）

科研绘图系列：R语言扩展物种堆积图（Extended Stacked Barplot）

介绍 R语言的扩展物种堆积图是一种数据可视化工具，它不仅展示了物种的堆积结果，还整合了不同样本分组之间的差异性分析结果。这种图形表示方法能够直观地比较不同物种在各个分组中的显著性差异，为研究者提供了一种有效的数据解读方式。 加载R包 knitr::opts_chunk$set(warning = F, message = F)library(tidyverse)library(phyl
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2