Java编程规范

军规条例
军规一：【避免在程序中使用魔鬼数字，必须用有意义的常量来标识。】
军规二：【明确方法的功能，一个方法仅完成一个功能。】
军规三：【方法参数不能超过5个】
军规四：【方法调用尽量不要返回null，取而代之以抛出异常，或是返回特例对象（SPECIAL CASE object，SPECIAL CASE PATTERN）；对于以集合或数组类型作为返回值的方法，取而代之以空集合或0长度数组。】
军规五：【在进行数据库操作或IO操作时，必须确保资源在使用完毕后得到释放，并且必须确保释放操作在finally中进行。】
军规六：【异常捕获不要直接 catch (Exception ex) ，应该把异常细分处理。】
军规七：【对于if ? else if ?(后续可能有多个else if …)这种类型的条件判断，最后必须包含一个else分支，避免出现分支遗漏造成错误；每个switch-case语句都必须保证有default，避免出现分支遗漏，造成错误。】
军规八：【覆写对象的equals()方法时必须同时覆写hashCode()方法。】
军规九：【禁止循环中创建新线程，尽量使用线程池。】
军规十：【在进行精确计算时(例如:货币计算)避免使用float和double，浮点数计算都是不精确的，必须使用BigDecimal或将浮点数运算转换为整型运算。】


军规说明
军规一：【避免在程序中使用魔鬼数字，必须用有意义的常量来标识。】
说明：是否是魔鬼数字要基于容易阅读和便于全局替换的原则。0、1作为某种专业领域物理量枚举数值时必须定义常量，严禁出现类似NUMBER_ZERO的“魔鬼常量”。


军规二：【明确方法的功能，一个方法仅完成一个功能。】
说明：方法功能太多，会增加方法的复杂度和依赖关系，不利于程序阅读和将来的持续维护，无论是方法还是类设计都应符合单一职责原则。


军规三：【方法参数不能超过5个】
说明：参数太多影响代码阅读和使用，为减少参数，首先要考虑这些参数的合理性，保持方法功能单一、优化方法设计，如果参数确实无法减少，可以将多个参数封装成一个类（对象），同时考虑在新的类（对象）中增加相应的行为，以期更符合OOP。


军规四：【方法调用尽量不要返回null，取而代之以抛出异常，或是返回特例对象（SPECIAL CASE object，SPECIAL CASE PATTERN）；对于以集合或数组类型作为返回值的方法，取而代之以空集合或0长度数组。】
说明：返回null会增加不必要的空指针判断，遗漏判断也会导致严重的NullPointerException错误。


军规五：【在进行数据库操作或IO操作时，必须确保资源在使用完毕后得到释放，并且必须确保释放操作在finally中进行。】
说明：数据库操作、IO操作等需要关闭对象必须在try -catch-finally 的finally中close()，如果有多个IO对象需要关闭，需要分别对每个对象的close()方法进行try-catch,防止一个IO对象关闭失败其他IO对象都未关闭。推荐做法如下：
        Connection jdbcConnection = null;
        Statement stmt = null;
        try
        {
             ........
        }
        catch (SQLException e)
        {
             ........
        }
        finally
        {
            if (stmt != null)
            {
                try
                {
                    stmt.close();
                }
                catch (SQLException e)
                {
                    logger.log(Level.WARNING, "异常说明", e);
                }
            }
            if (jdbcConnection != null)
            {
                try
                {
                    jdbcConnection.close();
                }
                catch (SQLException e)
                {
                    logger.log(Level.WARNING, "异常说明", e);
                }
            }
        }


军规六：【异常捕获不要直接 catch (Exception ex) ，应该把异常细分处理。】
说明：catch (Exception ex)的结果会把RuntimeException异常捕获，RuntimeException是运行期异常，是程序本身考虑不周而抛出的异常，是程序的BUG，如无效参数、数组越界、被零除等，程序必须确保不能抛出RuntimeException异常，不允许显示捕获RuntimeException异常就是为了方便测试中容易发现程序问题。


军规七：【对于if ? else if ?(后续可能有多个else if …)这种类型的条件判断，最后必须包含一个else分支，避免出现分支遗漏造成错误；每个switch-case语句都必须保证有default，避免出现分支遗漏，造成错误。】


军规八：【覆写对象的equals()方法时必须同时覆写hashCode()方法。】
说明：equals和hashCode方法是对象在hash容器内高效工作的基础，正确的覆写这两个方法才能保证在hash容器内查找对象的正确性，同时一个好的hashCode方法能大幅提升hash容器效率。


军规九：【禁止循环中创建新线程，尽量使用线程池。】


军规十：【在进行精确计算时(例如:货币计算)避免使用float和double，浮点数计算都是不精确的，必须使用BigDecimal或将浮点数运算转换为整型运算。】

说明：浮点运算在一个范围很广的值域上提供了很好的近似，但是它不能产生精确的结果。二进制浮点对于精度计算是非常不适合的，因为它不可能将0.1——或者10的其它任何次负幂精确表示为一个长度有限的二进制小数。

转载：http://www.cnblogs.com/guoyuqiangf8/p/3512699.html

