开源 - Ideal库 - 枚举扩展设计思路及实现难点(三)

今天想和大家分享关于枚举扩展设计思路和在实现过程中遇到的难点。

在这里插入图片描述

01、设计思路

设计思路说起来其实也很简单,就是通过枚举相关信息:枚举值、枚举名、枚举描述、枚举项、枚举类型,进行各种转换,通过一个信息获取其他信息。比如通过枚举项获取枚举描述、通过枚举类型获取枚举名称-枚举描述键值对用于下拉列表等等。

主要包括以下几类转换实现:

(1)通过枚举值转成:枚举、枚举名称、举描述;

(2)通过枚举名称转成:枚举、枚举值、枚举描述;

(3)通过枚举描述转成:枚举、枚举值、枚举名称;

(4)通过枚举项转成:枚举值、枚举描述;

(5)通过枚举类型转成:枚举值-枚举名称、枚举值-枚举描述、枚举名称-枚举值、枚举名称-枚举描述、枚举描述-枚举值、枚举描述-枚举名称等键值对集合;

02、实现难点

在实现过程中的确遇到一些难点以及需要注意的小细节。

1、枚举名称转枚举中的小细节

在实现枚举名称转枚举的过程中遇到了一个小坑。

枚举本身提供了Enum.TryParse方法用于把枚举名称字符串或者枚举值字符串转为枚举,因此我们选用了此方法实现枚举名称转枚举。但是我们自己这个接口设计目标是把枚举名称转为枚举,因此需要排除误传枚举值字符串的情况。

方案:当转换成功后,我们还需要调用Enum.IsDefined方法检查枚举名称字符串是否是有效的枚举名称字符串,如果不是枚举中现有的有效枚举项,还需要考虑是否为位标志组合情况。

代码如下:

//根据枚举名称转换成枚举,转换失败则返回空
public static TEnum? ToEnumByName<TEnum>(this string name)where TEnum : struct, Enum
{//转换成功则返回结果,否则返回空if (Enum.TryParse<TEnum>(name, out var result)){//检查是否为有效的枚举名称字符串,if (Enum.IsDefined(typeof(TEnum), name)){//返回枚举return result;}else{//计算是否为有效的位标志组合项var isValidFlags = IsValidFlagsMask<ulong, TEnum>(result.ToEnumValue<ulong>());//如果是有效的位标志组合项则返回枚举,否则返回空return isValidFlags ? result : default(TEnum?);}}//返回空return default;
}

2、枚举描述转枚举中的小细节

在实现枚举描述转枚举的过程中对于带位标志枚举处理需要特别小心。我们知道位标志枚举有个特性是枚举项之间可以通过位操作进行组合得到一个有效的枚举项,而且这个枚举项还不存在于当前定义的枚举中。这就要求我们必须处理好组合情况。

方案:因此可以按照以下步骤进行处理。

(1)优先处理当枚举不带位标志的情况;

(2)再处理带位标志的情况;

位标志组合是通过英文逗号[,]拼接的,因此还要考虑到如果一个描述字符串中带有英文逗号[,],但是本身又不是组合的情况。

(3)先把描述当作不是组合情况,先处理一遍,如果转换成功则结束转换;

(4)如果是组合的情况,则计算出组合的每项枚举值,通过位操作得到其对应的枚举项;

而在组合的情况中还需要考虑,如果有组合的项时无效的情况,则这个枚举描述转换应该标记为无效。

(5)判断组合的每一项都是正确的,否则返回空;

(6)将通过组合计算出来的枚举项转为枚举;

因为通过枚举值转枚举过程中还需要明确枚举值类型才行,因此最后一步还需要根据枚举类型实际的基础类型调用不同的转换方法。

具体代码如下:

