Java 如何减少魔法值的使用

转载

程序员泥瓦匠 2022-03-31 18:25:21

1. 前言

重构老代码中遇到了类似这种写法：

public void attend(String value) {
        if ("0".equals(value)) {
            //todo
        } else if ("1".equals(value)) {
            //todo
        } else {
            //todo
        }
    }

脑壳疼！从 Java 语法上无懈可击，但是从业务上却让人无法理解其中的含义。里面的 0 和 1 统称为魔法值 。

上面的代码我们往往需要通过上下文推断出来，如果是非常复杂的业务或者十年前的代码那就更惨了，搞不好文档也没有。所以我们要尽量避免出现魔法值。今天就来讲几种避免魔法值的操作。

2. 避免魔法值的一些操作。

一般魔法值都是不经常变动的。对于魔法值的处理要结合业务和作用域。

2.1 静态常量

如果该值的作用域在一个类中或者同一个包下，一般可以使用静态常量来解决。

private static final String FEMALE = "0";
    private static final String MALE = "1";
    public void attend(String value) {
        if (FEMALE.equals(value)) {
            //todo
        } else if (MALE.equals(value)) {
            //todo
        } else {
            //todo
        }
    }

这样是不是清晰了许多，原来 0 和 1 代表的是性别（当然需要配合你良好的变量命名习惯）。

2.2 使用接口

既然我们使用了静态常量那么我们可以将魔法值封装入接口也是可以的。

public interface Gender {
    String FEMALE = "0";
    String MALE = "1";
}

2.3 使用枚举

但是接口的意义在于提供抽象的功能而不是存储一些常量值，显然违背了接口设计的初衷。所以jdk1.5引入了枚举类型 enum。

public enum GenderEnum {
    FEMALE,
    MALE
}

很多情况这种写法就够用了，你可以通过 GenderEnum.MALE.ordinal() 获取对应枚举的数字序号，也可以通过GenderEnum.MALE.name() 获取对应枚举的字符串名称。他们大多数情况下都可以用来进行一些逻辑标识。但是满足不了我们上面最初的设计，我们需要来改造一下枚举类的构造函数。

public enum GenderEnum {

    FEMALE("0"),
    MALE("1");

    private final String value;

    GenderEnum(String value) {
        this.value = value;

    }

    public String value() {
        return this.value;
    }
}

这样改写之后我们就能通过 value() 方法拿到具体的值了。

我们给自己再增加点需求，以达到你的枚举更加友好的可读性。

public enum GenderEnum {

    UNKNOWN("-1", "未知"),
    FEMALE("0", "女性"),
    MALE("1", "男性");

    private final String value;
    private final String description;

    GenderEnum(String value, String description) {
        this.value = value;
        this.description = description;
    }

    public String value() {
        return this.value;
    }

    public String description() {
        return this.description;
    }
}