一、为什么需要枚举

常量定义它不香吗?为啥非得用枚举?
举个栗子,就以B站上传视频为例,视频一般有三个状态:草稿审核发布,我们可以将其定义为静态常量

  1. public class VideoStatus {
  2. public static final int Draft = 1; //草稿
  3. public static final int Review = 2; //审核
  4. public static final int Published = 3; //发布
  5. }

对于这种单值类型的静态常量定义,本身也没错,主要是在使用的地方没有一个明确性的约束而已,比如:

  1. void judgeVideoStatus( int status ) {
  2. ...
  3. }

比如这里的 judgeVideoStatus 函数的本意是传入 VideoStatus 的三种静态常量之一,但由于没有类型上的约束,因此传入任意一个int值都是可以的,编译器也不会提出任何警告。

但是在枚举类型出现之后,上面这种情况就可以用枚举严谨地去约束,比如用枚举去定义视频状态就非常简洁了:

  1. public enum VideoStatus {
  2. Draft, Review, Published
  3. }

而且主要是在用枚举的地方会有更强的类型约束

  1. // 入参就有明确类型约束
  2. void judgeVideoStatus( VideoStatus status ) {
  3. ...
  4. }

这样在使用 judgeVideoStatus 函数时,入参类型就会受到明确的类型约束,一旦传入无效值,编译器就会帮我们检查,从而规避潜在问题。
除此之外,枚举在扩展性方面比普常量更方便、也更优雅。

二、重新系统认识一下枚举

比如,在后台管理系统中,肯定有用户角色一说,而且角色一般都是固定的,适合定义成一个枚举:

  1. public enum UserRole {
  2. ROLE_ROOT_ADMIN, // 系统管理员
  3. ROLE_ORDER_ADMIN, // 订单管理员
  4. ROLE_NORMAL // 普通用户
  5. }

接下来我们就用这个UserRole为例来说明枚举的所有基本用法

  1. UserRole role1 = UserRole.ROLE_ROOT_ADMIN;
  2. UserRole role2 = UserRole.ROLE_ORDER_ADMIN;
  3. UserRole role3 = UserRole.ROLE_NORMAL;
  4. // values()方法:返回所有枚举常量的数组集合
  5. for ( UserRole role : UserRole.values() ) {
  6. System.out.println(role);
  7. }
  8. // 打印:
  9. // ROLE_ROOT_ADMIN
  10. // ROLE_ORDER_ADMIN
  11. // ROLE_NORMAL
  12. // ordinal()方法:返回枚举常量的序数,注意从0开始
  13. System.out.println( role1.ordinal() ); // 打印0
  14. System.out.println( role2.ordinal() ); // 打印1
  15. System.out.println( role3.ordinal() ); // 打印2
  16. // compareTo()方法:枚举常量间的比较
  17. System.out.println( role1.compareTo(role2) ); //打印-1
  18. System.out.println( role2.compareTo(role3) ); //打印-2
  19. System.out.println( role1.compareTo(role3) ); //打印-2
  20. // name()方法:获得枚举常量的名称
  21. System.out.println( role1.name() ); // 打印ROLE_ROOT_ADMIN
  22. System.out.println( role2.name() ); // 打印ROLE_ORDER_ADMIN
  23. System.out.println( role3.name() ); // 打印ROLE_NORMAL
  24. // valueOf()方法:返回指定名称的枚举常量
  25. System.out.println( UserRole.valueOf( "ROLE_ROOT_ADMIN" ) );
  26. System.out.println( UserRole.valueOf( "ROLE_ORDER_ADMIN" ) );
  27. System.out.println( UserRole.valueOf( "ROLE_NORMAL" ) );

除此之外,枚举还可以用于switch语句中,而且意义更加明确

  1. UserRole userRole = UserRole.ROLE_ORDER_ADMIN;
  2. switch (userRole) {
  3. case ROLE_ROOT_ADMIN: // 比如此处的意义就非常清晰了,比1,2,3这种数字好!
  4. System.out.println("这是系统管理员角色");
  5. break;
  6. case ROLE_ORDER_ADMIN:
  7. System.out.println("这是订单管理员角色");
  8. break;
  9. case ROLE_NORMAL:
  10. System.out.println("这是普通用户角色");
  11. break;
  12. }

自定义扩充枚举

上面展示的枚举例子非常简单,仅仅是单值的情形,而实际项目中用枚举往往是多值用法。

比如,我想扩充一下上面的UserRole枚举,在里面加入 角色名 — 角色编码 的对应关系,这也是实际项目中常用的用法。

这时候我们可以在枚举里自定义各种属性、构造函数、甚至各种方法:

  1. public enum UserRole {
  2. ROLE_ROOT_ADMIN( "系统管理员", 000000 ),
  3. ROLE_ORDER_ADMIN( "订单管理员", 100000 ),
  4. ROLE_NORMAL( "普通用户", 200000 ),
  5. ;
  6. // 以下为自定义属性
  7. private final String roleName; //角色名称
  8. private final Integer roleCode; //角色编码
  9. // 以下为自定义构造函数
  10. UserRole( String roleName, Integer roleCode ) {
  11. this.roleName = roleName;
  12. this.roleCode = roleCode;
  13. }
  14. // 以下为自定义方法
  15. public String getRoleName() {
  16. return this.roleName;
  17. }
  18. public Integer getRoleCode() {
  19. return this.roleCode;
  20. }
  21. public static Integer getRoleCodeByRoleName( String roleName ) {
  22. for( UserRole enums : UserRole.values() ) {
  23. if( enums.getRoleName().equals( roleName ) ) {
  24. return enums.getRoleCode();
  25. }
  26. }
  27. return null;
  28. }
  29. }