//根据枚举描述转换成枚举,转换失败返回空
public static TEnum? ToEnumByDesc<TEnum>(this string description)where TEnum : struct, Enum
{var type = typeof(TEnum);var info = GetEnumTypeInfo(type);//不是位标志枚举的情况处理if (!info.IsFlags){return ToEnumDesc<TEnum>(description);}//是位标志枚举的情况处理//不是组合位的情况,本身可能就包含[,]var tenum = ToEnumDesc<TEnum>(description);if (tenum.HasValue){return tenum;}//如果不包含[,],则直接返回if (!description.Contains(',')){return default;}//是组合位的情况var names = description.Split(',');var values = Enum.GetValues(type);//记录有效枚举描述个数var count = 0;ulong mask = 0L;//变量枚举所有项foreach (var name in names){foreach (Enum value in values){//取枚举项描述与目标描述相比较,相同则返回该枚举项if (value.ToEnumDesc() == name){//有效枚举个数加1count++;//将枚举值转为long类型var valueLong = Convert.ToUInt64(value);// 过滤掉负数或无效的值,规范的位标志枚举应该都为非负数if (valueLong >= 0){//合并枚举值至maskmask |= valueLong;}break;}}}//如果两者不相等,说明描述字符串不是一个有效组合项if (count != names.Length){return default;}var underlyingType = Enum.GetUnderlyingType(type);if (underlyingType == typeof(byte)){return ((byte)mask).ToEnumByValue<TEnum>();}else if (underlyingType == typeof(sbyte)){return ((sbyte)mask).ToEnumByValue<TEnum>();}else if (underlyingType == typeof(short)){return ((short)mask).ToEnumByValue<TEnum>();}else if (underlyingType == typeof(ushort)){return ((ushort)mask).ToEnumByValue<TEnum>();}else if (underlyingType == typeof(int)){return ((int)mask).ToEnumByValue<TEnum>();}else if (underlyingType == typeof(uint)){return ((uint)mask).ToEnumByValue<TEnum>();}else if (underlyingType == typeof(long)){return ((long)mask).ToEnumByValue<TEnum>();}else if (underlyingType == typeof(ulong)){return mask.ToEnumByValue<TEnum>();}return default;
}

3、枚举转枚举值中的小细节

我们知道在定义枚举的时候可以指定枚举值类型为以下八种类型sbyte、byte、short、ushort、int、uint、long、ulong,因此所有涉及到返回枚举值的方法,我们要考虑到支持不同类型的枚举值类型返回。

同时我们也知道相同的方法名和入参,并不能通过不同的返回类型区分出不同的重载方法。

方案:因此我们可以通过泛型的方法支持不同类型的枚举值类型返回。

4、通过枚举值转换的小细节

通过上面我们知道枚举值类型有八种,因此涉及到枚举值转换出其他信息是需要同时兼容这八种类型。

要实现这个功能,可以用上面提到的泛型,如果使用泛型我们可以使用struct类型来限制枚举值泛型TValue,因为struct可以覆盖枚举值的八种类型,但是也引发了另一个问题就是float、double、DateTime都是struct类型,这样就导致这些类型在编辑器中也可以点出ToEnumByValue等相关方法。

作为一个公共封装方法,这种方式显然是对用户不友好的。

因此我们选择另外一种方式:重载方法来实现,通过封装方法多写一些代码来实现对用户友好调用。

在这里插入图片描述

5、如何高效返回键值对数据

在通过枚举类型转成各种键值对集合时,有些方法需要用到反射,因此如何高效的获取这些信息就变成重中之重。

最直接的想法是直接把每种枚举类型对应的键值对集合直接缓存起来,下次用到的时候直接从缓存中获取即可。

但是仔细详细,一共有3个数据:枚举值、枚举名称、枚举描述。两两组合有6种情况,也就是要6个缓存存储12个数据,这样其实就相当于浪费了3倍的空间。

当然我们可以把这三个值存一份,然后在需要的是直接组合获取,但是我们仔细分析一些是否有必要把所有数据都缓存下来。

枚举值会涉及到类型转换,枚举名称涉及调用ToString方法,枚举描述需要用到反射。这其中最好性能的非枚举描述不可,因此枚举描述肯定需要缓存,枚举值和枚举名称可以考虑缓存。

假如我们只缓存枚举描述,那么枚举值和枚举名称在使用的时候直接转换,那么我们执行要一份记录枚举描述的缓存以及一份记录枚举类型对应其所有枚举项的缓存即可。另外因为枚举对应的是否带位标志标记以及掩码可以同时记录下来。

代码如下:

