文档章节

恕我直言,我怀疑你没怎么用过枚举

CodeSheep
 CodeSheep
发布于 03/17 09:56
字数 2178
阅读 3W
收藏 119


我们是否一样?

估计很多小伙伴(也包括我自己)都有这种情况,在自学Java语言看书时,关于枚举enum这一块的知识点可能都有点 “轻敌” ,觉得这块内容非常简单,一带而过,而且在实际写代码过程中也不注意运用。

是的,我也是这样!直到有一天我提的代码审核没过,被技术总监一顿批,我才重新拿起了《Java编程思想》,把枚举这块的知识点重新又审视了一遍。


为什么需要枚举

常量定义它不香吗?为啥非得用枚举?

举个栗子,就以B站上传视频为例,视频一般有三个状态:草稿审核发布,我们可以将其定义为静态常量

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

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

void judgeVideoStatus( int status ) {
    
    ...
    
}

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

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

public enum VideoStatus {
    Draft, Review, Published
}

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

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

这样在使用 judgeVideoStatus 函数时,入参类型就会受到明确的类型约束,一旦传入无效值,编译器就会帮我们检查,从而规避潜在问题。

除此之外,枚举在扩展性方面比普常量更方便、也更优雅。


重新系统认识一下枚举

还是拿前文《答应我,别再if/else走天下了可以吗》中的那个例子来说:比如,在后台管理系统中,肯定有用户角色一说,而且角色一般都是固定的,适合定义成一个枚举:

public enum UserRole {

    ROLE_ROOT_ADMIN,  // 系统管理员

    ROLE_ORDER_ADMIN, // 订单管理员

    ROLE_NORMAL       // 普通用户
}

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

UserRole role1 = UserRole.ROLE_ROOT_ADMIN;
UserRole role2 = UserRole.ROLE_ORDER_ADMIN;
UserRole role3 = UserRole.ROLE_NORMAL;

// values()方法:返回所有枚举常量的数组集合
for ( UserRole role : UserRole.values() ) {
    System.out.println(role);
}
// 打印:
// ROLE_ROOT_ADMIN
// ROLE_ORDER_ADMIN
// ROLE_NORMAL

// ordinal()方法:返回枚举常量的序数,注意从0开始
System.out.println( role1.ordinal() ); // 打印0
System.out.println( role2.ordinal() ); // 打印1
System.out.println( role3.ordinal() ); // 打印2

// compareTo()方法:枚举常量间的比较
System.out.println( role1.compareTo(role2) ); //打印-1
System.out.println( role2.compareTo(role3) ); //打印-2
System.out.println( role1.compareTo(role3) ); //打印-2

// name()方法:获得枚举常量的名称
System.out.println( role1.name() ); // 打印ROLE_ROOT_ADMIN
System.out.println( role2.name() ); // 打印ROLE_ORDER_ADMIN
System.out.println( role3.name() ); // 打印ROLE_NORMAL

// valueOf()方法:返回指定名称的枚举常量
System.out.println( UserRole.valueOf( "ROLE_ROOT_ADMIN" ) );
System.out.println( UserRole.valueOf( "ROLE_ORDER_ADMIN" ) );
System.out.println( UserRole.valueOf( "ROLE_NORMAL" ) );

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

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

自定义扩充枚举

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

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

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

public enum UserRole {

    ROLE_ROOT_ADMIN( "系统管理员", 000000 ),
    ROLE_ORDER_ADMIN( "订单管理员", 100000 ),
    ROLE_NORMAL( "普通用户", 200000 ),
    ;

    // 以下为自定义属性
    
    private final String roleName;  //角色名称

    private final Integer roleCode; //角色编码

    // 以下为自定义构造函数
    
    UserRole( String roleName, Integer roleCode ) {
        this.roleName = roleName;
        this.roleCode = roleCode;
    }

    // 以下为自定义方法
    
    public String getRoleName() {
        return this.roleName;
    }

    public Integer getRoleCode() {
        return this.roleCode;
    }

    public static Integer getRoleCodeByRoleName( String roleName ) {
        for( UserRole enums : UserRole.values() ) {
            if( enums.getRoleName().equals( roleName ) ) {
                return enums.getRoleCode();
            }
        }
        return null;
    }

}

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


枚举 + 接口 = ?

比如在我的前文《答应我,别再if/else走天下了可以吗》中讲烦人的if/else消除时,就讲过如何通过让枚举去实现接口来方便的完成。

这地方不妨再回顾一遍:

什么角色能干什么事,这很明显有一个对应关系,所以我们首先定义一个公用的接口RoleOperation,表示不同角色所能做的操作:

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

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

public enum RoleEnum implements RoleOperation {

    // 系统管理员(有A操作权限)
    ROLE_ROOT_ADMIN {
        @Override
        public String op() {
            return "ROLE_ROOT_ADMIN:" + " has AAA permission";
        }
    },

