（1/8）[代码整洁之道]你真的会用枚举吗？非也！

 

 

【preface】

§1 

《代码整洁之道》里提到”用异常代替返回错误码“。如果缺乏代码维护经验，估计一时理解不了其中含义。写代码是一回事，维护代码是一回事。
用异常代替返回错误码是对代码“职责”的运用，即分离业务逻辑代码和错误处理代码。同时，用抛出异常的方式代替返回错误码并未改变方法的返回值，对方法没有产生任何破坏。

§2

我在小组的开发规范里指明一条“严禁不加思考的代码copy。当代码copy超过10行，你一定要思考，是不是该重构了？”
也许有些同学并不知道DRY原则，也不清楚“小规模复用”。 So，Just do it！照做即可，日后也许会懂。

 

【正确使用方式谈】

如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，则定义为枚举类。《阿里巴巴Java开发手册》中也有提及。

强调一点，并不是一成不变的东西才可以定义成枚举，按照系统业务可以明确取值范围的变量，都可以定义为枚举。什么意思？有些同学（jìng rán）认为“一年四季”、“一周七天”才可以定义为枚举“SeasonEnum”、“WeekdayEnum”。而在系统开发中，诸如“用户状态”、“订单类型”、“支付状态”、“计费方式”etc.，都可以定义为枚举。

毋庸置疑，枚举提高了代码的可读性和可维护性。

我给前面这句话加个定语——“正确使用”。就是说，正确使用枚举可以提高代码的可读性和可维护性。

如果使用不当，可能达不到效果，甚至适得其反。 

 

如果把某域定义成了枚举，那么，正确使用枚举要注意如下几点：

• 除了对外的输入输出，程序内部涉及到该域的，一律用枚举类型来做逻辑处理。例如：方法参数、方法返回值、bo的属性。
• 接收到外来的数据后，在使用该域时，应先把该域转换成枚举类型。

说明一下，上面两点提到的“外”指的是当前应用系统的外部，如db、其他交易系统、http接口调用。

要做到上面两点，容易，也不容易。 我见到很多的程序，都没有正确使用枚举。所以不再一遍一遍重复讲了，看这篇博客吧。下面以一例来阐释。

 

【一例以明之】

毋容置疑，我们的应用一般都是分层结构（Layered Architecture）的，局域网的分布式系统也多采用面向服务的分层体系结构（Layered Service Oriented Architecture）。【PS：关于分层结构，dozer的这篇文章介绍的比较专业：​​http://dozer.sourceforge.net/documentation/whymap.html ​​】

下面，简单写一个demo，目录结构如下图：

 

 

 

§1 各package的职责：common是通用的，这里只定义了一个枚举类CurrencyEnum；bo是程序里用到的业务数据对象；po即持久化对象，对应数据库里的数据表；service是业务处理服务类。（参考​​PO/POJO/BO/DTO/VO的区别​​）

 

§2 各class文件说明：

CurrencyEnum把“货币类型”这个域定义为枚举。

PayPO是持久化对象，数据类型只能用基本类型。我们一般就是在读写库时用它。其中，currency字段存储的值是枚举里定义的CNY、USD、GBP、JPY、HKD。

PayBO是程序里各class方法传输的对象。那么它就不同于PayPO了。它频繁穿梭在程序里，所以我们要能很容易就能识别出来它是最好的了（可读性），这里，就用到了上面定义的枚举类型。

RouteService是模拟的一个获取路由的服务类，为了说的更明白，这里使用方法重载定义了两个方法，一个方法的参数是枚举，一个方法的参数是bo。

用法见MainService。模拟了一个从db获取对象，然后转换成枚举或bo获取路由的过程。

 

§3 代码：

 CurrencyEnum：

package enumdemo.common;


/**
 * 货币类型枚举
 */
public enum CurrencyEnum {
    CNY("CNY", "人民币"),
    USD("USD", "美元"),
    GBP("GBP", "英镑"),
    JPY("JPY", "日元"),
    HKD("HKD", "港元");

    //alphabet
    private final String alphabetCode;
    private final String name;

