mirror of https://github.com/abpframework/abp.git
liangshiwei
4 years ago
1675 changed files with 155295 additions and 63543 deletions
@ -0,0 +1,3 @@ |
|||
Please explain the content (an article or a video tutorial) that you would like to see on the ABP Community website, https://community.abp.io. |
|||
|
|||
Before creating your own request, please check existing requests: https://github.com/abpframework/abp/labels/community-article-request |
|||
@ -1,35 +0,0 @@ |
|||
#THIS IS NOT BEING USED CURRENTLY. RELEASE GITHUB MANUALLY |
|||
|
|||
# Import the module dynamically from the PowerShell Gallery. Use CurrentUser scope to avoid having to run as admin. |
|||
Import-Module -Name new-github-release-function.psm1 |
|||
|
|||
# Specify the parameters required to create the release. Do it as a hash table for easier readability. |
|||
$newGitHubReleaseParameters = |
|||
@{ |
|||
GitHubUsername = 'abpframework' |
|||
GitHubRepositoryName = 'abp' |
|||
GitHubAccessToken = '*******************' |
|||
ReleaseName = "5.0.0-rc.2" |
|||
TagName = "5.0.0-rc.2" |
|||
ReleaseNotes = "N/A" |
|||
#AssetFilePaths = @('C:\MyProject\Installer.exe','C:\MyProject\Documentation.md') |
|||
IsPreRelease = $true |
|||
IsDraft = $true # Set to true when testing so we don't publish a real release (visible to everyone) by accident. |
|||
} |
|||
|
|||
# Try to create the Release on GitHub and save the results. |
|||
$result = New-GitHubRelease @newGitHubReleaseParameters |
|||
|
|||
# Provide some feedback to the user based on the results. |
|||
if ($result.Succeeded -eq $true) |
|||
{ |
|||
Write-Output "Release published successfully! View it at $($result.ReleaseUrl)" |
|||
} |
|||
elseif ($result.ReleaseCreationSucceeded -eq $false) |
|||
{ |
|||
Write-Error "The release was not created. Error message is: $($result.ErrorMessage)" |
|||
} |
|||
elseif ($result.AllAssetUploadsSucceeded -eq $false) |
|||
{ |
|||
Write-Error "The release was created, but not all of the assets were uploaded to it. View it at $($result.ReleaseUrl). Error message is: $($result.ErrorMessage)" |
|||
} |
|||
@ -0,0 +1,86 @@ |
|||
param( |
|||
[string]$branchName, |
|||
[string]$version, |
|||
[string]$isRcVersion, |
|||
[string]$isDraft, |
|||
[string]$gitHubApiKey |
|||
) |
|||
|
|||
. ..\nupkg\common.ps1 |
|||
|
|||
Write-Info "Publishing GitHub Release..." ## Further info see https://docs.github.com/en/rest/reference/releases |
|||
|
|||
if ($isRcVersion -eq "") |
|||
{ |
|||
$isRcVersion = Read-Host "Is this a RC/Preview version? (y/n)" |
|||
} |
|||
|
|||
if ($gitHubApiKey -eq "") |
|||
{ |
|||
$gitHubApiKey = Read-File "github-api-key.txt" |
|||
echo "GitHub API Key assigned from github-api-key.txt" |
|||
} |
|||
|
|||
if(!$gitHubApiKey) |
|||
{ |
|||
$gitHubApiKey = Read-Host "Enter the GitHub API Key" |
|||
} |
|||
|
|||
if ($version -eq "") |
|||
{ |
|||
$version = Get-Current-Version # The version number for this release |
|||
} |
|||
|
|||
if ($branchName -eq "") |
|||
{ |
|||
$branchName = Get-Current-Branch # The branch name also the tag name |
|||
} |
|||
|
|||
if ($isDraft -eq "") |
|||
{ |
|||
$draft = $FALSE |
|||
} |
|||
else |
|||
{ |
|||
$draft = [boolean]::Parse($isDraft) |
|||
} |
|||
|
|||
############################################################################## |
|||
$preRelease = ( ($isRcVersion -eq "true") -or ($isRcVersion -eq "y") -or ($isRcVersion -eq "rc") ) # Set to true to mark this as a pre-release version |
|||
$gitHubUsername = 'abpframework' # The github username |
|||
$gitHubRepository = 'abp' # The github repository name |
|||
$releaseNotes = '' # The notes to accompany this release, uses the commit message in this case |
|||
############################################################################## |
|||
|
|||
echo "Current version: $version" |
|||
echo "Current branch: $branchName" |
|||
echo "Preview version: $preRelease" |
|||
echo "Draft: $draft" |
|||
|
|||
############################################################################## |
|||
|
|||
$releaseData = @{ |
|||
tag_name = $version; |
|||
target_commitish = $branchName; |
|||
name = $version; |
|||
body = $releaseNotes; |
|||
draft = $draft; |
|||
prerelease = $preRelease; |
|||
} |
|||
|
|||
$releaseParams = @{ |
|||
Uri = "https://api.github.com/repos/$gitHubUsername/$gitHubRepository/releases"; |
|||
Method = 'POST'; |
|||
Headers = @{ |
|||
Authorization = 'Basic ' + [Convert]::ToBase64String( |
|||
[Text.Encoding]::ASCII.GetBytes($gitHubApiKey + ":x-oauth-basic")); |
|||
} |
|||
ContentType = 'application/json'; |
|||
Body = (ConvertTo-Json $releaseData -Compress) |
|||
} |
|||
|
|||
$response = Invoke-RestMethod @releaseParams |
|||
|
|||
echo "---------------------------------------------" |
|||
echo "$version has been successfully released." |
|||
|
|||
@ -1,7 +1,43 @@ |
|||
./1-fetch-and-build.ps1 |
|||
param( |
|||
[string]$branch, |
|||
[string]$newVersion, |
|||
[string]$isRcVersion |
|||
) |
|||
|
|||
. ..\nupkg\common.ps1 |
|||
|
|||
if (!$branch) |
|||
{ |
|||
$branch = Read-Host "Enter the branch name" |
|||
} |
|||
|
|||
if (!$newVersion) |
|||
{ |
|||
$currentVersion = Get-Current-Version |
|||
$newVersion = Read-Host "Current version is '$currentVersion'. Enter the new version (empty for no change) " |
|||
if($newVersion -eq "") |
|||
{ |
|||
$newVersion = $currentVersion |
|||
} |
|||
} |
|||
|
|||
if ($isRcVersion -eq "") |
|||
{ |
|||
$isRcVersion = Read-Host "Is this a RC/Preview version? (y/n)" |
|||
} |
|||
|
|||
$publishGithubReleaseParams = @{ |
|||
branchName=$branch |
|||
isRcVersion=$isRcVersion |
|||
} |
|||
|
|||
|
|||
./1-fetch-and-build.ps1 $branch $newVersion |
|||
./2-nuget-pack.ps1 |
|||
./3-nuget-push.ps1 |
|||
./4-npm-publish-mvc.ps1 |
|||
./5-npm-publish-angular.ps1 |
|||
./6-git-commit.ps1 |
|||
echo "Create a new release on GitHub manually and run the step 8..." |
|||
./7-publish-github-release.ps1 @publishGithubReleaseParams |
|||
./8-download-release-zip.ps1 |
|||
|
|||
|
|||
@ -1,94 +0,0 @@ |
|||
# ABP.IO Platform 5.1 RC.1 Has Been Released |
|||
|
|||
Today, we are releasing the [ABP Framework](https://abp.io/) and the [ABP Commercial](https://commercial.abp.io/) version **5.1 RC** (Release Candidate). This blog post introduces the new features and important changes in this new version. |
|||
|
|||
> **The planned release date for the [5.1 stable](https://github.com/abpframework/abp/milestone/64) version is February 8, 2022**. |
|||
|
|||
Please try this version and provide feedback for a more stable ABP version 5.1! Thank you all. |
|||
|
|||
## Get Started with the 5.1 RC |
|||
|
|||
follow the steps below to try the version 5.1 RC today; |
|||
|
|||
1) **Upgrade** the ABP CLI to the version `5.1.0-rc.1` using a command line terminal: |
|||
|
|||
````bash |
|||
dotnet tool update Volo.Abp.Cli -g --version 5.1.0-rc.1 |
|||
```` |
|||
|
|||
**or install** if you haven't installed before: |
|||
|
|||
````bash |
|||
dotnet tool install Volo.Abp.Cli -g --version 5.1.0-rc.1 |
|||
```` |
|||
|
|||
2) Create a **new application** with the `--preview` option: |
|||
|
|||
````bash |
|||
abp new BookStore --preview |
|||
```` |
|||
|
|||
See the [ABP CLI documentation](https://docs.abp.io/en/abp/latest/CLI) for all the available options. |
|||
|
|||
> You can also use the *Direct Download* tab on the [Get Started](https://abp.io/get-started) page by selecting the **Preview checkbox**. |
|||
|
|||
You can use any IDE that supports .NET 6.0 development (e.g. [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)). |
|||
|
|||
### Migration Notes & Breaking Changes |
|||
|
|||
TODO: Startup template changes |
|||
|
|||
## What's new with 5.1? |
|||
|
|||
In this section, I will introduce some major features released with this version. |
|||
|
|||
### DRAFT list of things done |
|||
|
|||
#### ABP Framework |
|||
|
|||
* Use new hosting model for the app template. [#10928](https://github.com/abpframework/abp/pull/10928) - what to do for existing solutions? |
|||
* Async application initialization methods on the AbpModule class [#6828](https://github.com/abpframework/abp/issues/6828) |
|||
* Angular 13? |
|||
* [#10552](https://github.com/abpframework/abp/pull/10696) Used file scoped namespaces :) |
|||
* Support markdown in CMS-Kit comments [#10792](https://github.com/abpframework/abp/pull/10792) |
|||
* eShopOnAbp is getting mature |
|||
* Nightly builds are working again |
|||
* Coming: New ABP.IO design! |
|||
|
|||
All issues & PRs in [5.1 milesone](https://github.com/abpframework/abp/milestone/60?closed=1). |
|||
|
|||
#### ABP Commercial |
|||
|
|||
* CMS Kit Pro: URL forwarding |
|||
* LeptonX is coming for ABP Blazor and MVC UI too (share the sample dashboard) |
|||
|
|||
### Header 1 |
|||
|
|||
TODO |
|||
|
|||
## Community News |
|||
|
|||
### ABP Community Talks 2021.1 |
|||
|
|||
 |
|||
|
|||
This is the second episode of the ABP Community Talks and we are talking about microservice development with the ABP Framework, based on the [eShopOnAbp](https://github.com/abpframework/eShopOnAbp) reference solution. This live meeting will be at **January 20, 2022, 17:00 (UTC)** on YouTube. |
|||
|
|||
**Join this event on the Kommunity platform: https://kommunity.com/volosoft/events/abp-community-talks-20221-microservice-development-acd0f44b** |
|||
|
|||
You can also [subscribe to the Volosoft channel](https://www.youtube.com/channel/UCO3XKlpvq8CA5MQNVS6b3dQ) for reminders for further ABP events and videos. |
|||
|
|||
### New ABP Community posts |
|||
|
|||
Here, some of the recent posts added to the [ABP community](https://community.abp.io/): |
|||
|
|||
* [Minimal API development with the ABP Framework](https://community.abp.io/articles/minimal-api-with-abp-hello-world-part-1-sg5i44p8) by [@antosubash](https://github.com/antosubash) (three parts, video tutorial). |
|||
* [Integrating the Syncfusion MVC Components to the ABP MVC UI](https://community.abp.io/articles/integrating-the-syncfusion-mvc-components-to-the-abp-mvc-ui-0gpkr1if) by [@EngincanV](https://github.com/EngincanV). |
|||
* [Add Tailwind CSS to your ABP Blazor UI](https://community.abp.io/articles/add-tailwindcss-to-your-abp-blazor-ui-vidiwzcy) by [@antosubash](https://github.com/antosubash) (video tutorial). |
|||
* [Import external users into the users Table from an ABP Framework application](https://community.abp.io/articles/import-external-users-into-the-users-table-from-an-abp-framework-application-7lnyw415) by [@bartvanhoey](https://github.com/bartvanhoey). |
|||
|
|||
Thanks to the ABP Community for all the contents they have published. You can also [post your ABP and .NET related (text or video) contents](https://community.abp.io/articles/submit) to the ABP Community. |
|||
|
|||
## Conclusion |
|||
|
|||
In this blog post, I summarized the news about that new version and the ABP Community. Please try it and provide feedback by opening issues on [the GitHub repository](https://github.com/abpframework/abp). Thank you all! |
|||
@ -0,0 +1,155 @@ |
|||
# ABP.IO Platform 5.1 Has Been Released |
|||
|
|||
Today, we are releasing the [ABP Framework](https://abp.io/) and [ABP Commercial](https://commercial.abp.io/) version 5.1 (with a version number `5.1.1`). This blog post introduces the new features and important changes in this new version. |
|||
|
|||
> **Warning** |
|||
> |
|||
> For a long time we've been releasing RC (Release Candidate) versions a few weeks prior to every minor and major release. **This version has been released without a preview version.** This is because we've accidently released all the packages with a stable version number, without a `-rc.1` suffix and there is no clear way to unpublish all the NuGet and NPM packages. We're sorry about that. However, it doesn't mean that this release is buggy. We've already resolved the known problems. We will publish one or more patch releases if needed. You can follow [this milestone](https://github.com/abpframework/abp/milestone/64?closed=1) for the common problems or submit your own bug report. If you are worried about its stability, you can wait for the next patch release. |
|||
|
|||
## Get Started with 5.1 |
|||
|
|||
Follow the steps below to try the 5.1 version today: |
|||
|
|||
1) **Upgrade** the ABP CLI to the latest version using a command line terminal: |
|||
|
|||
````bash |
|||
dotnet tool update Volo.Abp.Cli -g |
|||
```` |
|||
|
|||
**or install** if you haven't installed it before: |
|||
|
|||
````bash |
|||
dotnet tool install Volo.Abp.Cli -g |
|||
```` |
|||
|
|||
2) Create a **new application**: |
|||
|
|||
````bash |
|||
abp new BookStore |
|||
```` |
|||
|
|||
Check out the [ABP CLI documentation](https://docs.abp.io/en/abp/latest/CLI) for all the available options. |
|||
|
|||
> You can also use the *Direct Download* tab on the [Get Started](https://abp.io/get-started) page. |
|||
|
|||
You can use any IDE that supports .NET 6.x development (e.g. [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)). |
|||
|
|||
### Migration Notes & Breaking Changes |
|||
|
|||
This is a minor feature release, mostly with enhancements and improvements based on [version 5.0](https://blog.abp.io/abp/ABP-IO-Platform-5-0-Final-Has-Been-Released). There aren't any breaking changes except for the Angular UI upgrade. ABP 5.1 startup templates use **Angular 13**. |
|||
|
|||
### Angular UI |
|||
|
|||
**If you want to upgrade the ABP Framework but want to continue with Angular 12**, add the following section to the `package.json` file of the Angular project: |
|||
|
|||
````json |
|||
"resolutions": { |
|||
"ng-zorro-antd": "^12.1.1", |
|||
"@ng-bootstrap/ng-bootstrap": "11.0.0-beta.2" |
|||
} |
|||
```` |
|||
|
|||
### Blazor UI |
|||
|
|||
If you are using Blazor WebAssembly, open the `Program` class and replace `InitializeAsync` with `InitializeApplicationAsync`. |
|||
|
|||
## What's New with the ABP Framework 5.1? |
|||
|
|||
In this section, I will introduce some major features released with this version. |
|||
|
|||
### The New Hosting Model |
|||
|
|||
The ABP startup application template now uses the new ASP.NET Core hosting APIs ([check out the Microsoft's minimal APIs document](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/minimal-apis?view=aspnetcore-6.0)) on application startup ([check out the exact place in the ABP startup template](https://github.com/abpframework/abp/blob/46cdfbe7b06c93690181633be4e96bf62e7f34e2/templates/app/aspnet-core/src/MyCompanyName.MyProjectName.Web/Program.cs#L33-L40)). So, the `Startup.cs` file has been removed. |
|||
|
|||
Old-style hosting logic will continue to work as long as ASP.NET Core supports it. It is recommended to switch to the new model if it's possible for your solution. Check out [this guide](https://docs.abp.io/en/abp/latest/Migration-Guides/Upgrading-Startup-Template) if you need to know how to do that. |
|||
|
|||
### Asynchronous Startup Lifecycle Methods |
|||
|
|||
The new hosting model allows us to execute asynchronous code on application initialization in the [ABP module](https://docs.abp.io/en/abp/latest/Module-Development-Basics) classes. If you are using the new hosting model (which is default with 5.1 startup templates), you can override the `Async` versions of the module lifecycle methods. |
|||
|
|||
For example, you can now override the `ConfigureServicesAsync` (instead of `ConfigureServices`) or `OnApplicationInitializationAsync` (instead of `OnApplicationInitialization`) as shown in the following code block: |
|||
|
|||
````csharp |
|||
public class MyModule : AbpModule |
|||
{ |
|||
public override async Task ConfigureServicesAsync(ServiceConfigurationContext context) |
|||
{ |
|||
/* You can use await here and safely execute other async methods */ |
|||
} |
|||
|
|||
public override async Task OnApplicationInitializationAsync(ApplicationInitializationContext context) |
|||
{ |
|||
/* You can use await here and safely execute other async methods */ |
|||
} |
|||
} |
|||
```` |
|||
|
|||
If you override both the asynchronous and synchronous versions of the same method, only the asynchronous one will be executed. So, override only one of them based on your needs. |
|||
|
|||
### eShopOnABP Is Getting More Stable |
|||
|
|||
Our team is working to finalize the [eShopOnAbp](https://github.com/abpframework/eShopOnAbp) example solution, which is a reference **microservice solution** built with the ABP Framework. They will explain the project status and show what's done in the next **ABP Community Talks** meeting (Check out the *ABP Community Talks 2021.1* section at the bottom of this post). |
|||
|
|||
### The New ABP.IO Design! |
|||
|
|||
We've been working on a new design for the [abp.io](https://abp.io/) websites for a while. We are adding the final touches; the new design will be live very soon. Here's a screenshot from the design work: |
|||
|
|||
 |
|||
|
|||
The [ABP Commercial](https://commercial.abp.io/) and [ABP Community](https://community.abp.io/) websites will also have new designs as part of this update. |
|||
|
|||
### Other Changes |
|||
|
|||
Here are some other notable changes that come with this release: |
|||
|
|||
* Support markdown in [CMS-Kit comments ](https://docs.abp.io/en/abp/latest/Modules/Cms-Kit/Comments)feature ([#10792](https://github.com/abpframework/abp/pull/10792)) |
|||
* Used file scoped namespaces for all the ABP Framework source code :) ([#10552](https://github.com/abpframework/abp/pull/10696)) |
|||
* Developers should control `EnableLegacyTimestampBehavior` when using PostgreSQL. [#11371](https://github.com/abpframework/abp/pull/11371) [#65](https://github.com/abpframework/eShopOnAbp/pull/65) |
|||
|
|||
|
|||
All issues & PRs in [5.1 milesone](https://github.com/abpframework/abp/milestone/60?closed=1). |
|||
|
|||
### About ABP Commercial |
|||
|
|||
The core team is also working on ABP Commercial (which provides pre-built modules, themes, tooling and support on top of the ABP Framework). We've done a lot of minor improvements and fixes to the modules and tooling. |
|||
|
|||
There's some exciting news about the **LeptonX theme**; We are working on making it available in the **MVC (Razor Pages)** and **Blazor** UI options too (in addition to Angular UI). We are also adding more components, layout options, demo pages, etc... We are planning to release a beta version in the next weeks. Here's an animated GIF from the dashboard we've prepared as a demonstration: |
|||
|
|||
 |
|||
|
|||
If you are wondering what is the LeptonX project, please check out this [blog post](https://blog.abp.io/abp/LeptonX-Theme-for-ABP-Framework-Alpha-Release). |
|||
|
|||
As another visible functionality, we've added a new feature to the [CMS Kit Pro](https://docs.abp.io/en/commercial/latest/modules/cms-kit/index) module that is used to forward a URL to another URL. This is a screenshot from the management UI: |
|||
|
|||
 |
|||
|
|||
This feature can be used to create short URLs in your application (like URL shortening services providers) or forward old pages to their new URLs. |
|||
|
|||
In addition to the new features shipped in every minor version, we are working on long-term projects for ABP.IO Platform and ABP Commercial (a little secret for now :). We will have announcements once these projects get more stable. |
|||
|
|||
## Community News |
|||
|
|||
### ABP Community Talks 2021.1 |
|||
|
|||
 |
|||
|
|||
This is the second episode of the ABP Community Talks and we are talking about microservice development with the ABP Framework, based on the [eShopOnAbp](https://github.com/abpframework/eShopOnAbp) reference solution. We will also briefly talk about the changes that come with ABP version 5.1. This **live meeting** will be on **January 20, 2022, 17:00 (UTC)** on YouTube. |
|||
|
|||
**Join this event on the Kommunity platform: https://kommunity.com/volosoft/events/abp-community-talks-20221-microservice-development-acd0f44b** |
|||
|
|||
You can also [subscribe to Volosoft YouTube channel](https://www.youtube.com/channel/UCO3XKlpvq8CA5MQNVS6b3dQ) for reminders of further ABP events and videos. |
|||
|
|||
### New ABP Community Posts |
|||
|
|||
Here are some of the recent posts added to the [ABP community](https://community.abp.io/): |
|||
|
|||
* [Minimal API development with the ABP Framework](https://community.abp.io/articles/minimal-api-with-abp-hello-world-part-1-sg5i44p8) by [@antosubash](https://github.com/antosubash) (three parts, video tutorial). |
|||
* [Integrating the Syncfusion MVC Components to the ABP MVC UI](https://community.abp.io/articles/integrating-the-syncfusion-mvc-components-to-the-abp-mvc-ui-0gpkr1if) by [@EngincanV](https://github.com/EngincanV). |
|||
* [Add Tailwind CSS to your ABP Blazor UI](https://community.abp.io/articles/add-tailwindcss-to-your-abp-blazor-ui-vidiwzcy) by [@antosubash](https://github.com/antosubash) (video tutorial). |
|||
* [Import external users into the users Table from an ABP Framework application](https://community.abp.io/articles/import-external-users-into-the-users-table-from-an-abp-framework-application-7lnyw415) by [@bartvanhoey](https://github.com/bartvanhoey). |
|||
|
|||
Thanks to the ABP Community for all the contents they have published. You can also [post your ABP and .NET related (text or video) contents](https://community.abp.io/articles/submit) to the ABP Community. |
|||
|
|||
## Conclusion |
|||
|
|||
In this blog post, I summarized the news about the new version and the ABP Community. Please try it and provide feedback by opening issues on the [GitHub repository](https://github.com/abpframework/abp). Thank you all! |
|||
|
Before Width: | Height: | Size: 559 KiB After Width: | Height: | Size: 559 KiB |
|
After Width: | Height: | Size: 6.6 MiB |
|
After Width: | Height: | Size: 162 KiB |
|
After Width: | Height: | Size: 66 KiB |
@ -1 +0,0 @@ |
|||
TODO... |
|||
@ -1,3 +0,0 @@ |
|||
# Client Simulation Module |
|||
|
|||
TODO |
|||
@ -1 +1,105 @@ |
|||
TODO... |
|||
# 功能管理模块 |
|||
|
|||
功能管理模块实现了 [功能系统](../Features.md) 定义的 `IFeatureManagementStore` 接口. |
|||
|
|||
> 此文档仅介绍了将功能值持续保存到数据库的功能管理模块. 请参阅 [功能](../Features.md) 来了解功能系统. |
|||
|
|||
## 如何安装 |
|||
|
|||
当你使用 ABP 框架 [创建一个新的解决方案](https://abp.io/get-started) 时, 此模块将被预安装(作为 NuGet/NPM 包). 你可以继续用其作为包并轻松地获取更新, 也可以将其源代码包含在解决方案中 (请参阅 `get-source` [CLI](../CLI.md) 命令) 以开发自定义模块. |
|||
|
|||
### 源代码 |
|||
|
|||
可以 [在此处](https://github.com/abpframework/abp/tree/dev/modules/feature-management) 访问源代码。源代码使用 [MIT](https://choosealicense.com/licenses/mit/) 许可, 所以你可以免费使用和自定义它. |
|||
|
|||
## 用户界面 |
|||
|
|||
### 功能管理对话框 |
|||
|
|||
功能管理模块提供了一个可重用的对话框来管理与对象相关的功能. 例如: [租户管理模块](Tenant-Management.md) 用它在租户管理页面管理租户的功能. |
|||
|
|||
 |
|||
|
|||
当你点击租户的 *操作* -> *功能* 时, 将打开功能管理对话框. 下面是定义了两个功能的对话框示例截图: |
|||
|
|||
 |
|||
|
|||
在对话框中, 你可以为租户启用, 禁用或设置功能值. |
|||
|
|||
## IFeatureManager |
|||
|
|||
`IFeatureManager` 是此模块提供的主要服务. 在多租户应用程序中, 它常用来读取和更改功能值. `IFeatureManager` 通常被 *租户管理对话框* 使用. 但如果需要设置功能值, 你也可以注入它. |
|||
|
|||
> 如果你只是想要读取或检查功能值, 请如 [功能文档](../Features.md) 中所述那样使用 `IFeatureChecker`. |
|||
|
|||
**示例: 为租户获取或设置功能值** |
|||
|
|||
````csharp |
|||
using System; |
|||
using System.Threading.Tasks; |
|||
using Volo.Abp.DependencyInjection; |
|||
using Volo.Abp.FeatureManagement; |
|||
|
|||
namespace Demo |
|||
{ |
|||
public class MyService : ITransientDependency |
|||
{ |
|||
private readonly IFeatureManager _featureManager; |
|||
|
|||
public MyService(IFeatureManager featureManager) |
|||
{ |
|||
_featureManager = featureManager; |
|||
} |
|||
|
|||
public async Task SetFeatureDemoAsync(Guid tenantId, string value) |
|||
{ |
|||
await _featureManager |
|||
.SetForTenantAsync(tenantId, "Feature1", value); |
|||
|
|||
var currentValue = await _featureManager |
|||
.GetOrNullForTenantAsync("Feature1", tenantId); |
|||
} |
|||
} |
|||
} |
|||
```` |
|||
|
|||
## 功能管理提供程序 |
|||
|
|||
功能管理模块是可扩展的, 就像 [功能系统](../Features.md) 一样. 你可以通过定义功能管理提供程序来扩展它. 有3个预编译的功能管理提供程序已按下面的顺序注册: |
|||
|
|||
* `DefaultValueFeatureManagementProvider`: 从功能定义的默认值中获取功能值. 它无法设置默认值, 因为默认值是在功能定义中硬编码的. |
|||
* `EditionFeatureManagementProvider`: 获取或设置版本的功能值. 版本是分配给租户的一个功能分组. 租户管理模块没有实现版本系统. 你可以自己实现它, 或者购买已实现它并且提供更多SaaS功能的 ABP 商业版 [SaaS 模块](https://commercial.abp.io/modules/Volo.Saas), 像订阅和支付. |
|||
* `TenantFeatureManagementProvider`: 获取或设置租户的功能. |
|||
|
|||
`IFeatureManager` 在获取和设置的方法中使用了这些提供程序. 通常, 在 `IFeatureManager` 服务中, 每个功能管理提供程序都定义了扩展方法 (像租户功能管理提供程序就定义了 `SetForTenantAsync`). |
|||
|
|||
如果想要自定义提供程序, 你需要实现 `IFeatureManagementProvider` 接口或从 `FeatureManagementProvider` 基类继承: |
|||
|
|||
````csharp |
|||
public class CustomFeatureProvider : FeatureManagementProvider |
|||
{ |
|||
public override string Name => "Custom"; |
|||
|
|||
public CustomFeatureProvider(IFeatureManagementStore store) |
|||
: base(store) |
|||
{ |
|||
} |
|||
} |
|||
```` |
|||
|
|||
`FeatureManagementProvider` 基类 (使用 `IFeatureManagementStore`) 为你做了默认的实现. 你可以按需重写基础方法. 在这个 `Custom` 的示例中, 每个提供程序必须有一个唯一的名称 (请保持简短, 因为每个功能值记录都会被保存到数据库中). |
|||
|
|||
创建提供程序类后, 你应该用 `FeatureManagementOptions` [选项类](../Options.md) 注册它: |
|||
|
|||
````csharp |
|||
Configure<FeatureManagementOptions>(options => |
|||
{ |
|||
options.Providers.Add<CustomFeatureProvider>(); |
|||
}); |
|||
```` |
|||
|
|||
提供程序的顺序很重要. 提供程序按相反的顺序被执行. 这意味着在此示例中 `CustomFeatureProvider` 是第一个被执行的. 你可以在 `Providers` 列表的任意位置插入你的提供程序. |
|||
|
|||
## 另请参见 |
|||
|
|||
* [功能](../Features.md) |
|||
|
|||
@ -1,3 +1,109 @@ |
|||
# 权限管理模块 |
|||
|
|||
TODO |
|||
此模块实现了 `IPermissionStore` 接口, 并在数据库中管理权限值. |
|||
|
|||
> 此文档仅介绍了将权限值持续保存到数据库的权限管理模块. 请参阅 [授权文档](../Authorization.md) 来了解授权和权限系统. |
|||
|
|||
## 如何安装 |
|||
|
|||
当你使用 ABP 框架 [创建一个新的解决方案](https://abp.io/get-started) 时, 此模块将被预安装(作为 NuGet/NPM 包). 你可以继续用其作为包并轻松地获取更新, 也可以将其源代码包含在解决方案中 (请参阅 `get-source` [CLI](../CLI.md) 命令) 以开发自定义模块. |
|||
|
|||
### 源代码 |
|||
|
|||
可以 [在此处](https://github.com/abpframework/abp/tree/dev/modules/permission-management) 访问源代码。源代码使用 [MIT](https://choosealicense.com/licenses/mit/) 许可, 所以你可以免费使用和自定义它. |
|||
|
|||
## 用户界面 |
|||
|
|||
### 权限管理对话框 |
|||
|
|||
权限管理模块提供了一个可重用的对话框来管理与对象相关的权限. 例如: [身份模块](Identity.md) 用它去管理用户和角色的权限. 下图展示了身份模块的角色管理页面: |
|||
|
|||
 |
|||
|
|||
当你点击角色的 *操作* -> *权限* 时, 将打开权限管理对话框. 下面是此对话框的一个示例截图: |
|||
|
|||
 |
|||
|
|||
在对话框中, 你可以为所选角色授予权限. 左侧的选项卡表示主要权限组, 右侧包括了所选权限组中定义的权限. |
|||
|
|||
## IPermissionManager |
|||
|
|||
`IPermissionManager` 是此模块提供的主要服务. 它常用来读取和更改权限值. `IPermissionManager` 通常被 *权限管理对话框* 使用. 但如果需要设置权限值, 你也可以注入它. |
|||
|
|||
> 如果你只是想要读取或检查当前用户的权限值, 请如 [授权文档](../Authorization.md) 中所述那样使用 `IAuthorizationService` 或 `[Authorize]` 特性. |
|||
|
|||
**示例: 使用 `IPermissionManager` 服务为角色和用户授权** |
|||
|
|||
````csharp |
|||
public class MyService : ITransientDependency |
|||
{ |
|||
private readonly IPermissionManager _permissionManager; |
|||
|
|||
public MyService(IPermissionManager permissionManager) |
|||
{ |
|||
_permissionManager = permissionManager; |
|||
} |
|||
|
|||
public async Task GrantRolePermissionDemoAsync( |
|||
string roleName, string permission) |
|||
{ |
|||
await _permissionManager |
|||
.SetForRoleAsync(roleName, permission, true); |
|||
} |
|||
|
|||
public async Task GrantUserPermissionDemoAsync( |
|||
Guid userId, string roleName, string permission) |
|||
{ |
|||
await _permissionManager |
|||
.SetForUserAsync(userId, permission, true); |
|||
} |
|||
} |
|||
```` |
|||
|
|||
## 权限管理提供程序 |
|||
|
|||
权限管理模块是可扩展的, 就像 [权限系统](../Authorization.md) 一样. 你可以通过定义权限管理提供程序来扩展它. |
|||
|
|||
[身份模块](Identity.md) 定义了如下权限管理提供程序. |
|||
|
|||
* `UserPermissionManagementProvider`: 管理用户基础权限. |
|||
* `RolePermissionManagementProvider`: 管理角色基础权限. |
|||
|
|||
`IPermissionManager` 使用这些提供程序获取或设置权限. 你可以通过实现 `IPermissionManagementProvider` 或从 `PermissionManagementProvider` 基类继承定义你自己的提供程序. |
|||
|
|||
**示例:** |
|||
|
|||
````csharp |
|||
public class CustomPermissionManagementProvider : PermissionManagementProvider |
|||
{ |
|||
public override string Name => "Custom"; |
|||
|
|||
public CustomPermissionManagementProvider( |
|||
IPermissionGrantRepository permissionGrantRepository, |
|||
IGuidGenerator guidGenerator, |
|||
ICurrentTenant currentTenant) |
|||
: base( |
|||
permissionGrantRepository, |
|||
guidGenerator, |
|||
currentTenant) |
|||
{ |
|||
} |
|||
} |
|||
```` |
|||
|
|||
`PermissionManagementProvider` 基类 (使用 `IPermissionGrantRepository`) 为你做了默认的实现. 你可以按需重写基础方法. 在这个自定义的示例中, 每个提供程序必须有一个唯一的名称 (请保持简短, 因为每个权限值记录都会被保存到数据库中). |
|||
|
|||
创建提供程序类后, 你应该用 `PermissionManagementOptions` [选项类](../Options.md) 注册它: |
|||
|
|||
````csharp |
|||
Configure<PermissionManagementOptions>(options => |
|||
{ |
|||
options.ManagementProviders.Add<CustomPermissionManagementProvider>(); |
|||
}); |
|||
```` |
|||
|
|||
提供程序的顺序很重要. 提供程序按相反的顺序被执行. 这意味着在此示例中 `CustomPermissionManagementProvider` 是第一个被执行的. 你可以在 `Providers` 列表的任意位置插入你的提供程序. |
|||
|
|||
## 另请参见 |
|||
|
|||
* [授权](../Authorization.md) |
|||
@ -1 +0,0 @@ |
|||
TODO... |
|||
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 33 KiB |
|
After Width: | Height: | Size: 34 KiB |
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue