初識ABP vNext（10）：ABP設定管理
阿新 • • 發佈：2020-09-17
Tips：本篇已加入系列文章閱讀目錄，可點選檢視更多相關文章。
[TOC]
# 前言
上一篇介紹了ABP模組化開發的基本步驟，完成了一個簡單的檔案上傳功能。通常的模組都有一些自己的配置資訊，比如上篇講到的`FileOptions`類，其中配置了檔案的上傳目錄，允許的檔案大小和允許的檔案型別。配置資訊可以通過[Configuration](https://docs.abp.io/zh-Hans/abp/latest/Configuration)（配置）和[Options](https://docs.abp.io/zh-Hans/abp/latest/Options)（選項）來完成，ABP還提供了另一種更靈活的方式： [Settings](https://docs.abp.io/zh-Hans/abp/latest/Settings)（設定），本篇就來介紹一下ABP的設定管理。
# 開始
回顧一下上篇的`FileOptions`：
首先定義了一個`FileOptions`類，其中包含了幾個配置，然後在需要的地方中注入`IOptions`就可以使用這些資訊了。
當然，模組啟動時可以做一些配置修改，比如：
無論是配置檔案還是這種程式碼形式的配置，都是程式層面的修改；有些配置不太適合這樣做，比如這裡的`AllowedMaxFileSize`和`AllowedUploadFormats`，它們應該在應用介面上，可以讓管理員自行修改。下面就來改造一下程式。
## 定義設定
使用設定之前需要先定義它，不同的模組可以擁有不同的設定。
modules\file-management\src\Xhznl.FileManagement.Domain\Settings\FileManagementSettingDefinitionProvider.cs：
```csharp
public class FileManagementSettingDefinitionProvider : SettingDefinitionProvider
{
public override void Define(ISettingDefinitionContext context)
{
/* Define module settings here.
* Use names from FileManagementSettings class.
*/
context.Add(new SettingDefinition(
FileManagementSettings.AllowedMaxFileSize,
"1024",
L("DisplayName:FileManagement.AllowedMaxFileSize"),
L("Description:FileManagement.AllowedMaxFileSize")
)
.WithProperty("Group1", "File")
.WithProperty("Group2", "Upload")
.WithProperty("Type", "number"),
new SettingDefinition(
FileManagementSettings.AllowedUploadFormats,
".jpg,.jpeg,.png,.gif,.txt",
L("DisplayName:FileManagement.AllowedUploadFormats"),
L("Description:FileManagement.AllowedUploadFormats")
)
.WithProperty("Group1", "File")
.WithProperty("Group2", "Upload")
.WithProperty("Type", "text")
);
}
private static LocalizableString L(string name)
{
return LocalizableString.Create(name);
}
}
```
以上程式碼定了了2個配置：`AllowedMaxFileSize`和`AllowedUploadFormats`，設定了它們的預設值、名稱和詳細說明。因為本專案使用了EasyAbp的SettingUi模組，所以會有一些`Group1`，`Group2`之類的欄位，具體介紹可以參考[Abp.SettingUi](https://github.com/EasyAbp/Abp.SettingUi)
## 使用設定
想讀取設定資訊，只需注入`ISettingProvider`即可。因為父類`ApplicationService`中已經注入，所以這裡直接使用`SettingProvider`就好。獲取到配置，然後就可以做一些邏輯處理，比如判斷上傳檔案的大小和格式是否合法：
```csharp
public class FileAppService : FileManagementAppService, IFileAppService
{
......
[Authorize]
public virtual async Task CreateAsync(FileUploadInputDto input)
{
var allowedMaxFileSize = await SettingProvider.GetAsync(FileManagementSettings.AllowedMaxFileSize);//kb
var allowedUploadFormats = (await SettingProvider.GetOrNullAsync(FileManagementSettings.AllowedUploadFormats))
?.Split(",", StringSplitOptions.RemoveEmptyEntries);
if (input.Bytes.Length > allowedMaxFileSize * 1024)
{
throw new UserFriendlyException(L["FileManagement.ExceedsTheMaximumSize", allowedMaxFileSize]);
}
if (allowedUploadFormats == null || !allowedUploadFormats.Contains(Path.GetExtension(input.Name)))
{
throw new UserFriendlyException(L["FileManagement.NotValidFormat"]);
}
......
}
}
```
前端設定介面：
下面可以隨便修改下設定，進行測試：
# 最後
本篇內容較少，希望對你有幫助。程式碼已上傳至 https://github.com/xiajingren/HelloAbp ，歡迎