通过重写 class 的 ToString() 来简化获取 enum 的 DescriptionAttribute 值

目录

一、常见的 enum 类型

  新建一个 AlgorithmType 枚举,里面包含 MD5、SHA1 和 SHA2 等一系列的枚举值,默认为 int 类型。有的时候我们会在对应的枚举值上使用特性 [Description] 来添加备注信息,方便我们后期提供描述信息(如返回给前端界面展示时可能需要使用)。

  AlgorithmType.cs

    /// <summary>
/// 算法类型
/// </summary>
public enum AlgorithmType
{
/// <summary>
/// MD5
/// </summary>
[Description("Message-Digest Algorithm 5")]
MD5, /// <summary>
/// SHA1
/// </summary>
[Description("Secure Hash Algorithm 1")]
SHA1, /// <summary>
/// SHA224
/// </summary>
[Description("Secure Hash Algorithm 224")]
SHA224, /// <summary>
/// SHA256
/// </summary>
[Description("Secure Hash Algorithm 256")]
SHA256, /// <summary>
/// SHA384
/// </summary>
[Description("Secure Hash Algorithm 384")]
SHA384, /// <summary>
/// SHA512
/// </summary>
[Description("Secure Hash Algorithm 512")]
SHA512
}

  常见的一个做法是,编写一个扩展方法来获取 enum 的描述信息:

    public static class EnumExtensionMethods
{
/// <summary>
/// 获取枚举类型的描述信息
/// </summary>
public static string GetDescription(this Enum value)
{
var type = value.GetType();
var name = Enum.GetName(type, value); if (name == null) return null; var field = type.GetField(name); if (!(Attribute.GetCustomAttribute(field, typeof(DescriptionAttribute)) is DescriptionAttribute attribute))
{
return name;
} return attribute.Description;
}
}

  

  因为直接输出枚举值,或者通过枚举类型对应的 ToString() 的方式输出字符串,结果都为它本身的文本值,BCL 也并没有提供快捷的方式去获取描述信息,所以只能通过类似上述的扩展方法来获取 [DescriptionAttribute]。

  

  【分析】因为枚举属于值类型,它不需要在堆上分配空间,并且在计算时(如比较运算)效率相比引用类型更高,所以从性能上枚举类型是占据了绝对的优势;但是由于 BCL 并没有提供快捷方式的去获取 [Description],并且编写对应的获取方法也较为麻烦(其实也不麻烦,因为你会使用程序员的两大法宝:CTRL+C 和 CTRL+V)。

二、演变:class 版本的 enum 类型

  这次我们不直接使用 enum,而是采取新建 class 的方式去模仿 enum 类型,也就是使用引用类型来取代值类型,不过,性能方面会有所损耗。

  HashAlgorithmType.cs

    /// <summary>
/// 哈希算法类型
/// </summary>
public class HashAlgorithmType
{
/// <summary>
/// MD5
/// </summary>
public static readonly HashAlgorithmType MD5 = new HashAlgorithmType(); /// <summary>
/// SHA1
/// </summary>
public static readonly HashAlgorithmType SHA1 = new HashAlgorithmType(); /// <summary>
/// SHA224
/// </summary>
public static readonly HashAlgorithmType SHA224 = new HashAlgorithmType(); /// <summary>
/// SHA256
/// </summary>
public static readonly HashAlgorithmType SHA256 = new HashAlgorithmType(); /// <summary>
/// SHA384
/// </summary>
public static readonly HashAlgorithmType SHA384 = new HashAlgorithmType(); /// <summary>
/// SHA512
/// </summary>
public static readonly HashAlgorithmType SHA512 = new HashAlgorithmType(); private readonly int _hashAlgorithmType; private HashAlgorithmType(int hashAlgorithmType)
{
_hashAlgorithmType = hashAlgorithmType;
} public override string ToString()
{
string result; switch (_hashAlgorithmType)
{
case :
result = "Message-Digest Algorithm 5";
break;
case :
result = "Secure Hash Algorithm 1";
break;
case :
result = "Secure Hash Algorithm 224";
break;
case :
result = "Secure Hash Algorithm 256";
break;
case :
result = "Secure Hash Algorithm 384";
break;
case :
result = "Secure Hash Algorithm 512";
break;
default:
throw new Exception("哈希算法类型有误");
} return result;
}
}

  我们采用了 private 进行构造函数私有化的操作,这样就不会允许在类的外部 new 对象了;其次,使用 public static readonly 字段提供给外部进行访问,这样的话就和枚举类型的调用方式一致;最后,我们对 ToString() 方法进行了重写,在 return 的值中返回对应的描述信息。

  这样,我们就可以直接通过 class.field 的方式得到对应枚举值的描述信息。

  【分析】性能受损;但 ToString() 比 GetDescription() 更浅显直白、清晰明了;不过,参数以数字“写死”的方式进行提供也欠妥。