从上述代码可知,在enum枚举类中完全可以像在普通Class里一样声明属性、构造函数以及成员方法。

枚举 + 接口 = ?

比如在我的前文《答应我,别再if/else走天下了可以吗》中讲烦人的if/else消除时,就讲过如何通过让枚举去实现接口来方便的完成。
这地方不妨再回顾一遍:
什么角色能干什么事,这很明显有一个对应关系,所以我们首先定义一个公用的接口RoleOperation,表示不同角色所能做的操作:

  1. public interface RoleOperation {
  2. String op(); // 表示某个角色可以做哪些op操作
  3. }

接下来我们将不同角色的情况全部交由枚举类来做,定义一个枚举类RoleEnum,并让它去实现RoleOperation接口:

  1. public enum RoleEnum implements RoleOperation {
  2. // 系统管理员(有A操作权限)
  3. ROLE_ROOT_ADMIN {
  4. @Override
  5. public String op() {
  6. return "ROLE_ROOT_ADMIN:" + " has AAA permission";
  7. }
  8. },
  9. // 订单管理员(有B操作权限)
  10. ROLE_ORDER_ADMIN {
  11. @Override
  12. public String op() {
  13. return "ROLE_ORDER_ADMIN:" + " has BBB permission";
  14. }
  15. },
  16. // 普通用户(有C操作权限)
  17. ROLE_NORMAL {
  18. @Override
  19. public String op() {
  20. return "ROLE_NORMAL:" + " has CCC permission";
  21. }
  22. };
  23. }

这样,在调用处就变得异常简单了,一行代码就行了,根本不需要什么if/else

  1. public class JudgeRole {
  2. public String judge( String roleName ) {
  3. // 一行代码搞定!之前的if/else灰飞烟灭
  4. return RoleEnum.valueOf(roleName).op();
  5. }
  6. }

而且这样一来,以后假如我想扩充条件,只需要去枚举类中加代码即可,而不用改任何老代码,非常符合开闭原则

枚举与设计模式

什么?枚举还能实现设计模式?
是的!不仅能而且还能实现好几种!

2、策略模式
这个也比较好举例,比如用枚举就可以写出一个基于策略模式的加减乘除计算器

  1. public class Test {
  2. public enum Calculator {
  3. ADDITION {
  4. public Double execute( Double x, Double y ) {
  5. return x + y; // 加法
  6. }
  7. },
  8. SUBTRACTION {
  9. public Double execute( Double x, Double y ) {
  10. return x - y; // 减法
  11. }
  12. },
  13. MULTIPLICATION {
  14. public Double execute( Double x, Double y ) {
  15. return x * y; // 乘法
  16. }
  17. },
  18. DIVISION {
  19. public Double execute( Double x, Double y ) {
  20. return x/y; // 除法
  21. }
  22. };
  23. public abstract Double execute(Double x, Double y);
  24. }
  25. public static void main(String[] args) {
  26. System.out.println( Calculator.ADDITION.execute( 4.0, 2.0 ) );
  27. // 打印 6.0
  28. System.out.println( Calculator.SUBTRACTION.execute( 4.0, 2.0 ) );
  29. // 打印 2.0
  30. System.out.println( Calculator.MULTIPLICATION.execute( 4.0, 2.0 ) );
  31. // 打印 8.0
  32. System.out.println( Calculator.DIVISION.execute( 4.0, 2.0 ) );
  33. // 打印 2.0
  34. }
  35. }

专门用于枚举的集合类

我们平常一般习惯于使用诸如:HashMapHashSet等集合来盛放元素,而对于枚举,有它专门的集合类:EnumSetEnumMap
1、EnumSet
EnumSet 是专门为盛放枚举类型所设计的 Set 类型。
还是举例来说,就以文中开头定义的角色枚举为例:

  1. public enum UserRole {
  2. ROLE_ROOT_ADMIN, // 系统管理员
  3. ROLE_ORDER_ADMIN, // 订单管理员
  4. ROLE_NORMAL // 普通用户
  5. }

比如系统里来了一批人,我们需要查看他是不是某个角色中的一个:

  1. // 定义一个管理员角色的专属集合
  2. EnumSet<UserRole> userRolesForAdmin
  3. = EnumSet.of(
  4. UserRole.ROLE_ROOT_ADMIN,
  5. UserRole.ROLE_ORDER_ADMIN
  6. );
  7. // 判断某个进来的用户是不是管理员
  8. Boolean isAdmin( User user ) {
  9. if( userRoles.contains( user.getUserRole() ) )
  10. return true;
  11. return false;
  12. }

2、EnumMap
同样,EnumMap 则是用来专门盛放枚举类型为keyMap 类型。
比如,系统里来了一批人,我们需要统计不同的角色到底有多少人这种的话:

  1. Map<UserRole,Integer> userStatisticMap = new EnumMap<>(UserRole.class);
  2. for ( User user : userList ) {
  3. Integer num = userStatisticMap.get( user.getUserRole() );
  4. if( null != num ) {
  5. userStatisticMap.put( user.getUserRole(), num+1 );
  6. } else {
  7. userStatisticMap.put( user.getUserRole(), 1 );
  8. }
  9. }