Java(enum)枚举用法详解
概念
enum
的全称为 enumeration, 是 jdk 1.5 中引入的新特性。
在java中,被 enum
关键字修饰的类型就是枚举类型。形式如下:
enum color { red, green, blue }
如果枚举不添加任何方法,枚举值默认为从0开始的有序数值。以 color 枚举类型举例,它的枚举常量依次为red:0,green:1,blue:2
枚举的好处:可以将常量组织起来,统一进行管理。
枚举的典型应用场景:错误码、状态机等。
枚举类型的本质
尽管enum
看起来像是一种新的数据类型,事实上,enum是一种受限制的类,并且具有自己的方法。
创建enum时,编译器会为你生成一个相关的类,这个类继承自 java.lang.enum
。
java.lang.enum
类声明
public abstract class enum<e extends enum<e>> implements comparable<e>, serializable { ... }
枚举的方法
在enum中,提供了一些基本方法:
values()
:返回enum实例的数组,而且该数组中的元素严格保持在enum中声明时的顺序。
name()
:返回实例名。
ordinal()
:返回实例声明时的次序,从0开始。
getdeclaringclass()
:返回实例所属的enum类型。
equals()
:判断是否为同一个对象。
可以使用 ==
来比较enum
实例。
此外,java.lang.enum
实现了comparable
和 serializable
接口,所以也提供 compareto() 方法。
例:展示enum的基本方法
public class enummethoddemo { enum color {red, green, blue;} enum size {big, middle, small;} public static void main(string args[]) { system.out.println("=========== print all color ==========="); for (color c : color.values()) { system.out.println(c + " ordinal: " + c.ordinal()); } system.out.println("=========== print all size ==========="); for (size s : size.values()) { system.out.println(s + " ordinal: " + s.ordinal()); } color green = color.green; system.out.println("green name(): " + green.name()); system.out.println("green getdeclaringclass(): " + green.getdeclaringclass()); system.out.println("green hashcode(): " + green.hashcode()); system.out.println("green compareto color.green: " + green.compareto(color.green)); system.out.println("green equals color.green: " + green.equals(color.green)); system.out.println("green equals size.middle: " + green.equals(size.middle)); system.out.println("green equals 1: " + green.equals(1)); system.out.format("green == color.blue: %b\n", green == color.blue); } }
输出
=========== print all color =========== red ordinal: 0 green ordinal: 1 blue ordinal: 2 =========== print all size =========== big ordinal: 0 middle ordinal: 1 small ordinal: 2 green name(): green green getdeclaringclass(): class org.zp.javase.enumeration.enumdemo$color green hashcode(): 460141958 green compareto color.green: 0 green equals color.green: true green equals size.middle: false green equals 1: false green == color.blue: false
枚举的特性
枚举的特性,归结起来就是一句话:
除了不能继承,基本上可以将enum
看做一个常规的类。
但是这句话需要拆分去理解,让我们细细道来。
枚举可以添加方法
在概念章节提到了,枚举值默认为从0开始的有序数值 。那么问题来了:如何为枚举显示的赋值。
java 不允许使用 =
为枚举常量赋值
如果你接触过c/c++,你肯定会很自然的想到赋值符号 =
。在c/c++语言中的enum,可以用赋值符号=显示的为枚举常量赋值;但是 ,很遗憾,java 语法中却不允许使用赋值符号 = 为枚举常量赋值。
例:c/c++ 语言中的枚举声明
typedef enum{ one = 1, two, three = 3, ten = 10 } number;
enum 可以添加普通方法、静态方法、抽象方法、构造方法
java虽然不能直接为实例赋值,但是它有更优秀的解决方案:为 enum 添加方法来间接实现显示赋值。
创建 enum
时,可以为其添加多种方法,甚至可以为其添加构造方法。
注意一个细节:如果要为enum定义方法,那么必须在enum的最后一个实例尾部添加一个分号。此外,在enum中,必须先定义实例,不能将字段或方法定义在实例前面。否则,编译器会报错。
例:全面展示如何在枚举中定义普通方法、静态方法、抽象方法、构造方法
public enum errorcode { ok(0) { public string getdescription() { return "成功"; } }, error_a(100) { public string getdescription() { return "错误a"; } }, error_b(200) { public string getdescription() { return "错误b"; } }; private int code; // 构造方法:enum的构造方法只能被声明为private权限或不声明权限 private errorcode(int number) { // 构造方法 this.code = number; } public int getcode() { // 普通方法 return code; } // 普通方法 public abstract string getdescription(); // 抽象方法 public static void main(string args[]) { // 静态方法 for (errorcode s : errorcode.values()) { system.out.println("code: " + s.getcode() + ", description: " + s.getdescription()); } } }
注:上面的例子并不可取,仅仅是为了展示枚举支持定义各种方法。下面是一个简化的例子
例:一个错误码枚举类型的定义
本例和上例的执行结果完全相同。
public enum errorcodeen { ok(0, "成功"), error_a(100, "错误a"), error_b(200, "错误b"); errorcodeen(int number, string description) { this.code = number; this.description = description; } private int code; private string description; public int getcode() { return code; } public string getdescription() { return description; } public static void main(string args[]) { // 静态方法 for (errorcodeen s : errorcodeen.values()) { system.out.println("code: " + s.getcode() + ", description: " + s.getdescription()); } } }
枚举可以实现接口
enum
可以像一般类一样实现接口。
同样是实现上一节中的错误码枚举类,通过实现接口,可以约束它的方法。
public interface inumberenum { int getcode(); string getdescription(); } public enum errorcodeen2 implements inumberenum { ok(0, "成功"), error_a(100, "错误a"), error_b(200, "错误b"); errorcodeen2(int number, string description) { this.code = number; this.description = description; } private int code; private string description; @override public int getcode() { return code; } @override public string getdescription() { return description; } }
枚举不可以继承
enum 不可以继承另外一个类,当然,也不能继承另一个 enum 。
因为 enum
实际上都继承自 java.lang.enum
类,而 java 不支持多重继承,所以enum不能再继承其他类,当然也不能继承另一个 enum
。
枚举的应用场景
组织常量
在jdk1.5 之前,在java中定义常量都是public static final type a
; 这样的形式。有了枚举,你可以将有关联关系的常量组织起来,使代码更加易读、安全,并且还可以使用枚举提供的方法。
枚举声明的格式
注:如果枚举中没有定义方法,也可以在最后一个实例后面加逗号、分号或什么都不加。
下面三种声明方式是等价的:
enum color { red, green, blue } enum color { red, green, blue, } enum color { red, green, blue; }
switch 状态机
我们经常使用switch语句来写状态机。jdk7以后,switch已经支持 int、char、string、enum
类型的参数。这几种类型的参数比较起来,使用枚举的switch代码更具有可读性。
enum signal {red, yellow, green} public static string gettrafficinstruct(signal signal) { string instruct = "信号灯故障"; switch (signal) { case red: instruct = "红灯停"; break; case yellow: instruct = "黄灯请注意"; break; case green: instruct = "绿灯行"; break; default: break; } return instruct; }
组织枚举
可以将类型相近的枚举通过接口或类组织起来。
但是一般用接口方式进行组织。
原因是:java接口在编译时会自动为enum类型加上public static
修饰符;java类在编译时会自动为 enum
类型加上static
修饰符。看出差异了吗?没错,就是说,在类中组织 enum
,如果你不给它修饰为 public
,那么只能在本包中进行访问。
例:在接口中组织 enum
public interface plant { enum vegetable implements inumberenum { potato(0, "土豆"), tomato(0, "西红柿"); vegetable(int number, string description) { this.code = number; this.description = description; } private int code; private string description; @override public int getcode() { return 0; } @override public string getdescription() { return null; } } enum fruit implements inumberenum { apple(0, "苹果"), orange(0, "桔子"), banana(0, "香蕉"); fruit(int number, string description) { this.code = number; this.description = description; } private int code; private string description; @override public int getcode() { return 0; } @override public string getdescription() { return null; } } }
例:在类中组织 enum
本例和上例效果相同。
public class plant2 { public enum vegetable implements inumberenum {...} // 省略代码 public enum fruit implements inumberenum {...} // 省略代码 }
策略枚举
effectivejava中展示了一种策略枚举。这种枚举通过枚举嵌套枚举的方式,将枚举常量分类处理。
这种做法虽然没有switch语句简洁,但是更加安全、灵活。
例:effectviejava中的策略枚举范例
enum payrollday { monday(paytype.weekday), tuesday(paytype.weekday), wednesday( paytype.weekday), thursday(paytype.weekday), friday(paytype.weekday), saturday( paytype.weekend), sunday(paytype.weekend); private final paytype paytype; payrollday(paytype paytype) { this.paytype = paytype; } double pay(double hoursworked, double payrate) { return paytype.pay(hoursworked, payrate); } // 策略枚举 private enum paytype { weekday { double overtimepay(double hours, double payrate) { return hours <= hours_per_shift ? 0 : (hours - hours_per_shift) * payrate / 2; } }, weekend { double overtimepay(double hours, double payrate) { return hours * payrate / 2; } }; private static final int hours_per_shift = 8; abstract double overtimepay(double hrs, double payrate); double pay(double hoursworked, double payrate) { double basepay = hoursworked * payrate; return basepay + overtimepay(hoursworked, payrate); } } }
测试
system.out.println("时薪100的人在周五工作8小时的收入:" + payrollday.friday.pay(8.0, 100)); system.out.println("时薪100的人在周六工作8小时的收入:" + payrollday.saturday.pay(8.0, 100));
enumset和enummap
java中提供了两个方便操作enum的工具类——enumset和enummap。
enumset
是枚举类型的高性能set
实现。它要求放入它的枚举常量必须属于同一枚举类型。
enummap
是专门为枚举类型量身定做的map实现。虽然使用其它的map
实现(如hashmap)也能完成枚举类型实例到值得映射,但是使用enummap会更加高效:它只能接收同一枚举类型的实例作为键值,并且由于枚举类型实例的数量相对固定并且有限,所以enummap使用数组来存放与枚举类型对应的值。这使得enummap的效率非常高。
// enumset的使用 system.out.println("enumset展示"); enumset<errorcodeen> errset = enumset.allof(errorcodeen.class); for (errorcodeen e : errset) { system.out.println(e.name() + " : " + e.ordinal()); } // enummap的使用 system.out.println("enummap展示"); enummap<statemachine.signal, string> errmap = new enummap(statemachine.signal.class); errmap.put(statemachine.signal.red, "红灯"); errmap.put(statemachine.signal.yellow, "黄灯"); errmap.put(statemachine.signal.green, "绿灯"); for (iterator<map.entry<statemachine.signal, string>> iter = errmap.entryset().iterator(); iter.hasnext();) { map.entry<statemachine.signal, string> entry = iter.next(); system.out.println(entry.getkey().name() + " : " + entry.getvalue()); }
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。