    // 订单管理员(有B操作权限)
    ROLE_ORDER_ADMIN {
        @Override
        public String op() {
            return "ROLE_ORDER_ADMIN:" + " has BBB permission";
        }
    },

    // 普通用户(有C操作权限)
    ROLE_NORMAL {
        @Override
        public String op() {
            return "ROLE_NORMAL:" + " has CCC permission";
        }
    };
}

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

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

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


枚举与设计模式

什么?枚举还能实现设计模式?

是的!不仅能而且还能实现好几种!

1、单例模式

public class Singleton {

    // 构造函数私有化,避免外部创建实例
    private Singleton() {

    }

    //定义一个内部枚举
    public enum SingletonEnum{

        SEED;  // 唯一一个枚举对象,我们称它为“种子选手”!

        private Singleton singleton;

        SingletonEnum(){
            singleton = new Singleton(); //真正的对象创建隐蔽在此!
        }

        public Singleton getInstnce(){
            return singleton;
        }
    }

    // 故意外露的对象获取方法,也是外面获取实例的唯一入口
    public static Singleton getInstance(){
        return SingletonEnum.SEED.getInstnce(); // 通过枚举的种子选手来完成
    }
}

2、策略模式

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

public class Test {

    public enum Calculator {

        ADDITION {
            public Double execute( Double x, Double y ) {
                return x + y; // 加法
            }
        },

        SUBTRACTION {
            public Double execute( Double x, Double y ) {
                return x - y; // 减法
            }
        },

        MULTIPLICATION {
            public Double execute( Double x, Double y ) {
                return x * y; // 乘法
            }
        },


        DIVISION {
            public Double execute( Double x, Double y ) {
                return x/y;  // 除法
            }
        };

        public abstract Double execute(Double x, Double y);
    }
    
    public static void main(String[] args) {
        System.out.println( Calculator.ADDITION.execute( 4.0, 2.0 ) );       
        // 打印 6.0
        System.out.println( Calculator.SUBTRACTION.execute( 4.0, 2.0 ) );    
        // 打印 2.0
        System.out.println( Calculator.MULTIPLICATION.execute( 4.0, 2.0 ) ); 
        // 打印 8.0
        System.out.println( Calculator.DIVISION.execute( 4.0, 2.0 ) );       
        // 打印 2.0
    }
}

专门用于枚举的集合类

我们平常一般习惯于使用诸如:HashMapHashSet等集合来盛放元素,而对于枚举,有它专门的集合类:EnumSetEnumMap

1、EnumSet

EnumSet 是专门为盛放枚举类型所设计的 Set 类型。

还是举例来说,就以文中开头定义的角色枚举为例:

public enum UserRole {

    ROLE_ROOT_ADMIN,  // 系统管理员

    ROLE_ORDER_ADMIN, // 订单管理员

    ROLE_NORMAL       // 普通用户
}

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

// 定义一个管理员角色的专属集合
EnumSet<UserRole> userRolesForAdmin 
    = EnumSet.of( 
        UserRole.ROLE_ROOT_ADMIN,
        UserRole.ROLE_ORDER_ADMIN 
    );

// 判断某个进来的用户是不是管理员
Boolean isAdmin( User user ) {
    
    if( userRoles.contains( user.getUserRole() ) )
        return true;
    
    return false;
}

2、EnumMap

同样,EnumMap 则是用来专门盛放枚举类型为keyMap 类型。

比如,系统里来了一批人,我们需要统计不同的角色到底有多少人这种的话:

Map<UserRole,Integer> userStatisticMap = new EnumMap<>(UserRole.class);

for ( User user : userList ) {
    Integer num = userStatisticMap.get( user.getUserRole() );
    if( null != num ) {
        userStatisticMap.put( user.getUserRole(), num+1 );
    } else {
        userStatisticMap.put( user.getUserRole(), 1 );
    }
}

EnumMap可以说非常方便了。


总 结

小小的枚举就玩出这么多的花样,不过好在探索和总结的过程还挺有意思的,也复习了很多知识,慢慢来吧。


© 著作权归作者所有

CodeSheep

CodeSheep

粉丝 293
博文 82
码字总数 117942
作品 0
南京
程序员
私信 提问
加载中

评论(21)

