ABP理论学习之功能管理

简介:

本篇目录

介绍

大多数的Saas(多租户)应用都有不同 功能的 版本(包)。因此,他们可以给租户(客户)提供不同的 价格和功能选项

ABP提供了功能系统使得这个更简单。我们可以 定义功能,然后检查某个功能是否对一个租户 开启了,最后将功能系统 集成到其他的ABP概念中(如权限和菜单)。

关于IFeatureValueStore

功能系统使用了IFeatureValueStore来获得功能的值。虽然你可以用自己的方式实现该接口,但是它已经完全实现在了 module-zero项目中。如果没有实现该接口,那么默认会使用NullFeatureValueStore对所有的功能返回null(此时使用默认的功能值)。

功能类型

有两种基本功能类型。

布尔功能

可以是"true"或"false"。这种类型的功能(对于一个版本或者一个租户)可能是开启的或者 关闭的

值功能

可以是任意值。虽然它是以字符串存储和检索的,但是数值也可以轻松地存储为字符串。

比如,我们的应用程序可能是一个任务管理应用,我们可能在一个月内对于创建任务会有限制。假如说我们有两个不同的版本:一个版本每个月允许创建1000个任务,但是另一个每个月允许创建5000个任务。因此,这个功能应该存储为值,而不是简单的true或false。

定义功能

在检查功能之前应该先定义功能。一个模块可以通过从FeatureProvider类派生来定义自己的功能。这里有一个定义了3个功能的非常简单的功能提供者:

public class AppFeatureProvider : FeatureProvider
{
    public override void SetFeatures(IFeatureDefinitionContext context)
    {
        var sampleBooleanFeature = context.Create("SampleBooleanFeature", defaultValue: "false");
        sampleBooleanFeature.CreateChildFeature("SampleNumericFeature", defaultValue: "10");
        context.Create("SampleSelectionFeature", defaultValue: "B");
    }
}

创建功能提供者之后,我们应该在模块的PreInitialize方法中注册,如下所示:

Configuration.Features.Providers.Add<AppFeatureProvider>();

基本功能属性

一个功能的定义至少要求两个属性:

  • Name:识别该功能唯一的名字(字符串)。
  • DefaultValue:默认值。当我们需要该功能的值时会用到该属性,而且对于当前的租户不可用。

上面的代码样例中,我们定义了一个名为"SampleBooleanFeature"布尔功能,它的默认值是"false"(不可用)。我们也定义了两个值功能(SampleNumericFeature定义为SampleBooleanFeature的孩子)。

提示:为功能名称创建一个常量字符串,然后在任何地方使用时会防止拼写失误。

其他功能属性

虽然对于ABP来说一个唯一的名称和默认值属性已经足够了,但是对于细节的控制还有许多其他的功能属性。

  • Scope:FeatureScope枚举值之一。它可以是Edition(如果只为版本级别设置该功能), Tenant(如果只为租户级别设置该功能),或者 All(如果为版本和租户都可以设置该功能,这种情况下,租户的设置会覆盖版本的设置)。默认值是All。
  • DisplayName:给用户显示该功能名称的本地化字符串。
  • Description:给用户显示该功能细节描述的本地化字符串。
  • InputType:该功能的UI输入类型。
  • Attributes:任意的自定义键值对字典,可以和该功能关联起来。

让我们看一下该功能的细节定义:

public class AppFeatureProvider : FeatureProvider
{
    public override void SetFeatures(IFeatureDefinitionContext context)
    {
        var sampleBooleanFeature = context.Create(
            AppFeatures.SampleBooleanFeature,
            defaultValue: "false",
            displayName: L("Sample boolean feature"),
            inputType: new CheckboxInputType()
            );

        sampleBooleanFeature.CreateChildFeature(
            AppFeatures.SampleNumericFeature,
            defaultValue: "10",
            displayName: L("Sample numeric feature"),
            inputType: new SingleLineStringInputType(new NumericValueValidator(1, 1000000))
            );

        context.Create(
            AppFeatures.SampleSelectionFeature,
            defaultValue: "B",
            displayName: L("Sample selection feature"),
            inputType: new ComboboxInputType(
                new StaticLocalizableComboboxItemSource(
                    new LocalizableComboboxItem("A", L("Selection A")),
                    new LocalizableComboboxItem("B", L("Selection B")),
                    new LocalizableComboboxItem("C", L("Selection C"))
                    )
                )
            );
    }

    private static ILocalizableString L(string name)
    {
        return new LocalizableString(name, AbpZeroTemplateConsts.LocalizationSourceName);
    }
}

注意:ABP没有使用这里的InputType。当为功能创建输入时,应用程序会使用它们。ABP只是提供了这些选项使得它更容易。

功能层次

正如样例功能提供者所示,一个功能可以有子功能。一个父母功能一般定义为 布尔功能。只有父母功能可用时,孩子功能才可用。ABP不强制这样做,但是建议这样做。

检查功能

使用RequireFeature特性

我们可以为方法或类使用RequiredFeature特性,如下所示:

[RequiresFeature("ExportToExcel")]
public async Task<FileDto> GetReportToExcel(...)
{
    ...
}

该方法只有在"ExportToExcel"功能对当前租户开启时才会执行(当前租户从IAbpSession中获得)。如果没有开启该功能,那么就会自动抛出 AbpAuthorizationException

当然,RequiresFeature特性应该用于布尔类型功能。否则,你会得到异常。

