枚举类使用总结

系统管理员 2022-04-15 01:06 332阅读 0赞

【引言】

在旧项目中，对于像订单状态，支付方式等一些特定范围的字段，在进行对应的code或状态值互相转换的时候，都会去写一大段的判断方法，做项目的人多了，都自己写自己的，也不知道有方法可以共用，从而导致代码越来越难维护。新项目中，我们把这样的字段都定义为枚举类，用起来也方便了很多。

【阿里开发手册】

在阿里Java开发手册中关于枚举的使用，有以下几点要求：

1.  【强制】 所有的枚举类型字段必须要有注释，说明每个数据项的用途。
2.  【强制】 二方库（指的是公司内部其他项目提供的依赖）里可以定义枚举类型，，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的 POJO 对象。
3.  【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
    
    说明： 枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
    
    正例： 枚举名字为 ProcessStatusEnum 的成员名称： SUCCESS / UNKOWN\_REASON。
4.  【推荐】在常量定义章节中也提到，如果变量值仅在一个范围内变化，且带有名称之外的延伸属性， 定义为枚举类。下面正例中的数字就是延伸信息，表示星期几。
    
    正例： public Enum \{ MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6),SUNDAY(7);\}

【枚举类特征】

1.  不能有public的构造函数，这样可以保证没有办法新建一个enum的实例。
2.  所有的枚举值都是public ，static ， final的。这一点只针对于枚举值，我们可以和在普通类里面定义变量一样定义其它任何类型的非枚举变量，这些变量可以使用任何修饰符。
3.  所有的枚举都继承自java.lang.Enum类。由于Java 不支持多继承，所以枚举对象不能再继承其他类。
4.  Enum覆载了toString方法，且提供了valueOf()方法，与toString方法相对应。
5.  Enum默认实现了java.lang.Comparable接口，也就是根据ordinal方法（返回在枚举值中的顺序）进行排序
6.  Enum提供了values方法，这个方法可以方便的遍历所有的枚举值。

【代码实例】

//订单状态枚举类
    public enum OrderStateEnum {
    
        //1. 定义枚举值
        OPT_CANCEL("0","取消","CANCEL"),
        OPT_CREATE("10","未支付","CREATE"),
        OPT_ONLINE_PAY("20","待发货","ONLINE_PAY"),
        OPT_BUSI_AUDIT("14","业务审核","BUSI_PAY"),
        OPT_FINA_AUDIT("17","财务审核","FINA_AUDIT"),
        OPT_CON_MENT("25","发货中","CON_MENT"),
        OPT_DISM_TING("100","已拆单","DISM_TING"),
        OPT_DISPATCH("30","已发货","DISPATCH"),
        OPT_FINISH("50","已完成","FINISH"),
        OPT_UNKNOWN("-1","未知","UNKNOWN");
    
        //2. 定义成员变量
        /**
         * 订单状态编码
         */
        private String code;
        /**
         * 订单状态名称
         */
        private String stateName;
        /**
         * 订单状态英文名称
         */
        private String stateEnName;
    
        //3. 私有的构造函数
        /**
         * @param code
         * @param stateName
         * @param stateEnName
         */
        OrderState(String code, String stateName, String stateEnName) {
            this.code = code;
            this.stateName = stateName;
            this.stateEnName = stateEnName;
        }
    
        //get/set方法
        public String getCode() {
            return code;
        }
        public void setCode(String code) {
            this.code = code;
        }
        public String getStateName() {
            return stateName;
        }
        public String getStateEnName() {
            return stateEnName;
        }
        
        //4. 定义自己的方法
        /**
         * 根据编码获取对应的状态名称
         * @param code
         * @return
         */
        public static String getNameByCode(String code){
            //5. values()获取所有的枚举值
            OrderState[] orderStates =  OrderState.values();
            for(int i=0;i<orderStates.length;i++){
                OrderState orderState = orderStates[i];
                if(orderState.getCode().equals(code)){
                    return orderState.getStateName();
                }
            }
            return code;
        }
        
        /**
         * 获取所有的订单状态编码及对应的状态名称
         * @return
         */
        public static List<Map<String,String>> getAllOrderState(){
            List<Map<String,String>> allPayment = new LinkedList<>();
            OrderState[] values = OrderState.values();
            if(values.length>0){
                for(int i=0;i<values.length;i++){
                    OrderState orderState = values[i];
                    Map<String,String> map = new HashMap<>();
                    map.put(orderState.getCode(),orderState.stateName);
                    allPayment.add(map);
                }
            }
            return allPayment;
        }
    }

【总结】

和旧项目中的使用对比，可以看出使用枚举类在代码上简洁明了了很多，也减少了大片重复冗余的代码出现概率。对于它的一些高级特性，我们也没必要去为了使用而使用，代码写的简单易懂最好。