常量/枚举类型的表示
系统中常常有一些属性的属性值是固定的一组值,它们的值域是封闭的(有限数量),比如国家代码(每个国家具有唯一的代码,而在一定时期国家的数量是确定的)、性别类型(男、女)。在现代程序语言中,一种典型的表示方式是枚举类型(Enum)。Enum表示封闭值域的类型,常常由程序语言作为一种数据类型直接支持,例如C,C#等。C#支持的enum在C的基础上提供了类型安全的能力,下面是用C#定义的性别枚举类型:
public enum Sex {
Male,
Female,
}
Java不支持enum数据类型,Java认为C提供的enum并不是类型安全的,通常使用称之为Typesafe Enum Class的设计模式来获得类似的效果(参见[Joshua01] P80,Item21 :Replace enum constructs with classes)。Enum Class不允许外部构造实例成员(构造函数为private),提供静态类型成员实例来表示封闭值域。使用Enum Class方式来表示Sex类型可定义如下(C#):
public class Sex{
// 私有构造保证值域的封闭性
private Sex() {
}
pubic static readonly Sex Male = new Sex():
pubic static readonly Sex Female = new Sex():
}
同enum一样,可以使用Sex.Male或Sex.Female的方式来访问常量属性,与静态常量字段不一样(如静态字符串、整数),enum和Enum Class可以提供强类型的compile time检查以及提供更好的数据封装性和代码可读性。例如使用常量类型设置和比较属性值:
// 设置属性值
Sex sex = Sex.Male;
// 比较
if (sex == Sex.Male) {
// ... ...
}
如果Sex是使用Enum定义的,则上面比较的实际上是Enum字段的值;如果Sex是使用Enum Class定义的,则比较的是静态实例成员的引用地址,当然也可以使用Equals方法来比较。
虽然Enum Class是来自于Java的设计模式,但在C#中并非没有意义,因为Enum Class提供了比Enum类型更强大的能力。
Enum与Enum Class的比较
Enum与Enum Class均提供了封装常量的能力,都能够实现编译时的强类型检查,使用封闭值域防止非法值。不过,因为实现机制的不同,这两种方式也具有不同的特点。
Enum在C#中是一种值类型(Value Type),其基类型必须是整数类型(如Int16),因此Enum也具有值类型所具有的优点——比引用类型(Reference Type)更高的效率,定义简单。C#的Enum还支持位(Bit)操作,对于用于标志的常量,允许常量的OR、AND、XOR、NOT等位操作,C#提供了内建的语言支持,通过FlagsAttribute即可使Enum具备位操作能力。例如.Net Framework的System.AttributeTargets属性,允许Attribute子类在设置AttributeUsage时可以组合AttributeTargets属性(参见.Net Framework SDK):
// System.AttributeTargets的定义
[Flags] //Flags属性表明枚举是一个标志枚举,允许位操作
public enum AttributeTargets {
Class,
Method,
... ...
}
// 使用Flags枚举
// 下面的定义表示CustomerAttribute可以作用在Class或者Method上
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method )]
public sealed class CustomAttribute : Attribute {
... ...
}
Enum的缺悴荒苁迪肿远ㄒ宓男形薹ㄌ峁┏A扛嗟氖粜裕还诖蠖嗍榭鱿拢庖丫愎涣恕num Class没有这种限制,虽然Enum Class本身并不设计为可以继承,但可以修改基类(System.Object)的行为以提供更加丰富的能力(如修改ToString方法,根据使用者的本地语言输出本地化的国家名称),也可以提供更多的属性 。例如我们提供一个候选的国家列表,除了能显示国家名称外,可以提供国家代码、语言代码信息。关于Enum Class更多的应用场景后面的节有详细的描述。
Enum Class的问题
上面的Enum Class实现方式也有它的缺点,在上面的设计中Enum Class通过进程内静态成员引用地址相同的机理来比较 枚举量是否相等,但是当将一个序列化后的Enum Class实例反序列化后,CLR会创建一个新的实例,从而造成反序列化值不等于序列化前值的现象:
IFormatter formatter = new System.Runtime.Serialization.Formatters.Binary.BinaryFormatter();
MemoryStream stream = new MemoryStream();
// 序列化Sex.Male的值
formatter.Serialize(stream, Sex.Male);
stream.Seek(0,SeekOrigin.Begin);
// 反序列化
Sex sex = (Sex)formatter.Deserialize(stream);
Console.WriteLine(sex == Sex.Male);
上面的代码将输出false。因此通过引用的方式是有局限性的,在Java中这是一个比较棘手的问题,需要修改反序列化的行为(参看[Joshua01]P171)来保证进程中只存在一个枚举量的唯一实例。C#与Java的反序列化实现机制不一样,无法通过修改反序列化的行为来返回同一个常量实例 ,但C#提供了操作符重载的能力。我们可以通过重载操作符“==”来解决这个问题,同时为了保持CLS兼容以及与Equals的行为一致,还需要改写Equals方法:
[Serializable]
public class Sex{
// 性别类型名
private string sexName;
// 私有构造保证值域的封闭性
private Sex(string sexName) {
this.sexName = sexName;
}
public static readonly Sex Male = new Sex("Male");
public static readonly Sex Female = new Sex("Female");
// 提供重载的"=="操作符,使用sexName来判断是否是相同的Sex类型
public static bool operator ==(Sex op1, Sex op2) {
if (Object.Equals(op1, null)) return Object.Equals(op2, null);
return op1.Equals(op2);
}
public static bool operator !=(Sex op1,Sex op2) {
return !(op1 == op2);
}
public override bool Equals(object obj) {
Sex sex = obj as Sex;
if (obj == null) return false;
return sexName == sex.sexName;
}
public override int GetHashCode() {
return sexName.GetHashCode ();
}
}
通过操作符重载,不再使用引用地址来比较常量,而是通过值比较(如上面的sexName),因此要求每个常量实例必须具有唯一的标识值。 在不支持操作符重载的语言中,不能使用"=="来比较两个常量值是否相等,而应该使用Equals方法来代替。
Enum Class的设计
Enum Class一般符合下列规则:
- 私有构造函数,保证外部无法创建类实例(同时也使得类无法继承)。
- 静态只读实例字段表示常量。
- 重载操作符"==",保证序列化后的值也能比较相等。当需要在进程间传递(如分布式应用)或需要序列化时,必须实现"=="操作符的重载。
- 改写Equals方法,保持"=="行为和Equals一致。(改写Equals一般也同时改写GetHashCode方法 )
除此之外,还通常改写ToString方法以提供显示友好的名字,因为Java和.Net都在绑定或显示对象时使用ToString方法(Java中为toString方法)输出作为缺省的对象显示字符串,比如将Sex数组绑定到ListBox或者使用Console.Write输出时。下面的代码改写ToString方法以提供友好显示的输出:
public class Sex{
... ...
public override string ToString() {
return sexName;
}
}
当然我们也可以利用ToString提供本地化支持,返回本地语言的字符串。
Enum Class另外一种常见的职责是提供不同值系统之间的类型转换,如当从数据库中读取值时,利用Parse方法将数据库中值转换为对象系统的常量实例,而在存储时提供方法转换为数据库的值类型:
public class Sex{
... ...
// 根据一个符合指定格式的字符串返回类型实例。
public static Sex Parse(string sexName){
switch (sexName) {
case "Male" : return Male;
... ...
}
}
// 返回数据存储的值。
public string ToDBValue(){
return sexName;
}
}
使用Enum还是Enum Class?
根据Enum和Enum Class的特点,我们可以根据对常量类型的要求决定使用Enum还是Enum Class。
以下场景适合使用Enum:
- 常量类型用于内部表示,不用于显示名字。
- 常量值不需要提供附加的属性。例如只需要知道国家代码,而不需要获得国家的其它属性
-
枚举值允许组合(即支持位操作)。
Enum Class可以适用于更多的场景:
- 常用于可提供友好信息的类型。如本地化支持的类型名显示,或者显示与枚举名不一致的名字,例如Country.CHN可显示为"China"。
- 提供更多的常量属性。
- 提供更加丰富的行为。如Parse方法。
-
对常量进行分组。如Country.Asia包含亚洲国家。
使用Struct来表示枚举
如果值域不封闭,但希望提供一些常量,也可以使用struct,如System.Drawing.Color结构中的系统默认颜色设置。采用struct来设计enum值同Enum Class方式没有本质的差异,只是struct默认提供无参数构造函数,因此无法实现封闭值域。
参考:
[Joshua01]
Effective Java Programming Language Guide , Joshua Bloch, Pearson Education,2001.
Java 高效编程指南(中文版),机械工业出版社,2002
分享到:
相关推荐
在C++中,枚举类型分为不限定作用域(enum)和限定作用域(enum class)。 2. enum与enum class的区别? (为什么需要限定作用域?) 答:枚举作用域是指枚举类型成员名字的作用域,起自其声明之处,终止枚举定义...
枚举定义用class关键字,继承Enum类。 注意: 定义枚举时,成员名称不允许重复 默认情况下,不同的成员值允许相同。但是两个相同值的成员,第二个成员的名称被视作第一个成员的别名 如果枚举中存在相同值的成员,...
使用田野要使用该字段,您必须具有一个现有的Enum: from enum import Enumclass StopLight ( Enum ): green = 1 yellow = 2 red = 3 然后,将其声明为架构中的字段: from marshmallow import Schemafrom ...
教义枚举类型 该软件包提供了一个基本实现,用于定义映射到MyCLabs\Enum\Enum对象的学说实体列类型。 该类在出色的包中定义。安装推荐的安装方法是使用 composer require acelaya/...class Action extends Enum{ publi
Java——枚举: enum关键字、Enum类 类集对枚举的支持——EnumMap类与EnumSet类 枚举类实现接口、在枚举类中定义抽象方法 Java反射机制: Class类、Class类的使用 反射的应用:取得类的结构
本文实例总结了python模拟enum枚举类型的方法。分享给大家供大家参考。具体分析如下: python中没有enum枚举类型,可能python认为这玩意压根就没用,下面列举了三种方法模拟enum枚举类型 方法1. 使用自定义类 class...
常见的enum类型重定义的解决方法,清晰明了。
考虑这个枚举类: namespace MiladRahimi \ Enum \ Enum ; class SampleEnum extends Enum { const UNO = 1 ; const ONE = 1 ; const TWO = 2 ; const STR = "sth" ; } 现在您可以使用以下方法: SampleEnum ...
classy_enum, Rails的基于类的枚举器 gem ClassyEnum ClassyEnum是一个 Ruby on Rails gem,它将基于类的枚举器函数添加到 Active Record 属性。这个自述文件也可以用用户友好的DocumentUp格式 。支持
Java 枚举类使用 enum 关键字来定义,各个常量使用逗号 , 来分割。 例如定义一个颜色的枚举类。 enum Color { RED, GREEN, BLUE; } 以上枚举类 Color 颜色常量有 RED, GREEN, BLUE,分别表示红色,绿色,蓝色。 ...
以下几种方法来模拟enum:(感觉方法一简单实用) 复制代码 代码如下: # way1 class Directions: up = 0 down = 1 left = 2 right =3 print Directions.down # way2 dirUp, dirDown, dirLeft, dirRight =...
它支持C ++中的智能枚举类所期望的所有标准功能: 告诉您枚举数 让您遍历所有枚举值 将string转换为enum,并将enum转换为string 以惯用的C ++方式完成所有工作(对通用编程,编译时编程等友好) 例子 让我们看...
枚举PHP库概述该库为PHP提供了一个Enum / Enumeration实现。.../** * Class City * * @package Rexlabs\Enum\Readme * * @method static static BRISBANE() * @method static static MELBOURNE() * @method static st
功能:枚举操作类,枚举类型创建,转换 * 2. 作者:杨磊 * 3. 创建日期:2008-1-30 * 4. 最后修改日期:2008-11-10 **/ using System; using System.Collections.Generic; using System.Text; using System....
通过创建一个新的类来创建您的第一个枚举类型: class TheGuy extends Enum { const _default = self :: NICE_GUY ; const SMART_GUY = 'Mike' ; const NICE_GUY = 'Rick' ; } 就这样。 现在您可以使用它: ...
class DirectionEnum extends AbstractEnum{ const NORTH = 'north'; const EAST = 'east'; const SOUTH = 'south'; const WEST = 'west'; /** * Return an array of enum class constants * * @return array */ ...
1.枚举类的值不可以被外界更改 2.不能存在相同的标签,但允许不同标签存在相同的枚举值,即后者相当于前者的别名 3.枚举值可以是任意类型 4.枚举标签尽量用大写 from enum import Enum #普通类 class dict(): ...
例子# include " enum_conversions_macro.h "ENUM_CLASS (Day, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday);int main (){// get enum sizestd::cout << " enum size: " <...
枚举该软件包包含一个简单的类,可用作您的枚举类的祖先。安装composer require greg0ire/enum用法基本用法扩展Greg0ire\Enum\AbstractEnum ,将枚举键值定义为常量,而鲍勃是您的叔叔。 您可以根据需要将类设为抽象...