魔鬼数字的定义:在代码中没有具体含义的数字、字符串。
魔鬼数字主要影响了代码可读性,读者看到的数字无法理解其含义,从而难以理解程序的意图。当程序中出现的魔鬼数字过多时,代码的可维护性将会急剧下降,代码变得难以修改,并容易引入错误。
例如:
修改后:
解决方法:用常量定义魔鬼数字。
个人理解——>魔鬼数字:即难以被理解的且没有注释的常量(0、1这种)表示某个有意义的参数来使用。
在代码中使用魔鬼数字(没有具体含义的数字、字符串等)将会导致代码难以理解,应该将数字定义为名称有意义的常量。
将数字定义为常量的最终目的是为了使代码更容易理解,所以并不是只要将数字定义为常量就不是魔鬼数字了。如果常量的名称没有意义,无法帮助理解代码,同样是一种魔鬼数字。
在个别情况下,将数字定义为常量反而会导致代码更难以理解,此时就不应该强求将数字定义为常量。
案例
// 魔鬼数字,无法理解3具体代表产品的什么状态
if (product.getProduct().getProductStatus() != 3)
{
throw new PMSException(PMSErrorCode.Product.ADD_ERROR);
}
// 仍然是魔鬼数字,无法理解NUM_THREE具体代表产品的什么状态
if (product.getProduct().getProductStatus() != NUM_THREE)
{
throw new PMSException(PMSErrorCode.Product.ADD_ERROR);
}
//例子中虽然将数字定义为了常量,但代码却并不容易理解
Point drawCenter = new Point();
drawCenter.x = parentWindow.x (parentWindow.width - clientWindow.width) / HALF_SIZE_DIV;
drawCenter.y = parentWindow.y (parentWindow.height - clientWindow.height) / HALF_SIZE_DIV;
return drawCenter;
//直接使用数字,代码反而更容易理解
Point drawCenter = new Point();
drawCenter.x = parentWindow.x (parentWindow.width - clientWindow.width) / 2;
drawCenter.y = parentWindow.y (parentWindow.height - clientWindow.height) / 2;
return drawCenter;