Java中的魔法值解决

目录
  • Java中的魔法值
    • 背景
    • 介绍
    • 解决方法
  • Java的魔法值概念

Java中的魔法值

背景

使用IDEA时，启用了阿里的代码规范检查，其中就有一项提示是不允许任何魔法值出现在代码里，于是出于好奇就了解一下到底啥时魔法值。

介绍

魔法数值、魔法数字、魔法值，这是一个东西，不同的叫法。

魔法数字，在编程领域指的是莫名其妙出现的数字。数字的意义必须通过详细阅读才能推断出来

if("1".equals(dangerKey)){
            BigDecimal warningValue = new BigDecimal(JedisUtils.get(WARNING_VALUE_KEY));
            model.addAttribute("isDanger", true);
            model.addAttribute("warningValue", warningValue);
        }

上面代码中的字符串1就是一个魔法值，在未读整段代码之前，我并不知道这个字符串1代表什么意思，只有把这个字符串带入后面的代码逻辑才能判断该值的真实意义，而且如果多次出现，这就大大的降低了代码的可阅读性。所以我们在代码中应该极力避免产生魔法值。

解决方法

** 使用枚举类型或者使用static final修饰常量 **

//预警值标识
    public static final String DANGERKEY_TRUE ="1";
    if(DANGERKEY_TRUE.equals(dangerKey)){
            BigDecimal warningValue = new BigDecimal(JedisUtils.get(WARNING_VALUE_KEY));
            model.addAttribute("isDanger", true);
            model.addAttribute("warningValue", warningValue);
        }

以上就是使用static final的方式替换的魔法值，这样就可以避免了。如果在代码中多次使用的话，只需更声明的地方就可以达到全局的效果。

提示：静态常量的命名最好全是大写字母，如果是多个单词需要分割，可以使用下划线分割。

小结：魔法值的问题对于代码逻辑来说，并不是什么要命的事情，即使不修改也基本不影响代码的正常运行，我以前没有安装阿里代码检查规范时，一样这么使用，也没出现过啥问题。好吧，应该说但是了。但是，遵循公认的代码规范，可以有效的避免开发过程的一些小问题（最让人头疼的往往都是一些小问题引起的），提升开发的效率和代码的可阅读性，老老实实按照规范来，自然就会受益良多，继续加油！

Java的魔法值概念

想象一下，当你入职一家新公司，打开工具看以前同事的项目时，突然看到下面这段代码

String[] catNames = new String[7];
String[] dogNames = new String[7];
for(int i = 0; i < 7; i++) {
    //此处省略若干行
}

你心中一定很凌乱，可能还会在心底默默问候下写这段代码的前同事。

在没有注释的情况下，此处的i < 7，你根本无法知道是要处理 dogNames数组还是catNames数组，你还要继续去看循环体中的内容才能来推断这个数字的含义。这里的7就是魔法值。

所谓的魔法值，就是指在代码中直接出现的数值，只有在这个数值记述的那部分代码中才能明确了解其含义。

魔法值简单好用，任何项目基本上都会有魔法值的出现。但魔法值就像一段没有注释的代码，它的出现使得程序的可读性大大下降，甚至只有当事人才知道。这对于项目或者别的开发来说，无疑都是不利的。同时，如果到处用到魔法值，那需要修改的时候，就要修改很多地方，这不仅耗费时间，还很容易会遗漏。

魔法值的问题就是含义不明且无法统一使用，要把它们统一表示，并加上注释，我们可以用static final 定义常量或使用enum值。

static final int CAT_NUM = 7;
String[] catNames = new String[CAT_NUM];
for(int i = 0; i < CAT_NUM; i++) {
    //此处省略若干行
}
for(int i = 0; i < PET.DOG.getNum(); i++) {
    //此处省略若干行
} 

当然此处用catNames.length，dogNames.length也不会引起混淆。

其实魔法值也并不是要完全禁止不用，毕竟每次用到数值就要去定义常量或者在enum中新增元素还是很麻烦的。只要保障你的数值不会让别人难以阅读，你就可以使用魔法值。一般 -1、0 和 1不被视为魔法值。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。

赞 (0)

