ABP.IO WEB應用程式框架新手教學 No.06 開發教學第 5 部分授權

2021-07-23

2819
0
ABP
2021-07-26

這篇主要說明 ABP 內建的授權系統

使用 RBAC (以角色為基礎的存取控制)

Web應用程序開發教程 - 第五部分：授權

關於本教程

在本系列教程中，您將構建一個名稱Acme.BookStore的用於管理書籍及其作者列表的基於 ABP 的程序。是使用以下技術開發的：

Entity Framework Core 為ORM 提供程序。
Angular做為 UI 框架。

本教程分為以下部分：

下載源碼

本教程根據你的UI和數據庫首選項有多個版本，我們準備了一個模型下載的源碼組件：

權限

ABP Framework 提供了一個基於 ASP.NET Core 的授權基礎架構的授權系統。在標準授權基礎架構之上添加的一項主要功能是權限系統，它允許定義權限並啟用/禁用每個角色、用戶或客戶端。

權限名稱

權限必須具有唯一的名稱 (一個 string)。最好的方法是將其定義為一個 const，這樣我們就可以重用權限名稱。

打開 Acme.BookStore.Application.Contracts專案裡面的BookStorePermissions類（在Permissions文件夾中），修改內容如下圖：

namespace Acme.BookStore.Permissions
{
    public static class BookStorePermissions
    {
        public const string GroupName = "BookStore";

        public static class Books
        {
            public const string Default = GroupName + ".Books";
            public const string Create = Default + ".Create";
            public const string Edit = Default + ".Edit";
            public const string Delete = Default + ".Delete";
        }
    }
}

這是定義權限名稱的分層方式。例如，“創建書”權限名稱定義為BookStore.Books.Create。ABP 不會強迫您使用結構，但我們發現這種方式很有用。

權限定義

您應該在使用它們之前定義權限。

打開 Acme.BookStore.Application.Contracts 專案裡面的BookStorePermissionDefinitionProvider類（在Permissions文件夾中），修改內容如下圖：

using Acme.BookStore.Localization;
using Volo.Abp.Authorization.Permissions;
using Volo.Abp.Localization;

namespace Acme.BookStore.Permissions
{
    public class BookStorePermissionDefinitionProvider : PermissionDefinitionProvider
    {
        public override void Define(IPermissionDefinitionContext context)
        {
            var bookStoreGroup = context.AddGroup(BookStorePermissions.GroupName, L("Permission:BookStore"));

            var booksPermission = bookStoreGroup.AddPermission(BookStorePermissions.Books.Default, L("Permission:Books"));
            booksPermission.AddChild(BookStorePermissions.Books.Create, L("Permission:Books.Create"));
            booksPermission.AddChild(BookStorePermissions.Books.Edit, L("Permission:Books.Edit"));
            booksPermission.AddChild(BookStorePermissions.Books.Delete, L("Permission:Books.Delete"));
        }

        private static LocalizableString L(string name)
        {
            return LocalizableString.Create<BookStoreResource>(name);
        }
    }
}

這個類定義了一個權限組（在 UI 上對權限進行分組，將在下面看到）和這個組內的4 個權限。

此外，Create、Edit和Delete是BookStorePermissions.Books.Default權限的子級。只有選擇了父權限，才能選擇子權限。

最後，編輯本地化文件（en.json在項目Localization/BookStore文件夾下Acme.BookStore.Domain.Shared）定義上面使用的本地化鍵：

"Permission:BookStore": "Book Store",
"Permission:Books": "Book Management",
"Permission:Books.Create": "Creating new books",
"Permission:Books.Edit": "Editing the books",
"Permission:Books.Delete": "Deleting the books"

本地化鍵名是任意的，沒有強制規則。但我們更喜歡上面使用的約定。

權限管理界面

// 這邊是 Angular 前端畫面，這裡先快速帶過

定義權限後，您可以在權限管理模式中看到它們。

進入Administration -> Identity -> Roles頁面，選擇admin 角色的Permissions操作，打開權限管理模式：

授予您想要的權限並保存模態。

提示：如果您運行Acme.BookStore.DbMigrator應用程序，新的權限會自動授予管理員角色。

授權

現在，您可以使用權限來授權圖書管理。

應用層 & HTTP API

打開BookAppService類並將策略名稱添加為上面定義的權限名稱：

using System;
using Acme.BookStore.Permissions;
using Volo.Abp.Application.Dtos;
using Volo.Abp.Application.Services;
using Volo.Abp.Domain.Repositories;