军规条例1【public方法参数的合法性检查应由方法本身负责，每个public方法必须保证自己的健壮性。】 
军规条例2【调用方法获取返回结果后必须进行有效性校验，以确保后续代码在运行过程中不会抛出异常或产生逻辑错误。】 
军规条例3【在使用Timer或者ScheduledThreadPoolExecutor执行周期性任务时，实现Runnable接口必须在方法内捕获异常，避免因为异常抛出导致周期性住务失效，后续不会继续执行。】
军规条例4【确保程序不再持有无用对象的引用，避免程序内存泄露。】
军规条例5【对象比较必须使用equals方法，而不是”==”。】 
军规条例6【访问数组、List等容器内的元素时，必须首先检查下标是否越界，以杜绝下标越界异常的发生。】
军规条例7【将对象存入HashSet，或作为key存入HashMap（或HashTable）后，必须确保该对象的hashcode值不变，避免因为hashcode值的变化导致不能从容器内删除该对象，进而引起内存泄露的问题。】
军规条例8【在编码过程中，必须在适当的位置，以适当的级别打印日志，便于代码出现问题后进行定位分析。例如：方法入口，出口以Debug打印：异常分支使用ERROR,关键参数打印使用INFO。】
军规条例9【将字符串转换为数字时必须处理NumberFormatException异常。】 
军规条例10【在进行三个字符串（不包含三个）以上的串联操作时必须使用StringBuilder或StringBuffer，禁止使用“+”。】
军规条例11【根据应用场景选择最适合的容器，避免因为容器选择不当造成程序性能问题。】
军规条例12【必须在进行I/O操作时使用缓存。】 
军规条例13【在程序中必须考虑对象重用，避免创建不必要的垃圾对象。】 
军规条例14【新起一个线程时，都要使用Thread.setName(“…”)设置线程名。】 
军规条例15【线程使用时，要在代码框架中使用线程池，避免创建不可复用的线程。禁止在循环中创建新线程，否则会引起JVM资源耗尽】 

军规条例1【public方法参数的合法性检查应由方法本身负责，每个public方法必须保证自己的健壮性。】 
说明：public方法作为一个模块或功能的对外接口，会接受各种调用者的调用。其中可能会存在传入不合法参数的情况，为了避免方法发生不可预知错误，必须在方法入口处进行参数合法性检查，以确保方法行为可控，保证系统健壮性。同时为了避免出现过多的参数检查，在设计方法时应该在保证功能的前提下，尽量减少提供public方法。
错误示例： publicStringgetDate(Datedate){ //缺少入参检验 

SimpleDateFormatsf=newSimpleDateFormat(“yyyy-MM-ddHH:mm:ss”);
return.sf.format(Data.data);
}
正确示例 publicStringgetDate(Datedate){ 
             if(date==null)//增加入参校验{ 
                       logger.log(ERROR,PROC,”getData():dataisnull”);
                      return null; 
                    } 
          SimpleDateFormatsf=newSimpleDateFormat(“yyyy-MM-ddHH:mm:ss”);
          return.sf.format(Data.data);
 }

 军规条例2【调用方法获取返回结果后必须进行有效性校验,以确保后续代码在运行过程中不会抛出异常或产生逻辑错误。】
错误示例： publicvoidprintDate(){
  Datedate=newDate(); 
 SimpleDateFormatsf=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss");
StringdateStr=sf.format(date);//缺少对方返回结果的有效性检查
System.out.println(dateStr.equals(date.toString()));
}
正确示例: publicvoidprintDate(){
   Datedate=newDate(); 
  SimpleDateFormatsf=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss");
  StringdateStr=sf.format(date);
  if(dateStr==null)//增加判空{ 
    logger.log(ERROR,PROC,”printDate():getDatereturnnull”);
    dateStr=date.toString();
    } 
  System.out.printJn(dateStr.equals(date.toString()));
}

军规条例3【在进行数据库操作或IO操作时，必须确保资源在使用完毕后得到释放,并且必须确保释放操作在finally中进行。】 
说明：数据库操作、IO操作等需要使用结束close()的对象必须try-catch-finally的finally中close()，如果有多个IO对象需要close()，需要分对每个对象的close()方法进行try-catch，防止一个IO对象关闭失败其他IO对象都未关闭。
错误示例：

Timertimer=newTimer();
timer.schedule(newTimerTask(){ 
@Override 
  publicvoidrun(){ 
//业务代码，其中可能抛出异常
    } 
},delay,period);
正确示例： 
Timertimer=newTimer();
timer.schedule(newTimerTask(){ 
@0verride 
publicvoidrun(){ 
   try{ 
    //业务代码
     } catch(Exception e)//增加异常捕获处理
              {
                //process
             }
   } 
},delay,period)

军规条例5【对象比较必须使用叫equals而不是“==”】

说明：在Java中，有两种方式检查两个数据是否相等：通过使用==操作符，或者使用对象的equals方法。原子类型(int,char等)不是对象，因此他们只能使用==操作符，对象更复杂些，==操作符检查两个引用是否指向同一个对象，而equals方法则实现更专门的相等性检查。

错误示例：

longtime=System.currentTimeMillis();

Datetoday=newDate(time);

Datenow=newDate(time);

System.out.println(now==today);

//错误的对象比较结果： false

正确示例:

longtime=System.currentTimeMillis();

Datetoday=newDate(time);

Datenow=newDate(time);

System.out.println(now.equals(today));

//正确的对象比较结果： True