RequiresFeature特性注意点
ABP对于功能检查使用了强大的动态方法拦截(interception)。因此,为方法使用RequiresFeature特性时有一些限制条件:

  • 不能用于私有方法。
  • 不能用于静态方法。
  • 不能用于非注入类的方法(我们必须使用DI)。

此外,

  • 如果该方法是通过一个接口(如应用服务通过接口调用)调用的,那么我们可以将它用于任何 public的方法。
  • 如果一个方法直接从类的引用调用(如MVC或Web API控制器),那么它应该是virtual的。
  • 如果一个方法是protected,那么该方法应该是 virtual

使用IFeatureChecker

我们可以注入并使用IFeatureChecker来手动检查一个功能(对于应用服务,MVC和Web API控制器,它会自动注入而且直接可以使用)。

IsEnabled

用于简单地检查给定的功能是否开启。例子:

public async Task<FileDto> GetReportToExcel(...)
{
    if (await FeatureChecker.IsEnabledAsync("ExportToExcel"))
    {
        throw new AbpAuthorizationException("You don't have this feature: ExportToExcel");
    }
    
    ...
}

IsEnabledAsync和其他方法都有同步版本。

当然,IsEnabled方法应该用于布尔类型功能。否则可能会抛异常。

如果你只想检查一个功能,然后抛出例子中的异常,那么你只需要使用CheckEnabled方法就行了。

GetValue

用于获得值类型功能的当前值,例子:

var createdTaskCountInThisMonth = GetCreatedTaskCountInThisMonth();
if (createdTaskCountInThisMonth >= FeatureChecker.GetValue("MaxTaskCreationLimitPerMonth").To<int>())
{
    throw new AbpAuthorizationException("You exceed task creation limit for this month, sorry :(");
}

FeatureChecker方法也有对于特定租户的重载,不仅仅只对于当前的租户。

客户端

在客户端,我们使用abp.features命名空间来获得该功能的当前值。

isEnabled

var isEnabled = abp.features.isEnabled('SampleBooleanFeature');

getValue

var value = abp.features.getValue('SampleNumericFeature');

功能管理者

如果需要定义功能,可以注入并使用IFeatureManager

版本说明

ABP没有内置的版本系统,因为这么个系统要求数据库(存储版本,版本功能,租户-版本映射等等)。因此,版本系统实现在了module-zero中了。使用它你可以轻松地拥有一个版本系统,要不然你可以自己实现。





本文转自tkbSimplest博客园博客,原文链接:http://www.cnblogs.com/farb/p/ABPFeatures.html,如需转载请自行联系原作者

目录
相关文章
|
机器学习/深度学习 计算机视觉
【Tied-Augment】卷出新花样:加强数据增强的有效性!从一篇顶刊论文中窥探的一些信息,
【Tied-Augment】卷出新花样:加强数据增强的有效性!从一篇顶刊论文中窥探的一些信息,
356 0
【Tied-Augment】卷出新花样:加强数据增强的有效性!从一篇顶刊论文中窥探的一些信息,
|
2月前
|
数据采集 JSON BI
京东评论API能挖出多少“神评”?用代码揭秘用户真实反馈
京东商品评论API提供商品全量评论数据,支持按评分、时间筛选及分页获取,返回120+字段与口碑统计,具备高并发、低延迟、数据安全等特性,助力电商分析与决策。
|
1月前
|
资源调度 JavaScript Linux
Node.js 编程实战:安装 Node.js 与 npm / yarn
学习 Node.js 前需先正确安装与配置运行环境。推荐使用 LTS 版本,通过 nvm 等工具管理多版本,配合 npm 或 yarn 统一管理依赖。不同系统可采用对应安装方式,安装后验证版本并确保环境变量配置正确,为后续开发打下稳定基础。(238 字)
|
2月前
|
弹性计算 人工智能
阿里云优惠券:免费领取、代金券查询及使用方法,购买云服务器省钱方法
阿里云优惠券免费领!个人可领12张代金券(总值2088元)+6折折上折券,企业享5亿算力补贴,学生领300元无门槛券。下单结算自动抵扣,查券路径:费用与成本-账户-卡券。先领券再购买,省钱必备!
151 0
|
存储 安全 网络安全
勒索病毒不再可怕:.baxia病毒解密与预防策略
本文深入分析了.baxia勒索病毒的特点,探讨数据恢复方法及预防措施,旨在帮助个人和企业有效应对这一网络威胁,确保数据安全。文章还提供了技术服务号(sjhf91),为用户提供专业的数据恢复支持。
636 3
|
存储 分布式计算 分布式数据库
大数据技术原理与应用 期末复习 知识点全总结(林子雨版
大数据技术原理与应用 期末复习 知识点全总结(林子雨版
3591 1
|
人工智能 安全 物联网
什么是分布式防火墙?
【8月更文挑战第23天】
677 0
什么是分布式防火墙?
|
监控 数据挖掘 索引
深度剖析Sentinel热点规则
深度剖析Sentinel热点规则
404 1
|
XML Linux 应用服务中间件
centos7搭建minio并实现分享路径为域名路径
centos7搭建minio并实现分享路径为域名路径
1410 0
|
网络协议 网络架构 网络安全
【转】网络拓扑发现原理研究
http://hi.baidu.com/renyijiu/blog/item/4ad68246b18aec0d6b63e5d3.html     1.背景描述     随着信息时代的到来,对计算机网络的依赖使得计算机网络本身运行的可靠性变得至关重要,对网络管理也就有了更高的要求。
2175 0

热门文章

最新文章