初识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。

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

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

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • 弗曼学习方法-终极快速学习方法

    弗曼学习方法-终极快速学习方法FEYNMANTECHNIQUE学习方法

  • 基于android的_android studio创建activity

    基于android的_android studio创建activityAndroid如何判断一个应用在运行 在一个应用中,或一个Service、Receiver中判断一个应用是否正在运行,以便进行一些相关的处理。这个时候我们需要得到一个ActivityManager,这个Manager顾名思意就是管理Activity的,它有一个方法叫getRunningTasks,可以得到当前系统正在运行的Task的列表,代码如下:  A

  • 简易旋转倒立摆_小车倒立摆受力分析讲解

    简易旋转倒立摆_小车倒立摆受力分析讲解旋转倒立摆调节经验前言程序框架关于直立关于自动起摆前言近期在做2013年电赛控制类题目–简易旋转倒立摆装置,自己并不是自动化专业的学生,没有学过自动控制原理,倒立摆其实是一个十分经典的自动控制模型,我们只能是边做边学习,逐渐去了解倒立摆。我认为倒立摆有两个难点,一个是自动起摆一个是机械结构,其中自动起摆涉及到PID算法与运动方程的求解,而机械结构主要是尽量减小转动阻尼同时避免旋转时线的缠绕。…

  • target host is null

    target host is null在接口调用的时候出现targethostisnull的异常原因是因为接口地址没有加http://

    2022年10月19日
  • 详解第一范式、第二范式、第三范式、BCNF范式

    详解第一范式、第二范式、第三范式、BCNF范式文章目录第一范式定义以及分析:问题研究:第二范式必备知识点函数依赖:码:非主属性:定义分析:解决办法:问题研究:第三范式:定义:分析:问题研究:BCNF范式分析问题研究小结:第一范式定义以及分析:首先是第一范式(1NF)。符合1NF的关系(你可以理解为数据表。“关系模式”和“关系”的区别,类似于面向对象程序设计中”类“与”对象“的区别。”关系“是”关系模式“的一个实例,你可以把”关系”理解…

  • KindEditor用法介绍「建议收藏」

    KindEditor用法介绍「建议收藏」KindEditor是一套很方便的html编译器插件。在这里做一个简单的使用介绍。首先在官网上下载最新的KindEditor文件(里面有jsp,asp等不同版本文件夹,可以删掉你不需要的版本),把

发表回复

您的电子邮箱地址不会被公开。

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