三、演进:class 和 enum 两者共存的版本

  在上一个版本的类中,我们在进行构造函数初始化时直接使用了数字 0~5,并且重写 ToString() 时也是直接使用数字 0~5,除了不直观的因素之外,随着枚举值数量的增加,枚举值和自身描述两者间的对应关系也容易出错。现在,我们尝试以私有嵌套类的形式将 enum 和 class 的两者有机结合起来。

  HashAlgorithmType.cs

    /// <summary>
/// 哈希算法类型
/// </summary>
public class HashAlgorithmType
{
/// <summary>
/// MD5
/// </summary>
public static HashAlgorithmType MD5 = new HashAlgorithmType(AlgorithmType.MD5); /// <summary>
/// SHA1
/// </summary>
public static readonly HashAlgorithmType SHA1 = new HashAlgorithmType(AlgorithmType.SHA1); /// <summary>
/// SHA224
/// </summary>
public static readonly HashAlgorithmType SHA224 = new HashAlgorithmType(AlgorithmType.SHA224); /// <summary>
/// SHA256
/// </summary>
public static readonly HashAlgorithmType SHA256 = new HashAlgorithmType(AlgorithmType.SHA256); /// <summary>
/// SHA384
/// </summary>
public static readonly HashAlgorithmType SHA384 = new HashAlgorithmType(AlgorithmType.SHA384); /// <summary>
/// SHA512
/// </summary>
public static readonly HashAlgorithmType SHA512 = new HashAlgorithmType(AlgorithmType.SHA512); /// <summary>
/// 算法类型
/// </summary>
private readonly AlgorithmType _algorithmType; private HashAlgorithmType(AlgorithmType algorithmType)
{
_algorithmType = algorithmType;
} public override string ToString()
{
string result; switch (_algorithmType)
{
case AlgorithmType.MD5:
result = "Message-Digest Algorithm 5";
break;
case AlgorithmType.SHA1:
result = "Secure Hash Algorithm 1";
break;
case AlgorithmType.SHA224:
result = "Secure Hash Algorithm 224";
break;
case AlgorithmType.SHA256:
result = "Secure Hash Algorithm 256";
break;
case AlgorithmType.SHA384:
result = "Secure Hash Algorithm 384";
break;
case AlgorithmType.SHA512:
result = "Secure Hash Algorithm 512";
break;
default:
throw new Exception("哈希算法类型有误");
} return result;
} /// <summary>
/// 算法类型
/// </summary>
private enum AlgorithmType
{
/// <summary>
/// MD5
/// </summary>
MD5, /// <summary>
/// SHA1
/// </summary>
SHA1, /// <summary>
/// SHA224
/// </summary>
SHA224, /// <summary>
/// SHA256
/// </summary>
SHA256, /// <summary>
/// SHA384
/// </summary>
SHA384, /// <summary>
/// SHA512
/// </summary>
SHA512
}
}

  在 HashAlgorithmType 类中,新建了一个私有的 AlgorithmType 枚举,这样就只允许 HashAlgorithmType 类访问,而不会在该类的外部(其它类型)进行访问。

  正所谓萝卜青菜,各有所爱,假如你过于关于效率性能,或者说不需要使用诸如 [Description] 附加的特性,也不想额外的增添更多的行为和特征时,我们依然可以采用最原始的、大众化的版本。