青木_
青木_
字符串真香
李大胖胖汉
李大胖胖汉
其实枚举就是初始化了一堆同类型的单例,用好了还是能省很多事
zb1488614096720
zb1488614096720
B站有一大堆医学书的编程大佬?
W
WindSpeed
枚举虽然的确是个好东西,但不适合非英语用户,一般中文用户我们定枚举是要和一个字符串绑定的,比如man = 男,woman = 女,英语用户就不存在这个问题,所以非英语用户还是常量比较合适
Kit_lee
Kit_lee
枚举也可以自定义属性,加个对照中文不是问题,在这一点(语言)方面枚举和常量没有区别,没有什么合适不合适
W
WindSpeed
很多时候做项目为了避免冗余,会有一个字典表,而java中定义成常量的好处是,他是String类型,常量名即数据库字典表中code字段,该常量的值为数据库实际value字段,而枚举,在序列化和反序列化,还有使用中都不方便,所以增加工作成本的东西,就没什么人用了
Kit_lee
Kit_lee
枚举类直接用在数据库实体的某个属性是比较麻烦,因为JPA会将枚举类解释成索引,而非具体的字符串值。但就如上文所述,如果某个字段的值需要约束和校验,枚举类比常量更为有用,也比常量更有扩展功能。所以说还是看使用场景和设计模式。
blacksiders
blacksiders
将字段定义成基本类型,在get set上做点手脚就可以了,并不会太麻烦
Skqing
Skqing
枚举不是线程安全的吧,上次遇到个并发问题可把我给坑死了,后面都不敢用了,作者可以讲讲。
开源中国首席罗纳尔多
开源中国首席罗纳尔多
您好,不修改枚举跟并发没关系吧?
Kit_lee
Kit_lee
恕我直言,枚举实例的创建是线程安全的,你的并发问题如果跟枚举有关,感觉很有趣,发出来看看?
Leaybc
Leaybc
嗦出你的故事?
yl-yue
yl-yue
挺清晰的,辛苦了。我对枚举还是经常用
高久峰是个大胖子
很少用,项目小,用起来还是太麻烦
PrivateRookie
PrivateRookie
rust的模式匹配加枚举是真香
shatian
shatian
你猜的真准,我是一次都没用过
李永波
李永波
你怀疑的有道理
常用twisted的兄弟帮忙看下

我的运行环境如下 win7 64,python2.7.6 64,twisted 13.2 twisted一直无法正常启动,reactor install时就报错: cffi.ffiplatform.VerificationError: importing 'D:\\Python27\\lib\\site-pa......

askforone
2014/05/07
764
1
CXF在接口程序中获取客户端IP时,WebServiceContext为null

用过滤器可以实现获得ip地址, 现在是在具体的接口类中想要获得提交请求的ip地址和访问的url,参考了如下方法 实际运行后ctx一直为空,后来把头部的修改为如下2种都没有用,目前没找到问题,...

maxin
2012/03/22
8.7K
4
Asp.net Core 和类库读取配置文件信息

看干货请移步至.net core 读取配置文件公共类 首先开一个脑洞,Asp.net core 被使用这么长时间了,但是关于配置文件(json)的读取,微软官方似乎并没有给出像.net framework读取web.config那...

有情怀的小猿
2018/11/27
0
0
如果一个员工三天两头请假,假如你是老板你会怎么做?

请假,应该是不得已偶尔为之,如果三天两头请假,这几乎成为了常态…… 断断续续的上班,无法安排工作,更谈不上保障工作质量。作为老板,也不要急于发飙,不妨先看看他请假的原因,再行判断...

明哥聊求职
2018/08/08
0
0
一个人的世界

当我写下这个标题的时候,我确实在上班。也许有人怀疑,上班还有这样的闲情?是的,因为我在运营商。别的不多说了。 今年7月份毕业,当初准备了一年的考研,也无疾而终(英语还好,数学和专业...

nicozhang
2012/11/23
362
3

没有更多内容

加载失败,请刷新页面

加载更多

【实战】3.迭代的规划

迭代的规划 在敏捷开发中比较常用的scrum强调的是增量,而agile强调的是迭代。在我们实际工作中,根据项目情况我们往往采用混合方式。 迭代的规划算是一个项目中非常重要的一环,一个迭代就是...

卖小女孩的小火柴
昨天
19
0
怎样寻回由于清空回收站的资料

问题描述: 清空回收站是非常常见的数据丢失现象。怎样寻回由于清空回收站的资料下面简单介绍一种快速且安全恢复的方法。 工具/软件:极限数据恢复软件 步骤1:先百度搜索并下载程序打开后,...

水果黄瓜
昨天
19
0
NAT深入浅出-04-NAT穿越可行行分析(基于新分类方法)

先写个title,然后慢慢实现

mr_liang0
昨天
17
0
聊聊skywalking的DatabaseSlowStatement

序 本文主要研究一下skywalking的DatabaseSlowStatement DatabaseSlowStatement skywalking-6.6.0/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/Da......

go4it
昨天
17
0
Linux常用命令13 - echo

echo 命令是 Linux 中最基本和最常用的命令之一。 传递给 echo 的参数被打印到标准输出中。 echo 通常用于 shell 脚本中,用于显示消息或输出其他命令的结果。 echo 命令 echo 是 Bash 和其他...

叉叉敌
昨天
11
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部