点击上方蓝字"小黑在哪里"关注我吧
定义设置
使用设置
前言
上一篇介绍了ABP模块化开发的基本步骤,完成了一个简单的文件上传功能。通常的模块都有一些自己的配置信息,比如上篇讲到的FileOptions
类,其中配置了文件的上传目录,允许的文件大小和允许的文件类型。配置信息可以通过Configuration[1](配置)和Options[2](选项)来完成,ABP还提供了另一种更灵活的方式:Settings[3](设置),本篇就来介绍一下ABP的设置管理。
开始
回顾一下上篇的FileOptions
:
![](https://i-blog.csdnimg.cn/blog_migrate/2b3cc99b92b05751f1ae38a3ebc04e31.png)
首先定义了一个FileOptions
类,其中包含了几个配置,然后在需要的地方中注入IOptions<FileOptions>
就可以使用这些信息了。
当然,模块启动时可以做一些配置修改,比如:
![](https://i-blog.csdnimg.cn/blog_migrate/6aff289d64fc2313f805e807a84fa6cf.png)
无论是配置文件还是这种代码形式的配置,都是程序层面的修改;有些配置不太适合这样做,比如这里的AllowedMaxFileSize
和AllowedUploadFormats
,它们应该在应用界面上,可以让管理员自行修改。下面就来改造一下程序。
定义设置
使用设置之前需要先定义它,不同的模块可以拥有不同的设置。
modules\file-management\src\Xhznl.FileManagement.Domain\Settings\FileManagementSettingDefinitionProvider.cs:
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<FileManagementResource>(name);
}
}
以上代码定了了2个配置:AllowedMaxFileSize
和AllowedUploadFormats
,设置了它们的默认值、名称和详细说明。因为本项目使用了EasyAbp的SettingUi模块,所以会有一些Group1
,Group2
之类的字段,具体介绍可以参考Abp.SettingUi[4]
使用设置
想读取设置信息,只需注入ISettingProvider
即可。因为父类ApplicationService
中已经注入,所以这里直接使用SettingProvider
就好。获取到配置,然后就可以做一些逻辑处理,比如判断上传文件的大小和格式是否合法:
public class FileAppService : FileManagementAppService, IFileAppService
{
......
[Authorize]
public virtual async Task<string> CreateAsync(FileUploadInputDto input)
{
var allowedMaxFileSize = await SettingProvider.GetAsync<int>(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://i-blog.csdnimg.cn/blog_migrate/5faee095716fb607ad12ec913ea60a56.png)
下面可以随便修改下设置,进行测试:
![](https://i-blog.csdnimg.cn/blog_migrate/217ccebd64ef50175daf7892f1a74328.png)
最后
本篇内容较少,希望对你有帮助。代码已上传至 https://github.com/xiajingren/HelloAbp ,欢迎star。
参考资料
[1]
Configuration: https://docs.abp.io/zh-Hans/abp/latest/Configuration
[2]Options: https://docs.abp.io/zh-Hans/abp/latest/Options
[3]Settings: https://docs.abp.io/zh-Hans/abp/latest/Settings
[4]Abp.SettingUi: https://github.com/EasyAbp/Abp.SettingUi
如果本文对您有用,
不妨点个“在看”或者转发朋友圈支持一下