编写高质量JAVA程序代码的建议

第一章  Java开发中通用的方法和准则

建议1：不要在常量和变量中出现易混淆的字母；

（i、l、1；o、0等）。

建议2：莫让常量蜕变成变量；

（代码运行工程中不要改变常量值）。

建议3：三元操作符的类型务必一致；

（不一致会导致自动类型转换，类型提升int->float->double等）。

建议4：避免带有变长参数的方法重载；

（变长参数的方法重载之后可能会包含原方法）。

建议5：别让null值和空值威胁到变长方法；

（两个都包含变长参数的重载方法，当变长参数部分空值，或者为null值时，重载方法不清楚会调用哪一个方法）。

建议6：覆写变长方法也循规蹈矩；

（变长参数与数组，覆写的方法参数与父类相同，不仅仅是类型、数量，还包括显示形式）。

建议7：警惕自增的陷阱；

（count=count++;操作时JVM首先将count原值拷贝到临时变量区，再执行count加1，之后再将临时变量区的值赋给count，所以count一直为0或者某个初始值。C++中count=count++;与count++等效，而PHP与Java类似）。

建议8：不要让旧语法困扰你；

（Java中抛弃了C语言中的goto语法，但是还保留了该关键字，只是不进行语义处理，const关键中同样类似）。

建议9：少用静态导入；

（Java5引入的静态导入语法import static，使用静态导入可以减少程序字符输入量，但是会带来很多代码歧义，省略的类约束太少，显得程序晦涩难懂）。

建议10：不要在本类中覆盖静态导入的变量和方法；

（例如静态导入Math包下的PI常量，类属性中又定义了一个同样名字PI的常量。编译器的“最短路径原则”将会选择使用本类中的PI常量。本类中的属性，方法优先。如果要变更一个被静态导入的方法，最好的办法是在原始类中重构，而不是在本类中覆盖）。

建议11：养成良好的习惯，显式声明UID；

（显式声明serialVersionUID可以避免序列化和反序列化中对象不一致，JVM根据serialVersionUID来判断类是否发生改变。隐式声明由编译器在编译的时候根据包名、类名、继承关系等诸多因子计算得出，极其复杂，算出的值基本唯一）。

建议12：避免用序列化类在构造函数中为不变量赋值；

（在序列化类中，不适用构造函数为final变量赋值）（序列化规则1：如果final属性是一个直接量，在反序列化时就会重新计算；序列化规则2：反序列化时构造函数不会执行；反序列化执行过程：JVM从数据流中获取一个Object对象，然后根据数据流中的类文件描述信息（在序列化时，保存到磁盘的对象文件中包含了类描述信息，不是类）查看，发现是final变量，需要重新计算，于是引用Person类中的name值，而此时JVM又发现name没有赋值（因为反序列化时构造函数不会执行），不能引用，于是它不再初始化，保持原始值状态。整个过程中需要保持serialVersionUID相同）。

建议13：避免为final变量复杂赋值；

（类序列化保存到磁盘上（或网络传输）的对象文件包括两部分：1、类描述信息：包括包路径、继承关系等。注意，它并不是class文件的翻版，不记录方法、构造函数、static变量等的具体实现。2、非瞬态（transient关键字）和非静态（static关键字）的实例变量值。总结：反序列化时final变量在以下情况下不会被重新赋值：1、通过构造函数为final变量赋值；2、通过方法返回值为final变量赋值；3、final修饰的属性不是基本类型）。

建议14：使用序列化类的私有方法巧妙解决“部分属性持久化问题”；

（部分属性持久化问题解决方案1：把不需要持久化的属性加上瞬态关键字（transient关键字）即可，但是会使该类失去了分布式部署的功能。方案2：新增业务对象。方案3：请求端过滤。方案4：变更传输契约，即覆写writeObject和readObject私有方法，在两个私有方法体内完成部分属性持久化）。

建议15：break万万不可忘；

（switch语句中，每一个case匹配完都需要使用break关键字跳出，否则会依次执行完所有的case内容。）。

建议16：易变业务使用脚本语言编写；

