华为 Java 编程军规 ！

一、引言

这个标准是衡量代码自己的缺陷，也是衡量一个研发人员自己的价值。华为做为一家全球化的 IT 公司，十几万员工，不管是人事管理，仍是代码管理，都是一件不容易的事情，没有规范的约束，想一想都是件可怕的事情。下面挑选了一些网上流传的编程规范，一块儿来学习下，如下内容不涉及基础的语法规范（请见 Refer），更侧重于一些编程习惯，如何提升程序的健壮性、可维护性等。（PS：如下内容未经官方考证，如阅读者出现不适，请选择当即关闭本页 -_-||| ）

二、军规简介

• 军规一：【避免在程序中使用魔鬼数字，必须用有意义的常量来标识。】

• 军规二：【明确方法的功能，一个方法仅完成一个功能。】

• 军规三：【方法参数不能超过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个】 说明：参数太多影响代码阅读和使用，为减小参数，首先要考虑这些参数的合理性，保持方法功能单1、优化方法设计，若是参数确实没法减小，能够将多个参数封装成一个类（对象），同时考虑在新的类（对象）中增长相应的行为，以期更符合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对象都未关闭。

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

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

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

• 军规九：【禁止循环中建立新线程，尽可能使用线程池。】

• 军规十：【在进行精确计算时(例如:货币计算)避免使用float和double，浮点数计算都是不精确的，必须使用BigDecimal或将浮点数运算转换为整型运算。】 说明：浮点运算在一个范围很广的值域上提供了很好的近似，可是它不能产生精确的结果。二进制浮点对于精度计算是很是不适合的，由于它不可能将0.1——或者10的其它任何次负幂精确表示为一个长度有限的二进制小数。

四、有关开发效率和协做的几点建议与心得体会

今天看到某同窗写给团队成员的一封邮件，发现比较通用，分享出来吧:

一、小提交:

把大的任务拆分红多个独立小任务，每完成小任务确保无 Bug 后就能够提交合并到主分支甚至发布；频繁提交有利于本身把控项目进度、下降风险、同其余人协做和代码 Review ; 天天能够提交合并屡次。每一个小任务是 1-2 个小时能够完成的粒度，最大的一天完成。并行作多个任务的时候，优先作最短期可以实现的任务。

二、命名规范:

尽可能避免无心义的字符作变量 好比 a, b, t 。能够逐步改善，能够参考:http://google-styleguide.googlecode.com/svn/trunk/javaguide.html

三、避免过分设计: 可以用简单方式实现的功能，不引入复杂的类，对象，避免没必要要的 new 对象，避免引入没必要要的泛型、线程。开发初期冗余大于抽象和依赖。避免本身从新实现比较通用的组件和函数。调研多种实现方式的时候，选用作简单的实现方式。尽可能少写代码。

四、Web 工程尽可能避免在应用内部保存“状态”，这样能够适应频繁发布、重启无影响。

五、善于用打日志的方式调试，在程序关键点打日志。尽可能少用断点方式，日志方式能够批量调试一批功能，效率相对高。

六、避免一屏显示不下的超大函数。

七、添加必要、简洁的注释：

循环中的 continue, break 尽可能加上单行注释；尽可能避免非函数结尾的 return，必要的时候加注释。类自动生成 toString() 方法，方便调试和打日志。

八、不把本身局限到作某个功能，每一个人都是整个项目的 Owner ，尽可能交叉 Review ，交叉开发。

九、遇到问题及时和其余人沟通，避免浪费时间。

十、从最终产品的目标审视本身细小的设计，熟悉本身负责部分的上下游代码。时刻关注最终产品(Web 界面和日志)，发现 Bug 和能够改善的地方。