初识ABP vNext(10):ABP设置管理

初识ABP vNext(10):ABP设置管理

Tips:本篇已加入系列文章阅读目录,可点击查看更多相关文章。

前言

上一篇介绍了ABP模块化开发的基本步骤,完成了一个简单的文件上传功能。通常的模块都有一些自己的配置信息,比如上篇讲到的FileOptions类,其中配置了文件的上传目录,允许的文件大小和允许的文件类型。配置信息可以通过Configuration(配置)和Options(选项)来完成,ABP还提供了另一种更灵活的方式: Settings(设置),本篇就来介绍一下ABP的设置管理。

开始

回顾一下上篇的FileOptions

<span>初识ABP vNext(10):ABP设置管理</span>

首先定义了一个FileOptions类,其中包含了几个配置,然后在需要的地方中注入IOptions<FileOptions>就可以使用这些信息了。

当然,模块启动时可以做一些配置修改,比如:

<span>初识ABP vNext(10):ABP设置管理</span>

无论是配置文件还是这种代码形式的配置,都是程序层面的修改;有些配置不太适合这样做,比如这里的AllowedMaxFileSizeAllowedUploadFormats,它们应该在应用界面上,可以让管理员自行修改。下面就来改造一下程序。

定义设置

使用设置之前需要先定义它,不同的模块可以拥有不同的设置。

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个配置:AllowedMaxFileSizeAllowedUploadFormats,设置了它们的默认值、名称和详细说明。因为本项目使用了EasyAbp的SettingUi模块,所以会有一些Group1Group2之类的字段,具体介绍可以参考Abp.SettingUi

使用设置

想读取设置信息,只需注入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"]);
        }

        ......
    }
}

前端设置界面:

<span>初识ABP vNext(10):ABP设置管理</span>

下面可以随便修改下设置,进行测试:

<span>初识ABP vNext(10):ABP设置管理</span>

最后

本篇内容较少,希望对你有帮助。代码已上传至 https://github.com/xiajingren/HelloAbp ,欢迎star。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/2637.html原文链接:https://javaforall.net

(0)
上一篇 2020年11月20日 上午9:33
下一篇 2020年11月20日 上午9:34


相关推荐

  • linux 添加用户到组命令,linux下添加用户组和用户

    linux 添加用户到组命令,linux下添加用户组和用户1 linux 下文件权限管理 添加用户组并添加用户添加组 groupadd 组名 groupadddepl etc group grepdeploy 如图 删除组 groupdel 组名 groupdeldepl etc group grepdeploy 查询组 cat etc group 或者使用管道来精确查询 cat etc group grepdev

    2026年2月15日
    2
  • top命令查看内存信息_ubuntu查看cpu信息

    top命令查看内存信息_ubuntu查看cpu信息top命令是Linux下常用的性能分析工具,能够实时显示系统中各个进程的资源占用状况,类似于Windows的任务管理器。top显示系统当前的进程和其他状况,是一个动态显示过程,即可以通过用户按键来不断刷新当前状态.如果在前台执行该命令,它将独占前台,直到用户终止该程序为止.比较准确的说,top命令提供了实时的对系统处理器的状态监视.它将显示系统中CPU最“敏感”的任务列表.该命令可以按CPU使…

    2026年3月3日
    6
  • 【C语言】getchar 函数的正确使用

    【C语言】getchar 函数的正确使用目录一、getchar函数二、缓冲区1、什么是缓冲区2、为什么要存在缓冲区3、缓冲区的类型4、缓冲区的刷新三、getchar函数的正确使用1、getchar的换行问题2、getchar与scanf的混合使用一、getchar函数从上面的介绍来看,我们要正确使用getchar函数,首先得了解什么是缓冲区。二、缓冲区1、什么是缓冲区缓冲区又称为缓存,它是内存空间的一部分。也就是说,在内存空间中预留了一定的存储空间,这些存储空间用来缓冲输入或输出的数据,这部分预留的空间就叫做缓冲区。

    2022年10月19日
    4
  • ssd 网络详解

    ssd 网络详解本文同步更新在博客园 https www cnblogs com yanghailin p 14871296 htmldefbuild ssd phase size 300 num classes 21 ifphase test andphase train print ERROR Phase phase notrecognize returnifsize 300

    2026年3月19日
    2
  • cf卡,mmc卡,sd卡,sm卡,xd卡,记忆棒的区别是什么?[通俗易懂]

    cf卡,mmc卡,sd卡,sm卡,xd卡,记忆棒的区别是什么?[通俗易懂]乐乐[学长] CF卡(CompactFlash)CF卡是1994年由SanDisk最先推出的。CF卡具有PCMCIA-ATA功能,并与之兼容;CF卡重量只有14g,仅纸板火柴般大小(43mm×36mm×3.3mm),是一种固态产品,也就是工作时没有运动部件。CF卡采用闪存(flash)技术,是一种稳定的存储解决方案,不

    2022年5月27日
    56
  • eplan激活码破解步骤 win10_通用破解码[通俗易懂]

    eplan激活码破解步骤 win10_通用破解码,https://javaforall.net/100143.html。详细ieda激活码不妨到全栈程序员必看教程网一起来了解一下吧!

    2022年3月16日
    448

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号