美文网首页程序员
[代码整洁之道]你真的会用枚举吗?非也!

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

作者: buguge | 来源:发表于2018-08-10 20:34 被阅读16次

【preface】

§1

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

§2

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

【正确使用方式谈】

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

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

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

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

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

【一例以明之】

简单写一个demo,目录结构如下图:

image

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

相关文章

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

    【preface】 §1 《代码整洁之道》里提到”用异常代替返回错误码“。如果缺乏代码维护经验,估计一时理解不了其...

  • [代码整洁之道]-整洁代码

    前段时间,看了代码整洁之道,顺手做了些笔记,分享给大家,和大家一起探讨整洁代码之道。 1.1要有代码 代码是我们最...

  • 代码整洁之道-<函数>

    代码整洁之道-<函数> 代码整洁之道 一书相关读书笔记,整洁的代码是自解释的,阅读代码应该如同阅读一篇优秀的文章,...

  • 代码整洁之道

    01、有意义的命名 在团队开发中,团队小伙伴编码风格各不相同,一个统一的规范就显得尤为重要,最近在做Code Re...

  • 代码整洁之道

    整洁代码 Leblanc : Later equals never.(勒布朗法则:稍后等于永不) 对代码的每次修改...

  • 代码整洁之道

    海到无边天作岸,山登绝顶我为峰。作为猿类的我们,对自己创造的代码有着一种天生的无比自信。这是好事~可是,对于我们的...

  • 代码整洁之道

    1.一次只做一件事的原则 除了最外边必要的空判断,少用return操作符。原则如下图所示:一次只做一件事情.png...

  • 代码整洁之道

    一.整洁代码 借用一条美国童子军简单军规:让营地笔记来时更干净 二.有意义的命名 2.7避免使用编码编码已经太多,...

  • 代码整洁之道

    大概读了一下《代码整洁之道》这本书,总结如下: 1.变量名:有意义、可读性好 2.避免重复和无意义的条件判断 3....

  • 《代码整洁之道》

    细节之中自有天地,整洁成就卓越代码。 软件专家RoberfC.Marlin在《代码整洁之道》中为你呈现出了革命性的...

网友评论

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

    本文链接:https://www.haomeiwen.com/subject/qhwlbftx.html