相关推荐

  • Jackson优雅序列化Java枚举类过程解析

    1. 前言 在Java开发中我们为了避免过多的魔法值,使用枚举类来封装一些静态的状态代码.但是在将这些枚举的意思正确而全面的返回给前端却并不是那么顺利,我们通常会使用Jackson类库序列化对象为JSON,今天就来讲一个关于使用Jackson序列化枚举的通用性技巧. 2. 通用枚举范式 为了便于统一处理和规范统一的风格,建议指定一个统一的抽象接口,例如: /** * The interface Enumerator. */ public interface Enumerator { /** *

  • JAVA开发中的一些规范讲解(阿里巴巴Java开发规范手册)

    一.编程规约 (一) 命名规约 1.   [强制]所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束.反例: _name / __name / $Object / name_ / name$ / Object$ 2.   [强制]所有编程相关的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式.说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义.注意,即使纯拼音命名方式也要避免采用. 反例: DaZhePromotion [打折] / getPingfen

  • 详解Java编程规约（命名风格、常量定义、代码格式）

    命名风格 1.[强制]代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name / $name / name_ / name$ / name__ 2.[强制]代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式. 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义.注意,纯拼音命名方式更要避免采用. 正例:renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称,可视

  • Java中的魔法值解决

    目录 Java中的魔法值 背景 介绍 解决方法 Java的魔法值概念 Java中的魔法值 背景 使用IDEA时,启用了阿里的代码规范检查,其中就有一项提示是不允许任何魔法值出现在代码里,于是出于好奇就了解一下到底啥时魔法值. 介绍 魔法数值.魔法数字.魔法值,这是一个东西,不同的叫法. 魔法数字,在编程领域指的是莫名其妙出现的数字.数字的意义必须通过详细阅读才能推断出来 if("1".equals(dangerKey)){             BigDecimal warningV

  • Java中HashMap如何解决哈希冲突

    Java中HashMap如何解决哈希冲突

    目录 1. Hash算法和Hash表 2. Hash冲突 3. 解决Hash冲突的方法有四种 4.HashMap在JDK1.8版本的优化 1. Hash算法和Hash表 了解Hash冲突首先了解Hash算法和Hash表 Hash算法就是把任意长度的输入通过散列算法变成固定长度的输出,这个输出结果就是一个散列值 Hash表又叫做“散列表”,它是通过key直接访问到内存存储位置的数据结构,在具体的实现上,我们通过Hash函数,把key映射到表中的某个位置,来获取这个位置的数据,从而加快数据的查找 2

  • java 中HashMap实现原理深入理解

    java 中HashMap实现原理深入理解

    1. HashMap的数据结构 数据结构中有数组和链表来实现对数据的存储,但这两者基本上是两个极端.       数组 数组存储区间是连续的,占用内存严重,故空间复杂的很大.但数组的二分查找时间复杂度小,为O(1):数组的特点是:寻址容易,插入和删除困难: 链表 链表存储区间离散,占用内存比较宽松,故空间复杂度很小,但时间复杂度很大,达O(N).链表的特点是:寻址困难,插入和删除容易. 哈希表 那么我们能不能综合两者的特性,做出一种寻址容易,插入删除也容易的数据结构?答案是肯定的,这就是我们要提

  • 解决Java中OutOfMemoryError的问题

    解决Java中OutOfMemoryError的问题

    目前为止,我遇到使用Tomcat有三种情况:第一,使用Eclipse,在Eclipse中配置Tomcat.第二,直接在Tomcat中部署项目.第三将Tomcat安装为windows服务. 在这三种情况下,出现OutOfMemoryError.该怎么解决呢?这里我不得不提我被网上那些不负责任的文章害得很惨.各种设置内存的方法都试了,可就是不起作用.下面我说的这几种方法都是我亲自试验过的,没有问题. 第一种情况:  如图:我用红色框框出来的.其中Xms和Xmx是增加java虚拟机初始堆大小和最大堆大

  • 理解Java中的内存泄露及解决方法示例

    理解Java中的内存泄露及解决方法示例

    本文详细地介绍了Java内存管理的原理,以及内存泄露产生的原因,同时提供了一些列解决Java内存泄露的方案,希望对各位Java开发者有所帮助. Java内存管理机制 在C++ 语言中,如果需要动态分配一块内存,程序员需要负责这块内存的整个生命周期.从申请分配.到使用.再到最后的释放.这样的过程非常灵活,但是却十分繁琐,程序员很容易由于疏忽而忘记释放内存,从而导致内存的泄露. Java 语言对内存管理做了自己的优化,这就是垃圾回收机制. Java 的几乎所有内存对象都是在堆内存上分配(基本数据类型

  • java 中遍历取值异常（Hashtable Enumerator）解决办法

    java 中遍历取值异常(Hashtable Enumerator)解决办法 用迭代器取值时抛出的异常:java.util.NoSuchElementException: Hashtable Enumerator 示例代码 //使用迭代器遍历 Iterator<String> it = tableProper.stringPropertyNames().iterator(); sqlMap = new HashMap<String,String>(); while(it.hasNe

  • java中Servlet Cookie取不到值原因解决办法

    java中Servlet Cookie取不到值原因解决办法 现象: 在测试带Cookie的HTTP请求时发现,服务端用request.getHeader("cookie")可以去到值; 但是用request.getCookies()却不行 Cookie mycookies[] = request.getCookies(); 中永远获取不到uid的值:(80端口号除外) 原因: 查了浏览器的具体cookie值,发现 http://localhost:8080/ 访问的时候,cookie值

  • Java中浮点数精度问题的解决方法

    问题描述 在项目中用Java做浮点数计算时,发现对于4.015*100这样的计算,结果不是预料中的401.5,而是401.49999999999994.如此长的位数,对于显示来说很不友好. 问题原因:浮点数表示 查阅相关资料,发现原因是:计算机中的浮点数并不能完全精确表示.例如,对于一个double型的38414.4来说,计算机是这样存储它的: 转成二进制:1001011000001110.0110011001100110011001100110011001100 转成科 学计数法:1.0010

  • Java中URL传中文时乱码的解决方法

    前言 Java中URL传中文时乱码的问题相信不少朋友都遇到过,最近就遇到一个问题,就是在Action当中把一条中文信息绑定在URL的后面,ActionForward到别一个页面时,用reqeust.getParameter取出是出现乱码的问题. 解决办法 1.对要进行URL传递的中文字符进行编码: String message = java.net.URLEncoder.encode("中文字符","utf-8"); 2.在取URL传递中文的页面对字符进行解码: S

  • java中double类型运算结果异常的解决方法

    问题: 对两个double类型的值进行运算,有时会出现结果值异常的问题.比如: System.out.println(19.99+20); System.out.println(1.0-0.66); System.out.println(0.033*100); System.out.println(12.3/100); 输出: 39.989999999999995 0.33999999999999997 3.3000000000000003 0.12300000000000001 解决方法: J

随机推荐