namespace Acme.BookStore.Books
{
    public class BookAppService :
        CrudAppService<
            Book, //The Book entity
            BookDto, //Used to show books
            Guid, //Primary key of the book entity
            PagedAndSortedResultRequestDto, //Used for paging/sorting
            CreateUpdateBookDto>, //Used to create/update a book
        IBookAppService //implement the IBookAppService
    {
        public BookAppService(IRepository<Book, Guid> repository)
            : base(repository)
        {
            GetPolicyName = BookStorePermissions.Books.Default;
            GetListPolicyName = BookStorePermissions.Books.Default;
            CreatePolicyName = BookStorePermissions.Books.Create;
            UpdatePolicyName = BookStorePermissions.Books.Edit;
            DeletePolicyName = BookStorePermissions.Books.Delete;
        }
    }
}

向構造函數添加了代碼。Base 會CrudAppService自動對 CRUD 操作使用這些權限。

這使應用程序服務安全，但也使HTTP API安全，因為此服務自動用作 HTTP API，如前所述（請參閱自動 API 控制器）。

// 一般 API 使用聲明授權，使用 [Authorize(BookStorePermissions.Books.Create)] 屬性，如下所示會在稍後的章節中提及。

[Authorize(...)]稍後在開發作者管理功能時，您將看到使用屬性的聲明性授權。

Angular 防護配置

// 這邊是 Angular 前端畫面，這裡先快速帶過

UI的第一步是防止未經授權的用戶看到“圖書”菜單項並進入圖書管理頁面。

打開/src/app/book/book-routing.module.ts並替換為以下內容：

import { NgModule } from '@angular/core';
import { Routes, RouterModule } from '@angular/router';
import { AuthGuard, PermissionGuard } from '@abp/ng.core';
import { BookComponent } from './book.component';

const routes: Routes = [
  { path: '', component: BookComponent, canActivate: [AuthGuard, PermissionGuard] },
];

@NgModule({
  imports: [RouterModule.forChild(routes)],
  exports: [RouterModule],
})
export class BookRoutingModule {}

進口AuthGuard和PermissionGuard從@abp/ng.core。
添加canActivate: [AuthGuard, PermissionGuard]到路由定義。

打開/src/app/route.provider.ts並添加requiredPolicy: 'BookStore.Books'到/books路由。該/books路線區塊應該是以下幾點：

{
  path: '/books',
  name: '::Menu:Books',
  parentName: '::Menu:BookStore',
  layout: eLayoutType.application,
  requiredPolicy: 'BookStore.Books',
}

隱藏新書按鈕

圖書管理頁面有一個新建圖書按鈕，如果當前用戶沒有圖書創建權限，該按鈕應該是不可見的。

打開/src/app/book/book.component.html文件，替換創建按鈕的HTML內容如下圖：

<!-- Add the abpPermission directive -->
<button *abpPermission="'BookStore.Books.Create'" id="create" class="btn btn-primary" type="button" (click)="createBook()">
  <i class="fa fa-plus mr-1"></i>
  <span>{{ '::NewBook' | abpLocalization }}</span>
</button>

剛剛添加*abpPermission="'BookStore.Books.Create'"，如果當前用戶沒有權限，則隱藏按鈕。

隱藏編輯和刪除操作

圖書管理頁面中的圖書表每行都有一個操作按鈕。操作按鈕包括編輯和刪除操作：

如果當前用戶沒有授予相關權限，我們應該隱藏一個動作。

打開/src/app/book/book.component.html文件並替換編輯和刪除按鈕的內容如下：

<!-- Add the abpPermission directive -->
<button *abpPermission="'BookStore.Books.Edit'" ngbDropdownItem (click)="editBook(row.id)">
  {{ '::Edit' | abpLocalization }}
</button>

<!-- Add the abpPermission directive -->
<button *abpPermission="'BookStore.Books.Delete'" ngbDropdownItem (click)="delete(row.id)">
  {{ '::Delete' | abpLocalization }}
</button>

*abpPermission="'BookStore.Books.Edit'"如果當前用戶沒有編輯權限，則添加隱藏編輯操作。
*abpPermission="'BookStore.Books.Delete'"如果當前用戶沒有刪除權限，則添加隱藏刪除操作。

下一部分

請參閱本教程的下一部分。

[2021] ABP.IO WEB應用程式框架新手教學 No.0 全篇索引

回首頁

御用小本本

聯絡方式：@Abp.io (Will 保哥 Line 群)