[代码整洁之道]你真的会用枚举吗?非也!

【preface】

§1

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

§2

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

【正确使用方式谈】

毋庸置疑,枚举提高了代码的可读性和可维护。给前面这句话加个定语——“正确使用”。

如果使用不当,适得其反。

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

  • 除了对外交易的输入输出,程序内部涉及到该域的,一律用枚举类型。例如:方法参数、bo的属性。
  • 接收到外来的数据后,在使用该域时,应先把该域转换成枚举类型。

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

【一例以明之】

简单写一个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;
    }

}

PayPO:

package enumdemo.po;

import java.math.BigDecimal;

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

    public String getOrderNo() {
        return orderNo;
    }

    public void setOrderNo(String orderNo) {
        this.orderNo = orderNo;
    }

    public BigDecimal getMoney() {
        return money;
    }

    public void setMoney(BigDecimal money) {
        this.money = money;
    }

    public String getCurrency() {
        return currency;
    }

    public void setCurrency(String currency) {
        this.currency = currency;
    }
}

PayBO:

package enumdemo.bo;

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

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

    public String getOrderNo() {
        return orderNo;
    }

    public void setOrderNo(String orderNo) {
        this.orderNo = orderNo;
    }

    public BigDecimal getMoney() {
        return money;
    }

    public void setMoney(BigDecimal money) {
        this.money = money;
    }

    public CurrencyEnum getCurrency() {
        return currency;
    }

    public void setCurrency(CurrencyEnum currency) {
        this.currency = currency;
    }
}

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;
        }
    }
}

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);
    }
}

【conclusion】

上面示例里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要复杂。你如果能记得住,舅服你。不过,你记得住,并不代表所有人都记得住。要知道,你不是一个人在作战,你的项目也不是孤立的。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,651评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,468评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,931评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,218评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,234评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,198评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,084评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,926评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,341评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,563评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,731评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,430评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,036评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,676评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,829评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,743评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,629评论 2 354

推荐阅读更多精彩内容