通过重写 class 的 ToString() 来简化获取 enum 的 DescriptionAttribute 值的更多相关文章

  1. .Net反射-两种方式获取Enum中的值

    public enum EJobType { 客服 = , 业务员 = , 财务 = , 经理 = } Type jobType = typeof(EJobType); 方式1: Array enum ...

  2. C# 获取Enum 描述和值集合

    //获取枚举的值 public static IEnumerable<T> GetEnumValues<T>() where T : struct { T[] values = ...

  3. request对象常用API 获取请求参数的值 request应用 MVC设计模式

    1 request对象常用API   1)表示web浏览器向web服务端的请求   2)url表示访问web应用的完整路径:http://localhost:8080/day06/Demo1     ...

  4. 安卓Android控件ListView获取item中EditText值

    可以明确,现在没有直接方法可以获得ListView中每一行EditText的值. 解决方案:重写BaseAdapter,然后自行获取ListView中每行输入的EditText值. 大概算法:重写Ba ...

  5. Android控件ListView获取item中EditText值

    能够明白,如今没有直接方法能够获得ListView中每一行EditText的值. 解决方式:重写BaseAdapter,然后自行获取ListView中每行输入的EditText值. 大概算法:重写Ba ...

  6. 获取程序的SHA1值

    android获取程序的SHA1值 public static String getSHA1(Context context) { try { PackageInfo info = context.g ...

  7. 无废话Android之activity的生命周期、activity的启动模式、activity横竖屏切换的生命周期、开启新的activity获取他的返回值、利用广播实现ip拨号、短信接收广播、短信监听器(6)

    1.activity的生命周期 这七个方法定义了Activity的完整生命周期.实现这些方法可以帮助我们监视其中的三个嵌套生命周期循环: (1)Activity的完整生命周期 自第一次调用onCrea ...

  8. Entity Framwork(EF) 7——在Controller内获取指定字段的值

    一.开发背景: 在用户登录的时候,验证用户和密码是否正确.验证通过后将用户名和用户ID保存下来以便后续数据更新时使用. 二.用户验证方法: 1.创建DBContext 对象. ApplicationD ...

  9. jquery attr()方法 添加,修改,获取对象的属性值。

    jquery attr()方法 添加,修改,获取对象的属性值. jquery中用attr()方法来获取和设置元素属性,attr是attribute(属性)的缩写,在jQuery DOM操作中会经常用到 ...

随机推荐

  1. web中的简单全选反选

    <html> <body> <table> <tr> <th><input type="checkbox" onc ...

  2. java_web学习(六) request对象中的get和post差异

    1.get与post的区别 Get和Post方法都是对服务器的请求方式,只是他们传输表单的方式不一样. 下面我们就以传输一个表单的数据为例,来分析get与Post的区别 1.1 get方法  jsp中 ...

  3. nohup—后端守护进程

    要将一个命令放到后台执行,我们一般使用nohup sh command & 为什么要nohup? 因为我用使用Scrt这种终端工具退出的时候会向我们在当前shell下启动的进程发生一个SIGH ...

  4. cf_514C(字符串哈希)

    题目链接:http://acm.hust.edu.cn/vjudge/contest/view.action?cid=121897#problem/G Watto and Mechanism Time ...

  5. 全面理解Java内存模型

    尊重原创:http://blog.csdn.net/suifeng3051/article/details/52611310 Java内存模型即JavaMemory Model,简称JMM.JMM定义 ...

  6. oracle 数据库——知识点总结(加示例)

    新入oracle数据库,把目前学到的知识点记录下来,可能都比较基础,但还是比较全的,里面的示例都是自己在PL/SQL中跑过的,如果有错误,还望各位大侠指出哈. 创建用户 1.创建用户(使用管理员身份创 ...

  7. ItemCF_基于物品的协同过滤_MapReduceJava代码实现思路

    ItemCF_基于物品的协同过滤 1.    概念 2.    原理 如何给用户推荐? 给用户推荐他没有买过的物品--103 3.    java代码实现思路 数据集: 第一步:构建物品的同现矩阵 第 ...

  8. Spark算子--leftOuterJoin和rightOuterJoin

    转载请标明出处http://www.cnblogs.com/haozhengfei/p/cb71cd3ac5d7965a2c61891659264d54.html leftOuterJoin和righ ...

  9. PHP项目开发

    PHP项目开发 =================================== member:(用户表) userid username password name mobile emai a ...

  10. 调用QQ聊天功能

    [HTML]: <a href="javascript:void(0);" onclick="chatQQ()">咨询客服</a> fu ...