public static partial class EnumExtension
{//枚举类型基础信息private sealed class EnumTypeInfo{//是否是位标志public bool IsFlags { get; set; }//枚举掩码public ulong Mask { get; set; }//枚举项集合public List<Enum> Items { get; set; } = [];}//存储枚举项对应的描述private static readonly ConcurrentDictionary<Enum, string> _descs = new();//存储枚举相关信息

获取枚举名称-枚举描述键值对代码如下,首先获取枚举类型基础信息,然后把枚举项集合转为键值对集合。

//获取枚举名称+枚举描述
public static Dictionary<string, string> ToEnumNameDescs(this Type type)
{//根据type获取枚举类型基础信息var info = GetEnumTypeInfo(type);//通过枚举项集合转为目标类型return info.Items.ToDictionary(r => r.ToString(), r => r.ToEnumDesc());
}

6、如何识别一个枚举值是否为有效的位标志组合

如何识别一个枚举值是否是一个有效的位标志组合,可以说是整个代码中最难的部分了,其实前面也有提到,主要应用掩码的思想,上一章节已经详解讲解了这里就不在赘述了。

稍晚些时候我会把库上传至Nuget,大家可以直接使用Ideal.Core.Common。

:测试方法代码以及示例源码都已经上传至代码库,有兴趣的可以看看。https://gitee.com/hugogoos/Ideal

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.xdnf.cn/news/18900.html

如若内容造成侵权/违法违规/事实不符,请联系一条长河网进行投诉反馈,一经查实,立即删除!

相关文章

学习笔记021——Ubuntu 安装 MySQL 5.7版本

本文通过是Ubuntu自带的apt安装的。 目录 1、查看可安装 MySQL 版本 2、安装 3、设置密码、开启远程访问 4、修改 sql_mode 和 设置 不区分大小写。&#xff08;根据自己需求来定&#xff09; 5、改端口等设置&#xff1a; 6、启动命令 7、验证 1、查看可安装 MySQL 版…

IDE配置tomcat

1.导航到 Tomcat 安装目录 E:\apache-tomcat-9.0.95-windows-x64\apache-tomcat-9.0.95 2.启动 Tomcat 服务&#xff1a;bin\startup.bat

STL关联式容器之平衡二叉搜索树

平衡二叉搜索树 在STL关联式容器介绍-CSDN博客中对二叉搜索树做了简要的描述&#xff1b;但是因为没有对二叉搜索树对数的深度及插入后树的结构进行调整&#xff0c;二叉搜索树可能失去平衡&#xff0c;造成搜寻效率低落的情况。如下所示&#xff1a; 所谓树形平衡与否&#xf…

集群聊天服务器(13)redis环境安装和发布订阅命令

目录 环境安装订阅redis发布-订阅的客户端编程环境配置客户端编程 环境安装 sudo apt-get install redis-server 先启动redis服务 /etc/init.d/redis-server start默认在6379端口上 redis是存键值对的&#xff0c;还可以存链表、数组等等复杂数据结构 而且数据是在内存上存…

微信小程序 最新获取用户头像以及用户名

一.在小程序改版为了安全起见 使用用户填写来获取头像以及用户名 二.代码实现 <view class"login_box"><!-- 头像 --><view class"avator_box"><button wx:if"{{ !userInfo.avatarUrl }}" class"avatorbtn" op…

视频智能分析软件LiteAIServer视频智能分析平台玩手机打电话检测算法

在当今这个数字化时代&#xff0c;智能手机已成为我们日常生活中不可或缺的一部分&#xff0c;它极大地便利了我们的沟通与学习。然而&#xff0c;当这份便利被不恰当地带入到如工厂生产线、仓库以及学校课堂等特定的工作和学习环境中时&#xff0c;其潜在的危害便逐渐显露出来…

【pytest】pytest注解使用指南

前言&#xff1a;在 pytest 测试框架中&#xff0c;注解&#xff08;通常称为装饰器&#xff09;用于为测试函数、类或方法提供额外的信息或元数据。这些装饰器可以影响测试的执行方式、报告方式以及测试的组织结构。pytest 提供了多种内置的装饰器&#xff0c;以及通过插件扩展…

gvim添加至右键、永久修改配置、放大缩小快捷键、ctrl + c ctrl +v 直接复制粘贴、右键和还原以前版本(V)冲突

一、将 vim 添加至右键 进入安装目录找到 vim91\install.exe 管理员权限执行 Install will do for you:1 Install .bat files to use Vim at the command line:2 Overwrite C:\Windows\vim.bat3 Overwrite C:\Windows\gvim.bat4 Overwrite C:\Windows\evim.bat…

一文快速掌握 AMD FPGA IO约束 常用电平标准

FPGA开发中IO约束是不可缺少的部分&#xff0c;正确的电平约束是确保电路稳定运行与兼容性的关键所在。 今天分享下IO约束中常用的电平标准&#xff0c;帮助大家快速理解和掌握。 一、 LVTTL系列 LVTTL全称为Low - Voltage Transistor - Transistor Logic&#xff0c;是一种…

没钱买KEGG怎么办?REACTOME开源通路更强大

之前搜集免费生物AI插图时简单提到了通路数据库Reactome&#xff08;https://reactome.org/&#xff09;&#xff0c; 那些精美的生物插图只能算是该数据库附赠的小礼品&#xff0c;他的主要功能还是作为一个开源的通路数据库&#xff0c;为相关领域的研究者提供直观的可视化生…

ubuntu显示管理器_显示导航栏

ubuntu文件管理器_显示导航栏 一、原始状态&#xff1a; 二、显示导航栏状态&#xff1a; 三、原始状态--->导航栏状态: 1、打开dconf编辑器&#xff0c;直接在搜索栏搜索 dconf-editor ------如果没有安装&#xff0c;直接按流程安装即可。 2、进入目录&#xff1a;org …

mysql的基本操作

各位小伙伴们&#xff0c;好久不见呀&#xff01;最近博主也因为个人原因&#xff0c;实在是太忙&#xff0c;才导致最近的文章一直没更新&#xff0c;当然本篇文章依旧还是会给大家带来知识点的学习&#xff0c;闲话少叙&#xff0c;我们直接进入正题。 目录 数据库的创建及使…

6.k8s:devops

目录 一、devOps整体流程 二、GitLab 1.GitLab安装 2.GitLab基础配置 (1)修改密码 (2)不启用头像 (3)关闭用户注册功能 (4)开启webhook外部访问 (5) 设置中文 3.配置secret 4.卸载gitlab 三、Harbor镜像仓库 1.安装好docker-compose 2.安装harbor 四、…

分布式IO模块:智慧楼宇的“智慧眼”与“智慧手”

在现代化的城市建设中&#xff0c;智慧楼宇作为一种集成了建筑、通信、计算机和控制等多方面技术的新型建筑&#xff0c;正逐渐成为城市发展的重要驱动力。智慧楼宇不仅提高了建筑设备的运行效率&#xff0c;降低了能源消耗&#xff0c;还提供了更加安全、舒适和便捷的生活办公…

【IOS】编译缓存错误Library/Caches/com.apple.mobile.installd.staging

项目场景&#xff1a; xcode ios 问题描述 Failed to load Info.plist from bundle at path /var/installd/Library/Caches/com.apple.mobile.installd.staging/temp.FOrCHQ/extracted/xxxxModule_Example.app/Frameworks/Foundation.framework; Extra info about "/va…

ARM64环境部署EFK8.15.3收集K8S集群容器日志

环境规划 主机IP系统部署方式ES版本CPU架构用户名密码192.168.1.225Ubuntu 22.04.4 LTSdockerelasticsearch:8.15.3ARM64elasticllodyi4TMmZD ES集群部署 创建持久化目录(所有节点) mkdir -p /data/es/{data,certs,logs,plugins} mkdir -p /data/es/certs/{ca,es01}服务器…

【网络安全 | 漏洞挖掘】邮件HTML注入

文章目录 Email 中的 HTML 注入漏洞漏洞挖掘过程1. 初步信息收集2. 发现私信功能3. 功能测试与 HTML 注入测试测试步骤请求拦截与分析4. 绕过防护机制绕过方法附加威胁漏洞影响漏洞报告与奖励Email 中的 HTML 注入漏洞 HTML 注入是一种安全漏洞,攻击者通过将任意 HTML 标签注…

《自定义类型:结构体》

1. 结构体回顾 结构体的声明 结构体的初始化 2. 结构体的特殊声明 匿名结构体&#xff1a; 不需要给结构体名字&#xff0c;但是只能使用一次。 这里的使用一次具体是什么意思呢&#xff0c;刚开始学的时候我自己的理解是有误解的&#xff0c;下面给出一个示例; 注意&…

基于Java Springboot城市公交运营管理系统

一、作品包含 源码数据库设计文档万字PPT全套环境和工具资源部署教程 二、项目技术 前端技术&#xff1a;Html、Css、Js、Vue、Element-ui 数据库&#xff1a;MySQL 后端技术&#xff1a;Java、Spring Boot、MyBatis 三、运行环境 开发工具&#xff1a;IDEA/eclipse 数据…

【杂谈】无人机测绘技术知识

无人机测绘技术知识 随着科技技术的不断进步和低空经济的快速推进&#xff0c;无人机技术已经从最初的军事侦察、航拍娱乐&#xff0c;逐渐深入到各个行业领域&#xff0c;其中无人机测绘技术&#xff08;航空摄影测量&#xff09;更是凭借其高效、精准、灵活的特性&#xff0…