常量与魔法值处理

常量指的就是在其作用域中保持不变的量，一般使用final关键字来修饰，
根据作用域的划分，常量分为全局常量，类内常量和局部常量。
全局常量：public static final
类内常量：private static final
局部常量：final（方法内部）
示例代码：

package 常量魔法值与枚举;
public class 三种常量 {
public static final String GLOBAL_CONSTANT="shared in global";//全局常量
public static final String CLASS_CONSTANT="shared in class";//类内常量
public void f(String s) {
    final String methodConstant="shared in method";//局部常量
}
public void g(final int b) {//局部常量
    System.out.println(b);
    //b=3;报错常量不可被赋值
}
}

关于常量的命名，我们一般使用全大写字母，且单词之间使用_来隔开。
因为常量的使用范围经常是全类甚至全局的，如果常量的命名让人不知其意，那么就会造成阅读困难，这其中最常出现的问题就是魔法值。
魔法值即“共识层面”的常量，直接以具体的数值或字符出现在代码中。
如下程序所示：

int [] array = new int[20];
for (int i = 0; i < 20; i++){
    System.out.print(array[i]);
}

上述例子中，如果数组的声明与for循环相隔比较远，就很难知道 for循环里面的控制条件 i < 20 中 20 具体含义是什么。它是数组的长度呢，还是根据需求定义的界限值呢？就搞不清楚。
魔法数值使代码的可读性大大下降。而且，如果同样的数值多次出现时，到底这些数值是不是带有同样的含义呢，谁也说不清楚。另一方面，如果本来应该使用相同数值的地方，一旦用错了，也很难发现。因此，我们应极力避免使用魔法数值。
解决办法就是使用static final 定义常量或使用enum值
关于常量我们已经说过了，下面我们来写下枚举怎么解决魔法值问题。

假如有如下场景，我们需要向一个视频网站上放上我们的教学视频，但是我们想让视频分类，有些视频可以被观看，有些视频不能被观看，刚投稿的视频要进审核也不能观看。
大概在最开始我们的代码可以这样写

public void getOnlinePackageCourse(Long packageId,Long userId) {
    if(packageId==3) {
        logger.error("线下课程，无法线上观看");
        return;
    }
    //其他逻辑处理
    PackageCourse online = PackageService.getByTeacherId(userId);
    if(online.getPackageId == 2) {
        logger.error("未审核课程");
        return;
    }
    //其他逻辑处理
}
}

我们随意的用魔法值2，3来表示未审核课程和线下课程，两个数字而已，容易记忆。但是除了2，3外，还有1，4，5，6等表示其他类型的课程。或许我们在开发中可以靠记忆来判断和告知其他人，这些数字代表什么，但是时间一长，总会出漏洞。
为此，我们重构代码，示例如下：

public enum CourseTypeEnum {
/**
 * 允许官方和讲师创建和运营
 */
    VIDEO_COURSE(1, "录播课程"),
    
/**
 * 只允许官方创建和运营，初始化必须设置合理的报名人数上限
 * 
*/
    LIVE_COURSE(2,"直播课程"),
/**
 * 只允许官方创建和运营
 */
   ODDLINE_COURSE(3,"线下课程");
    private int seq;
    private String desc;
    private CourseTypeEnum(int seq, String desc) {
        this.seq = seq;
        this.desc = desc;
    }
    public int getSeq() {
        return seq;
    }
    public String getDesc() {
        return desc;
    }
    
}

上面把课程分为了三种，枚举类型是几乎不会改变的全局常量。
我们再把视频分为新课程，未审核课程，审核通过，审核不通过，以删除等五种状态。用常量来定义

public abstract class BaseCourseState {
public static final int NEW_COURSE = 1;
public static final int UNAUTHED_COURSE = 2;
public static final int PASSED_COURSE = 3;
public static final int  NOT_PASSED_COURSE = 4;
public static final int DELETE_COURSE = 5;
}

经过代码重构后，我们的代码可读性立刻有了明显提升。

public void getOnlinePackageCourse(Long packageId,Long userId) {
        if(packageId==CourseTypeEnum.OFFLINE_COURSE.getSeq()) {
            logger.error("线下课程，无法线上观看");
            return;
        }
        //其他逻辑处理
        //PackageCourse online = PackageService.getByTeacherId(userId);
        if(online.getPackageId == BaseCourseState.UNAUTHED_COURSE) {
            logger.error("未审核课程");
            return;
        }
        //其他逻辑处理
    }

代码为什么不允许出现魔法值

即使类内常量和局部变量当前只使用一次，也要赋予一个有意义的名称，目的一是望文知义，二是在后期多次使用时能做到值出同源。

以下为警示代码：

String key="Id#taobao_"+tradeId;
cache.put(key,value);

上面是用魔法值来拼装key，这导致各个调用方到处复制粘贴字符串
Id#taobao_,终于有一天，一个粗心的程序员复制的时候少了_,
这个错误在测试没有被发现，因为缓存没有命中，会自动访问数据库。在大促中，数据库压力急剧上升，进而发现缓存全部失效，导致连接占满，查询变慢。