1.枚举基本使用
声明枚举时必须使用 enum 关键字,然后定义枚举的名称、可访问性、基础类型和成员等。枚举声明的语法如下:
enum-modifiers enum enumname:enum-base {
enum-body,
}
- enum-modifiers 表示枚举的修饰符主要包括 public、private 和 internal
- enumname 表示声明的枚举名称
- enum-base 表示基础类型,如果没有显式地声明,那么意味着它所对应的基础类型是 int
- enum-body 表示枚举的成员,它是枚举类型的命名常数。任意两个枚举成员不能具有相同的名称,且它的常数值必须在该枚举的基础类型的范围之内,多个枚举成员之间使用逗号分隔。
枚举类最常见的应用场景有两个:
1.1 声明常量
枚举中声明的常量都是默认 public static final ,默认是int(可以通过加参数改变)
public enum SexEnum {
male,female;
}
public enum Color {
RED,BLUE,GREEN,BLACK;
}
之后便可以通过枚举类型名直接引用常量,如 SexEnum.male、Color.RED。
1.2 switch
使用枚举还可以使 switch 语句的可读性更强,例如以下示例代码:
enum Signal {
// 定义一个枚举类型
GREEN,YELLOW,RED
}
public class TrafficLight {
Signal color = Signal.RED;
public void change() {
switch(color) {
case RED:
color = Signal.GREEN;
break;
case YELLOW:
color = Signal.RED;
break;
case GREEN:
color = Signal.YELLOW;
break;
}
}
}
2.枚举类内置方法
Java 中的每一个枚举都继承自 java.lang.Enum 类。
当定义一个枚举类型时,每一个枚举类型成员都可以看作是 Enum 类的实例,这些枚举成员默认都被 public static final 修饰,当使用枚举类型成员时,直接使用枚举名称调用成员即可。
所有枚举实例都可以调用 Enum 类的方法,常用方法如下表所示。
方法名称 | 描述 |
---|---|
values() | 以数组形式返回枚举类型的所有成员 |
valueOf() | 将普通字符串转换为枚举实例 |
compareTo() | 比较两个枚举成员在定义时的顺序 |
ordinal() | 获取枚举成员的索引位置 |
2.1 values()
可以将枚举的所有成员以数组形式返回,也可以通过该方法获取枚举类型的成员。
/**
*创建一个包含 3 个成员的枚举类型 Signal,然后调用 values() 方法输出这些成员。
*/
enum Signal {
// 定义一个枚举类型
GREEN,YELLOW,RED;
}
public static void main(String[] args) {
for(int i = 0;i < Signal.values().length;i++) {
System.out.println("枚举成员:"+Signal.values()[i]);
}
}
输出结果如下:
枚举成员:GREEN
枚举成员:YELLOW
枚举成员:RED
2.2 valueOf()
根据字符串返回相应枚举实例。示例代码在后面..
2.3 compareTo()
比较两个枚举成员在定义时的顺序
/*
*调用valueOf() 方法获取枚举的一个成员,再调用 compareTo() 方法进行比较,并输出结果。
*/
public class TestEnum {
// 定义一个枚举
public enum Sex {
male,female;
}
public static void main(String[] args) {
// 根据字符串返回male枚举成员,然后再比较
compare(Sex.valueOf("male"));
}
public static void compare(Sex s) {
for(int i = 0;i < Sex.values().length;i++) {
// 调用compareTo进行比较
System.out.println(s + "与" + Sex.values()[i] + "的比较结果是:" + s.compareTo(Sex.values()[i]));
}
}
}
最终输出如下:
male与male的比较结果是:0
male与female的比较结果是:-1
2.4 ordinal()
可以获取一个成员在枚举中的索引位置
/**
*创建一个包含 3 个成员的枚举类型 Signal,然后调用 ordinal() 方法输出成员及对应索引位置。
*/
public class TestEnum1 {
// 定义一个枚举类型
enum Signal {
GREEN,YELLOW,RED;
}
public static void main(String[] args) {
for(int i = 0;i < Signal.values().length;i++) {
// 调用 ordinal 返回相应枚举实例的索引
System.out.println("索引" + Signal.values()[i].ordinal()+",值:" + Signal.values()[i]);
}
}
}
输出结果如下:
索引0,值:GREEN
索引1,值:YELLOW
索引2,值:RED
3.枚举类的扩展(重点)
Java 为枚举类型提供了一些内置的方法,同时枚举常量也可以有自己的方法。此时要注意必须在枚举实例的最后一个成员后添加分号,而且必须先定义枚举实例。
3.1 添加属性
可以在创建枚举成员添加属性,但必须满足以下两个条件:
- 要在类中声明该属性
- 一定要有属性的构造方法(必须private)
enum WeekDay {
// 定义枚举成员,并添加属性(相当于构造函数)
Mon("Monday"),Tue("Tuesday"),Wed("Wednesday"),Thu("Thursday"),
Fri("Friday"),Sat("Saturday"),Sun("Sunday");
// 声明属性,并创建构造函数(必须private)
private final String day;
private WeekDay(String day) {
this.day = day;
}
}
3.2 添加方法
可以在枚举类中添加任意方法,像class一样。方法一般分两种:
- 枚举属性操作的方法:如
get()/set()
等修改获取属性的方法,在使用时通过WeekDay.Mon.getDay()
调用 - 属性无关方法:如根据数字打印日期
printDay()
,必须声明成static,在使用时通过WeekDay.printDay()
调用
enum WeekDay {
// 定义枚举成员,并添加属性
Mon("Monday"),Tue("Tuesday"),Wed("Wednesday"),Thu("Thursday"),
Fri("Friday"),Sat("Saturday"),Sun("Sunday");
// 声明属性,并创建构造函数(必须private)
private final String day;
private WeekDay(String day) {
this.day = day;
}
// 1.根据输入的i打印相应周几,属性无关方法,一定要static
public static void printDay(int i) {
switch(i) {
case 1:
System.out.println(WeekDay.Mon);
break;
case 2:
System.out.println(WeekDay.Tue);
break;
case 3:
System.out.println(WeekDay.Wed);
break;
case 4:
System.out.println(WeekDay.Thu);
break;
case 5:
System.out.println(WeekDay.Fri);
break;
case 6:
System.out.println(WeekDay.Sat);
break;
case 7:
System.out.println(WeekDay.Sun);
break;
default:
System.out.println("wrong number!");
}
}
// 2.返回当前枚举成员中定义的属性
public String getDay() {
return day;
}
}
/**
*上面代码创建了 WeekDay 枚举类型,下面遍历该枚举中的所有成员,并调用 printDay() 方法。
*/
public static void main(String[] args) {
for(WeekDay day : WeekDay.values()) {
System.out.println(day+"====>" + day.getDay());
}
WeekDay.printDay(5);
}
输出结果如下:
Mon====>Monday
Tue====>Tuesday
Wed====>Wednesday
Thu====>Thursday
Fri====>Friday
Sat====>Saturday
Sun====>Sunday
Fri
3.3 覆盖方法
Java 中的 enum 还可以跟 Class 类一样覆盖基类的方法。下面示例代码创建的 Color 枚举类型覆盖了 toString() 方法。
public class Test {
public enum Color {
RED("红色",1),GREEN("绿色",2),WHITE("白色",3),YELLOW("黄色",4);
// 成员变量
private String name;
private int index;
// 构造方法
private Color(String name,int index) {
this.name = name;
this.index = index;
}
// 覆盖方法
@Override
public String toString() {
return this.index + "-" + this.name;
}
}
public static void main(String[] args) {
System.out.println(Color.RED.toString()); // 输出:1-红色
}
}
4.枚举类的工具类
为了更好地支持枚举类型,java.util 中添加了两个新类:EnumMap 和 EnumSet。使用它们可以更高效地操作枚举类型。
4.1 EnumMap
EnumMap 是专门为枚举类型量身定做的 Map 实现。虽然使用其他的 Map(如 HashMap)实现也能完成枚举类型实例到值的映射,但是使用 EnumMap 会更加高效。
HashMap 只能接收同一枚举类型的实例作为键值,并且由于枚举类型实例的数量相对固定并且有限,所以 EnumMap 使用数组来存放与枚举类型对应的值,使得 EnumMap 的效率非常高。
下面是使用 EnumMap 的一个代码示例。枚举类型 DataBaseType 里存放了现在支持的所有数据库类型。针对不同的数据库,一些数据库相关的方法需要返回不一样的值,例如示例中 getURL() 方法。
// 定义数据库类型枚举
public enum DataBaseType {
MYSQUORACLE,DB2,SQLSERVER
}
// 某类中定义的获取数据库URL的方法以及EnumMap的声明
private EnumMap<DataBaseType,String>urls = new EnumMap<DataBaseType,String>(DataBaseType.class);
public DataBaseInfo() {
urls.put(DataBaseType.DB2,"jdbc:db2://localhost:5000/sample");
urls.put(DataBaseType.MYSQL,"jdbc:mysql://localhost/mydb");
urls.put(DataBaseType.ORACLE,"jdbc:oracle:thin:@localhost:1521:sample");
urls.put(DataBaseType.SQLSERVER,"jdbc:microsoft:sqlserver://sql:1433;Database=mydb");
}
//根据不同的数据库类型,返回对应的URL
// @param type DataBaseType 枚举类新实例
// @return
public String getURL(DataBaseType type) {
return this.urls.get(type);
}
在实际使用中,EnumMap 对象 urls 往往是由外部负责整个应用初始化的代码来填充的。这里为了演示方便,类自己做了内容填充。
从本例中可以看出,使用 EnumMap 可以很方便地为枚举类型在不同的环境中绑定到不同的值上。本例子中 getURL 绑定到 URL 上,在其他的代码中可能又被绑定到数据库驱动上去。
4.2 EnumSet
EnumSet 是枚举类型的高性能 Set 实现,它要求放入它的枚举常量必须属于同一枚举类型。EnumSet 提供了许多工厂方法以便于初始化,如下
方法名称 | 描述 |
---|---|
allOf(Class element type) | 创建一个包含指定枚举类型中所有枚举成员的 EnumSet 对象 |
complementOf(EnumSet s) | 创建一个与指定 EnumSet 对象 s 相同的枚举类型 EnumSet 对象,并包含所有 s 中未包含的枚举成员 |
copyOf(EnumSet s) | 创建一个与指定 EnumSet 对象 s 相同的枚举类型 EnumSet 对象,并与 s 包含相同的枚举成员 |
noneOf(<Class elementType) | 创建指定枚举类型的空 EnumSet 对象 |
of(E first,e...rest) | 创建包含指定枚举成员的 EnumSet 对象 |
range(E from ,E to) | 创建一个 EnumSet 对象,该对象包含了 from 到 to 之间的所有枚举成员 |
EnumSet 作为 Set 接口实现,它支持对包含的枚举常量的遍历。
for(Operation op:EnumSet.range(Operation.PLUS,Operation.MULTIPLY)) {
doSomeThing(op);
}
==> 开发应用示例
在实际开发时,可以通过枚举定义响应状态:
// 定义各种返回状态
public enum ResultCodeEnum {
SUCCESS(true,2000,"成功"),
REQUEST_ERROR(false,4000,"请求错误"),
SERVER_ERROR(false,5000,"服务器错误"),
;
// 响应是否成功
private Boolean success;
// 响应状态码
private Integer code;
// 响应信息
private String message;
ResultCodeEnum(boolean success, Integer code, String message) {
this.success = success;
this.code = code;
this.message = message;
}
public Boolean getSuccess() {
return success;
}
public Integer getCode() {
return code;
}
public String getMessage() {
return message;
}
}
现在有返回状态了,那具体的响应数据在哪里?
// 封装返回结果,Controller层直接调用
public class R {
private Boolean success; // 相应是否成功
private Integer code; // 响应状态码
private String message; // 响应信息。以上三个字段可以通过枚举实例直接获取
// 响应数据,用map是因为返回的数据都有约定的参数名,即K-V形式
private Map<String, Object> data = new HashMap<>();
public Boolean getSuccess() {
return success;
}
public Integer getCode() {
return code;
}
public String getMessage() {
return message;
}
public Map<String, Object> getData() {
return data;
}
// 构造器私有
private R(){}
public void setSuccess(Boolean success) {
this.success = success;
}
public void setCode(Integer code) {
this.code = code;
}
public void setMessage(String message) {
this.message = message;
}
public void setData(Map<String, Object> data) {
this.data = data;
}
/**------------定义通用结果(使用之前的枚举实例),便于使用----------**/
// 通用返回成功
public static R ok() {
R r = new R();
r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
r.setCode(ResultCodeEnum.SUCCESS.getCode());
r.setMessage(ResultCodeEnum.SUCCESS.getMessage());
return r;
}
// 通用返回失败,请求错误
public static R error() {
R r = new R();
r.setSuccess(ResultCodeEnum.REQUEST_ERROR.getSuccess());
r.setCode(ResultCodeEnum.REQUEST_ERROR.getCode());
r.setMessage(ResultCodeEnum.REQUEST_ERROR.getMessage());
return r;
}
// 通用返回失败,服务器错误
public static R serverError() {
R r = new R();
r.setSuccess(ResultCodeEnum.SERVER_ERROR.getSuccess());
r.setCode(ResultCodeEnum.SERVER_ERROR.getCode());
r.setMessage(ResultCodeEnum.SERVER_ERROR.getMessage());
return r;
}
// 设置结果,形参为结果枚举,便于扩展
public static R setResult(ResultCodeEnum result) {
R r = new R();
r.setSuccess(result.getSuccess());
r.setCode(result.getCode());
r.setMessage(result.getMessage());
return r;
}
/**------------传入响应数据。使用链式编程,返回类本身-----------**/
// 自定义返回数据
public R data(Map<String,Object> map) {
this.setData(map);
return this;
}
// 通用设置data
public R data(String key,Object value) {
this.data.put(key, value);
return this;
}
// 自定义状态信息
public R message(String message) {
this.setMessage(message);
return this;
}
// 自定义状态码
public R code(Integer code) {
this.setCode(code);
return this;
}
// 自定义返回结果
public R success(Boolean success) {
this.setSuccess(success);
return this;
}
}
使用时,直接在Controller返回 R.ok(),或者 R.error()
return R.ok();
return R.ok().data("username",user.getUsername());