（脚本语言：都是在运行期解释执行。脚本语言三大特性：1、灵活：动态类型；2、便捷：解释型语言，不需要编译成二进制，不需要像Java一样生成字节码，依靠解释执行，做到不停止应用变更代码；3、简单：部分简单。Java使用ScriptEngine执行引擎来执行JavaScript脚本代码）。

建议17：慎用动态编译；

（好处：更加自如地控制编译过程。很少使用，原因：静态编译能够完成大部分工作甚至全部，即使需要使用，也有很好的替代方案，如JRuby、Groovy等无缝的脚本语言。动态编译注意以下4点：1、在框架中谨慎使用：debug困难，成本大；2、不要在要求高性能的项目中使用：需要一个编译过程，比静态编译多了一个执行环节；3、动态编译要考虑安全问题：防止恶意代码；4、记录动态编译过程）。

建议18：避免instanceof非预期结果；

（instanceof用来判断一个对象是否是一个类的实例，只能用于对象的判断，不能用于基本类型的判断（编译不通过），instanceof操作符的左右操作数必须有继承或实现关系，否则编译会失败。例：null instanceof String返回值是false，instanceof特有规则，若左操作数是null，结果就直接返回false，不再运算右操作数是什么类）。

建议19：断言绝对不是鸡肋；

（防御式编程中经常使用断言（Assertion）对参数和环境做出判断。断言是为调试程序服务的。两个特性：1、默认assert不启用；2、assert抛出的异常AssertionError是继承自Error的）。

建议20：不要只替换一个类；

（发布应用系统时禁止使用类文件替换方式，整体WAR包发布才是完全之策）（Client类中调用了Constant类中的属性值，如果更改了Constant常量类属性的值，重新编译替换。而不改变或者替换Client类，则Client中调用的Constant常量类的属性值并不会改变。原因：对于final修饰的基本类型和String类型，编译器会认为它是稳定态（Immutable Status），所以在编译时就直接把值编译到字节码中了，避免了再运行期引用，以提高代码的执行效率。而对于final修饰的类（即非基本类型），编译器认为它是不稳定态（Mutable Status），在编译时建立的则是引用关系（该类型也叫作Soft Final），如果Client类引入的常量是一个类或实例，即使不重新编译也会输出最新值）。

第二章  基本类型

建议21：用偶判断，不用奇判断；

（不要使用奇判断（i%2 == 1 ? "奇数" : "偶数"），使用偶判断（i%2 == 0 ? "偶数" : "奇数"）。原因Java中的取余（%标识符）算法：测试数据输入1 2 0 -1 -2，奇判断的时候，当输入-1时，也会返回偶数。

[java] view plain copy

1. //模拟取余计算，dividend被除数，divisor除数  
2. public static int remainder(int dividend, int divisor) {  
3.     return dividend - dividend / divisor * divisor;  
4. }  

）。

建议22：用整数类型处理货币；

（不要使用float或者double计算货币，因为在计算机中浮点数“有可能”是不准确的，它只能无限接近准确值，而不能完全精确。不能使用计算机中的二进制位来表示如0.4等的浮点数。解决方案：1、使用BigDecimal（优先使用）；2、使用整型）。

建议23：不要让类型默默转换；

（基本类型转换时，使用主动声明方式减少不必要的Bug）

[java] view plain copy

1. public static final int LIGHT_SPEED = 30 * 10000 * 1000;  
2. long dis2 = LIGHT_SPEED * 60 * 8;  

以上两句在参与运算时会溢出，因为Java是先运算后再进行类型转换的。因为dis2的三个运算参数都是int类型，三者相乘的结果也是int类型，但是已经超过了int的最大值，所以越界了。解决方法，在运算参数60后加L即可。

建议24：边界、边界、还是边界；

（数字越界是检验条件失效，边界测试；检验条件if(order>0 && order+cur<=LIMIT)，输入的数大于0，加上cur的值之后溢出为负值，小于LIMIT，所以满足条件，但不符合要求）。

建议25：不要让四舍五入亏了一方；

