[代码整洁之道]你真的会用枚举吗？非也！
【正确使用方式谈】
毋庸置疑，枚举提高了代码的可读性和可维护。给前面这句话加个定语——“正确使用”。
如果使用不当，适得其反。
如果把某域定义成了枚举，那么，正确使用枚举要注意如下几点：
- 除了对外交易的输入输出，程序内部涉及到该域的，一律用枚举类型。例如：方法参数、dto的属性。
- 接收到外来的数据后，在使用该域时，应先把该域转换成枚举类型。
要做到上面几点，容易，也不容易。 我见到很多的程序，都没有正确使用枚举。所以不再一遍一遍重复讲了，看这篇博客吧。下面以一例来阐释。
【看一例更易懂】
简单写一个demo，目录结构如下图：
§1 各package的职责：common是通用的，这里只定义了一个枚举类CurrencyEnum；dto是程序里用到的数据传输对象；po即持久化对象，对应数据库里的数据表；service是业务处理服务类。
§2 各class文件说明：
CurrencyEnum把“货币类型”这个域定义为枚举。
PayPO是持久化对象，数据类型只能用基本类型。我们一般就是在读写库时用它。其中，currency字段存储的值是枚举里定义的CNY、USD、GBP、JPY、HKD。
PayDTO是程序里各class方法传输的对象。那么它就不同于PayPO了。它频繁穿梭在程序里，所以我们要能很容易就能识别出来它是最好的了（可读性），这里，就用到了上面定义的枚举类型。
RouteService是模拟的一个获取路由的服务类，为了说的更明白，这里使用方法重载定义了两个方法，一个方法的参数是枚举，一个方法的参数是dto。
用法见MainService。模拟了一个从db获取对象，然后转换成枚举或dto获取路由的过程。
§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;
}
}
PayDTO：
package enumdemo.dto;
import enumdemo.common.CurrencyEnum;
import java.math.BigDecimal;
public class PayDTO {
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.dto.PayDTO;
import enumdemo.dto.RouteDTO;
public class RouteService {
public RouteDTO getRoute(CurrencyEnum currency){
RouteDTO routeDTO=new RouteDTO();
//逻辑代码略
return routeDTO;
}
public RouteDTO getRoute(PayDTO payDTO){
RouteDTO routeDTO=new RouteDTO();
//逻辑代码略
return routeDTO;
}
}
MainService：
package enumdemo.service;
import enumdemo.common.CurrencyEnum;
import enumdemo.dto.PayDTO;
import enumdemo.po.PayPO;
import enumdemo.dto.RouteDTO;
import org.springframework.beans.factory.annotation.Autowired;
public class MainService {
@Autowired
RouteService routService;
public void doRoute() {
final PayPO payRecord = null;//TODO：伪代码，这里是读库得到的
String alphabetCode = payRecord.getCurrency();
CurrencyEnum currencyEnum = CurrencyEnum.getByAlphabetCode(alphabetCode);
// ** 直接传枚举类型
RouteDTO dto = routService.getRoute(currencyEnum);
PayDTO payDTO = new PayDTO();
payDTO.setMoney(payRecord.getMoney());
payDTO.setCurrency(currencyEnum);
// ** 传dto
RouteDTO dto2 = routService.getRoute(payDTO);
}
}
【conclusion】
主要关注RouteService两个方法的参数。如果这里把货币类型currency变量定义成String，那么，你可以比较与定义成CurrencyEnum的不同。同样，PayDTO里的currency也如是。
有同学该反问，这有什么呀！大家知道货币类型有CNY、USD、GBP、JPY、HKD那几个值不就行了。 那么问题来了，我们做的一个项目，可不是这个demo这么简单哟~，会有好多好多这样的域，如订单状态，支付方式，产品类型，用户类型，营销方式。。。。。。，这些域的各个项的code可能是0、1、2、3、4、5、6、7、8等这样的数字（程序员对这些code的定义往往比较随意，即使不随意，受限于英语水平或拼音水平，定义出来的也往往不容易记忆），服务逻辑也远比这个demo要复杂。你如果能记得住，舅服你。不过，你记得住，并不代表所有人都记得住。要知道，你不是一个人在作战，你的项目也不是孤立的。