    CurrencyEnum(String alphabetCode, String name) {
        this.alphabetCode = alphabetCode;
        this.name = name;
    }

    public String getAlphabetCode() {
        return alphabetCode;
    }

    public String getName() {
        return name;
    }

    /**
     * 通过英文字母编码获取对应的货币类型</br>
     *
     * @param alphabetCode 英文字母货币
     * @return
     */
    public static CurrencyEnum getByAlphabetCode(String alphabetCode) {
        if (null == alphabetCode) {
            return null;
        }
        for (CurrencyEnum currencyEnum : values()) {
            if (currencyEnum.getAlphabetCode().equals(alphabetCode)) {
                return currencyEnum;
            }
        }
        return null;
    }

}

View Code

 

PayPO：

package enumdemo.po;

import java.math.BigDecimal;

public class PayPO {
    String orderNo;
    BigDecimal money;
    String currency;

    // getter/setter（略）

View Code

 

PayBO：

package enumdemo.bo;

import enumdemo.common.CurrencyEnum;
import java.math.BigDecimal;

public class PayBO {
    String orderNo;
    BigDecimal money;
    CurrencyEnum currency;

    // getter/setter（略）

View Code

 

RouteService：

package enumdemo.service;

import enumdemo.common.CurrencyEnum;
import enumdemo.bo.PayBO;
import enumdemo.bo.RouteBO;

public class RouteService {
    public RouteBO getRoute(CurrencyEnum currency) {
        switch (currency) {
            case CNY:
                RouteBO routeBO1 = new RouteBO();
                //逻辑代码略
                return routeBO1;
            default:
                RouteBO routeBO2 = new RouteBO();
                //逻辑代码略
                return routeBO2;
        }
    }

    public RouteBO getRoute(PayBO payBO) {
        RouteBO routeBO = new RouteBO();
        if (CurrencyEnum.CNY == payBO.getCurrency()) {
            //逻辑代码略
            return routeBO;
        } else {
            //逻辑代码略
            return routeBO;
        }
    }
}

View Code

 

MainService：

package enumdemo.service;

import enumdemo.common.CurrencyEnum;
import enumdemo.bo.PayBO;
import enumdemo.po.PayPO;
import enumdemo.bo.RouteBO;
import org.springframework.beans.factory.annotation.Autowired;

public class MainService {
    @Autowired
    RouteService routService;

    public void process() {
        final PayPO payRecord = null;//TODO：伪代码，这里是读库得到的
        String alphabetCode = payRecord.getCurrency();
        CurrencyEnum currencyEnum = CurrencyEnum.getByAlphabetCode(alphabetCode);

        // ** 直接传枚举类型
        RouteBO routeBO = routService.getRoute(currencyEnum);

        PayBO payBO = new PayBO();
        payBO.setMoney(payRecord.getMoney());
        payBO.setCurrency(currencyEnum);
        // ** 传bo
        RouteBO routeBO1 = routService.getRoute(payBO);
    }
}

View Code

 

 

【conclusions】

上面示例里PayBO的枚举类型属性 和 RouteService方法的枚举类型参数或bo参数，使得枚举的使用和判断变得一目了然！ 如果这里把货币类型currency变量定义成String，那么，你可以比较与定义成CurrencyEnum的不同。同样，PayBO里的currency也如是。

有同学该反问，这有什么呀！大家记住货币类型有CNY、USD、GBP、JPY、HKD那几个值不就行了。 那么问题来了，我们做的一个项目，可不是这个demo这么简单哟~，会有好多好多这样的域，如订单状态，支付方式，产品类型，用户类型，营销方式。。。。。。，这些域的各个项的code可能是0、1、2、3、4、5、6、7、8等这样的数字（程序员对这些code的定义往往比较随意，即使不随意，受限于英语水平或拼音水平，定义出来的也往往不容易记忆），服务逻辑也远比这个demo要复杂。你如果能记得住，舅服你。不过，你记得住，并不代表所有人都记得住。要知道，你不是一个人在作战，你的项目也不是孤立的。