（Math.round(10.5）输出结果11；Math.round(-10.5)输出结果-10。这是因为Math.round采用的舍入规则所决定的（采用的是正无穷方向舍入规则），根据不同的场景，慎重选择不同的舍入模式，以提高项目的精准度，减少算法损失）。

建议26：提防包装类型的null值；

（泛型中不能使用基本类型，只能使用包装类型，null执行自动拆箱操作会抛NullPointerException异常，因为自动拆箱是通过调用包装对象的intValue方法来实现的，而访问null的intValue方法会报空指针异常。谨记一点：包装类参与运算时，要做null值校验，即（i!=null ? i : 0））。

建议27：谨慎包装类型的大小比较；

（大于>或者小于<比较时，包装类型会调用intValue方法，执行自动拆箱比较。而==等号用来判断两个操作数是否有相等关系的，如果是基本类型则判断数值是否相等，如果是对象则判断是否是一个对象的两个引用，也就是地址是否相等。通过两次new操作产生的两个包装类型，地址肯定不相等）。

建议28：优先使用整型池；

（自动装箱是通过调用valueOf方法来实现的，包装类的valueOf生成包装实例可以显著提高空间和时间性能）valueOf方法实现源码：

[java] view plain copy

1. public static Integer valueOf(int i) {  
2.     final int offset = 128;  
3.     if (i >= -128 && i <=127) {  
4.         return IntegerCache.cache[i + offset];  
5.     }  
6.     return new Integer(i);  
7. }  
8. class IntegerCache {  
9.     static final Integer cache[] = new Integer[-(-128) + 127 + 1];  
10.     static {  
11.         for (int i = 0; i < cache.length; i++)   
12.             cache[i] = new Integer(i - 128);  
13.     }  
14. }  

cache是IntegerCache内部类的一个静态数组，容纳的是-128到127之间的Integer对象。通过valueOf产生包装对象时，如果int参数在-128到127之间，则直接从整型池中获得对象，不在该范围的int类型则通过new生成包装对象。在判断对象是否相等的时候，最好是利用equals方法，避免“==”产生非预期结果。

建议29：优先选择基本类型；

（int参数先加宽转变成long型，然后自动转换成Long型。Integer.valueOf(i)参数先自动拆箱转变为int类型，与之前类似）。

建议30：不要随便设置随机种子；

（若非必要，不要设置随机数种子）（Random r = new Random(1000);该代码中1000即为随机种子。在同一台机器上，不管运行多少次，所打印的随机数都是相同的。在Java中，随机数的产生取决于种子，随机数和种子之间的关系遵从以下两个规则：1、种子不同，产生不同的随机数；2、种子相同，即使实例不同也产生相同的随机数。Random类默认种子（无参构造）是System.nanoTime()的返回值，这个值是距离某一个固定时间点的纳秒数，所以可以产生随机数。java.util.Random类与Math.random方法原理相同）。

第三章  类、对象及方法

建议31：在接口中不要存在实现代码；

（可以通过在接口中声明一个静态常量s，其值是一个匿名内部类的实例对象，可以实现接口中存在实现代码）。

建议32：静态变量一定要先声明后赋值；

（也可以先使用后声明，因为静态变量是类初始化时首先被加载，JVM会去查找类中所有的静态声明，然后分配空间，分配到数据区（Data Area）的，它在内存中只有一个拷贝，不会被分配多次，注意这时候只是完成了地址空间的分配还没有赋值，之后JVM会根据类中静态赋值（包括静态类赋值和静态块赋值）的先后顺序来执行，后面的操作都是地址不变，值改变）。

建议33：不要覆写静态方法；

（一个实例对象有两个类型：表面类型和实际类型，表面类型是声明时的类型，实际类型是对象产生时的类型。对于非静态方法，它是根据对象的实际类型来执行的，即执行了覆写方法。而对于静态方法，首先静态方法不依赖实例对象，通过类名访问；其次，可以通过对象访问静态方法，如果通过对象访问，JVM则会通过对象的表面类型查找到静态方法的入口，继而执行）。

建议34：构造函数尽量简化；

（通过new关键字生成对象时必然会调用构造函数。子类实例化时，首先会初始化父类（注意这里是初始化，可不是生成父类对象），也就是初始化父类的变量，调用父类的构造函数，然后才会初始化子类的变量，调用子类自己的构造函数，最后生成一个实例对象。构造函数太复杂有可能造成，对象使用时还没完成初始化）。

建议35：避免在构造函数中初始化其他类；

（有可能造成不断的new新对象的死循环，直到栈内存被消耗完抛出StackOverflowError异常为止）。

建议36：使用构造代码块精炼程序；

（四种类型的代码块：1、普通代码块：在方法后面使用“{}”括起来的代码片段；2、静态代码块：在类中使用static修饰，并使用“{}”括起来的代码片段；3、同步代码块：使用synchronized关键字修饰，并使用“{}”括起来的代码片段，表示同一时间只能有一个县城进入到该方法；4、构造代码块：在类中没有任何的前缀或后缀，并使用“{}”括起来的代码片段。编译器会把构造代码块插入到每个构造函数的最前端。构造代码块的两个特性：1、在每个构造函数中都运行；2、在构造函数中它会首先运行）。

建议37：构造代码块会想你所想；

（编译器会把构造代码块插入到每一个构造函数中，有一个特殊情况：如果遇到this关键字（也就是构造函数调用自身其他的构造函数时）则不插入构造代码块。如果遇到super关键字，编译器会把构造代码块插入到super方法之后执行）。

建议38：使用静态内部类提高封装性；

（Java嵌套内分为两种：1、静态内部类；2、内部类；静态内部类两个优点：加强了类的封装性和提高了代码的可读性。静态内部类与普通内部类的区别：1、静态内部类不持有外部类的引用，在普通内部类中，我们可以直接访问外部类的属性、方法，即使是private类型也可以访问，这是因为内部类持有一个外部类的引用，可以自由访问。而静态内部类，则只可以访问外部类的静态方法和静态属性，其他则不能访问。2、静态内部类不依赖外部类，普通内部类与外部类之间是相互依赖的关系，内部类不能脱离外部类实例，同声同死，一起声明，一起被垃圾回收器回收。而静态内部类可以独立存在，即使外部类消亡了；3、普通内部类不能声明static的方法和变量，注意这里说的是变量，常量（也就是final static修饰的属性）还是可以的，而静态内部类形似外部类，没有任何限制）。

建议39：使用匿名类的构造函数；

（List l2 = new ArrayList(){}; //定义了一个继承于ArrayList的匿名类，只是没有任何的覆写方法而已

[java] view plain copy

1. List l3 = new ArrayList(){{}}; //定义了一个继承于ArrayList的匿名类，并且包含一个初始化块，类似于构造代码块）<span style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255);">）</span>  

建议40：匿名类的构造函数很特殊；

（匿名类初始化时直接调用了父类的同参数构造器，然后再调用自己的构造代码块）

建议41：让多重继承成为现实；

（Java中一个类可以多种实现，但不能多重继承。使用成员内部类实现多重继承。内部类一个重要特性：内部类可以继承一个与外部类无关的类，保证了内部类的独立性，正是基于这一点，多重继承才会成为可能）。

建议42：让工具类不可实例化；

（工具类的方法和属性都是静态的，不需要实例即可访问。实现方式：将构造函数设置为private，并且在构造函数中抛出Error错误异常）。

建议43：避免对象的浅拷贝；

（浅拷贝存在对象属性拷贝不彻底的问题。对于只包含基本数据类型的类可以使用浅拷贝；而包含有对象变量的类需要使用序列化与反序列化机制实现深拷贝）。

建议44：推荐使用序列化实现对象的拷贝；

（通过序列化方式来处理，在内存中通过字节流的拷贝来实现深拷贝。使用此方法进行对象拷贝时需注意两点：1、对象的内部属性都是可序列化的；2、注意方法和属性的特殊修饰符，比如final、static、transient变量的序列化问题都会影响拷贝效果。一个简单办法，使用Apache下的commons工具包中的SerializationUtils类，直接使用更加简洁方便）。

建议45：覆写equals方法时不要识别不出自己；

（需要满足p.equals(p)放回为真，自反性）。

建议46：equals应该考虑null值情景；

（覆写equals方法时需要判一下null，否则可能产生NullPointerException异常）。