JAVA代码编写的注意事项

 

1) 类名首字母应该大写。字段、方法以及对象(句柄)的首字母应小写。对于全部标识符,其中包含的全部单词都应紧靠在一块儿,并且大写中间单词的首字母。例如:
ThisIsAClassName
thisIsMethodOrFieldName
若在定义中出现了常数初始化字符,则大写static final基本类型标识符中的全部字母。这样即可标志出它们属于编译期的常数。
Java包(Package)属于一种特殊状况:它们全都是小写字母,即使中间的单词亦是如此。对于域名扩展名称,如com,org,net或者edu等,所有都应小写(这也是Java 1.1和Java 1.2的区别之一)。

(2) 为了常规用途而建立一个类时,请采起"经典形式",并包含对下述元素的定义:

equals()
hashCode()
toString()
clone()(implement Cloneable)
implement Serializable

(3) 对于本身建立的每个类,都考虑置入一个main(),其中包含了用于测试那个类的代码。为使用一个项目中的类,咱们不必删除测试代码。若进行了任何形式的改动,可方便地返回测试。这些代码也可做为如何使用类的一个示例使用。

(4) 应将方法设计成简要的、功能性单元,用它描述和实现一个不连续的类接口部分。理想状况下,方法应简明扼要。若长度很大,可考虑经过某种方式将其分割成较短的几个方法。这样作也便于类内代码的重复使用(有些时候,方法必须很是大,但它们仍应只作一样的一件事情)。

(5) 设计一个类时,请设身处地为客户程序员考虑一下(类的使用方法应该是很是明确的)。而后,再设身处地为管理代码的人考虑一下(预计有可能进行哪些形式的修改,想一想用什么方法可把它们变得更简单)。
(6) 使类尽量短小精悍,并且只解决一个特定的问题。下面是对类设计的一些建议:
■一个复杂的开关语句:考虑采用"多形"机制
■数量众多的方法涉及到类型差异极大的操做:考虑用几个类来分别实现
■许多成员变量在特征上有很大的差异:考虑使用几个类

(7) 让一切东西都尽量地"私有"--private。可以使库的某一部分"公共化"(一个方法、类或者一个字段等等),就永远不能把它拿出。若强行拿出,就可能破坏其余人现有的代码,使他们不得不从新编写和设计。若只公布本身必须公布的,就可放心大胆地改变其余任何东西。在多线程环境中,隐私是特别重要的一个因素--只有private字段才能在非同步使用的状况下受到保护。

(8) 谨惕"巨大对象综合症"。对一些习惯于顺序编程思惟、且初涉OOP领域的新手,每每喜欢先写一个顺序执行的程序,再把它嵌入一个或两个巨大的对象里。根据编程原理,对象表达的应该是应用程序的概念,而非应用程序自己。

(9) 若不得已进行一些不太雅观的编程,至少应该把那些代码置于一个类的内部。

(10) 任什么时候候只要发现类与类之间结合得很是紧密,就须要考虑是否采用内部类,从而改善编码及维护工做(参见第14章14.1.2小节的"用内部类改进代码")。

(11) 尽量细致地加上注释,并用javadoc注释文档语法生成本身的程序文档。

(12) 避免使用"魔术数字",这些数字很难与代码很好地配合。如之后须要修改它,无疑会成为一场噩梦,由于根本不知道"100"究竟是指"数组大小"仍是"其余全然不一样的东西"。因此,咱们应建立一个常数,并为其使用具备说服力的描述性名称,并在整个程序中都采用常数标识符。这样可以使程序更易理解以及更易维护。

(13) 涉及构建器和异常的时候,一般但愿从新丢弃在构建器中捕获的任何异常--若是它形成了那个对象的建立失败。这样一来,调用者就不会觉得那个对象已正确地建立,从而盲目地继续。

(14) 当客户程序员用完对象之后,若你的类要求进行任何清除工做,可考虑将清除代码置于一个良好定义的方法里,采用相似于cleanup()这样的名字,明确代表本身的用途。除此之外,可在类内放置一个boolean(布尔)标记,指出对象是否已被清除。在类的finalize()方法里,请肯定对象已被清除,并已丢弃了从RuntimeException继承的一个类(若是尚未的话),从而指出一个编程错误。在采起象这样的方案以前,请肯定finalize()可以在本身的系统中工做(可能须要调用System.runFinalizersOnExit(true),从而确保这一行为)。

(15) 在一个特定的做用域内,若一个对象必须清除(非由垃圾收集机制处理),请采用下述方法:初始化对象;若成功,则当即进入一个含有finally从句的try块,开始清除工做

16) 若在初始化过程当中须要覆盖(取消)finalize(),请记住调用super.finalize()(若Object属于咱们的直接超类,则无此必要)。在对finalize()进行覆盖的过程当中,对super.finalize()的调用应属于最后一个行动,而不该是第一个行动,这样可确保在须要基础类组件的时候它们依然有效。

(17) 建立大小固定的对象集合时,请将它们传输至一个数组(若准备从一个方法里返回这个集合,更应如此操做)。这样一来,咱们就可享受到数组在编译期进行类型检查的好处。此外,为使用它们,数组的接收者也许并不须要将对象"造型"到数组里。

(18) 尽可能使用interfaces,不要使用abstract类。若已知某样东西准备成为一个基础类,那么第一个选择应是将其变成一个interface(接口)。只有在不得不使用方法定义或者成员变量的时候,才须要将其变成一个abstract(抽象)类。接口主要描述了客户但愿作什么事情,而一个类则致力于(或容许)具体的实施细节。

(19) 在构建器内部,只进行那些将对象设为正确状态所需的工做。尽量地避免调用其余方法,由于那些方法可能被其余人覆盖或取消,从而在构建过程当中产生不可预知的结果(参见第7章的详细说明)。

(20) 对象不该只是简单地容纳一些数据;它们的行为也应获得良好的定义。

(21) 在现成类的基础上建立新类时,请首先选择"新建"或"创做"。只有本身的设计要求必须继承时,才应考虑这方面的问题。若在原本容许新建的场合使用了继承,则整个设计会变得没有必要地复杂。

(22) 用继承及方法覆盖来表示行为间的差别,而用字段表示状态间的区别。一个很是极端的例子是经过对不一样类的继承来表示颜色,这是绝对应该避免的:应直接使用一个"颜色"字段。

(23) 为避免编程时遇到麻烦,请保证在本身类路径指到的任何地方,每一个名字都仅对应一个类。不然,编译器可能先找到同名的另外一个类,并报告出错消息。若怀疑本身碰到了类路径问题,请试试在类路径的每个起点,搜索一下同名的.class文件。

(24) 在Java 1.1 AWT中使用事件"适配器"时,特别容易碰到一个陷阱。若覆盖了某个适配器方法,同时拼写方法没有特别讲究,最后的结果就是新添加一个方法,而不是覆盖现成方法。然而,因为这样作是彻底合法的,因此不会从编译器或运行期系统得到任何出错提示--只不过代码的工做就变得不正常了。

(25) 用合理的设计方案消除"伪功能"。也就是说,倘若只须要建立类的一个对象,就不要提早限制本身使用应用程序,并加上一条"只生成其中一个"注释。请考虑将其封装成一个"独生子"的形式。若在主程序里有大量散乱的代码,用于建立本身的对象,请考虑采纳一种创造性的方案,将些代码封装起来。

(26) 警戒"分析瘫痪"。请记住,不管如何都要提早了解整个项目的情况,再去考察其中的细节。因为把握了全局,可快速认识本身未知的一些因素,防止在考察细节的时候陷入"死逻辑"中。

(27) 警戒"过早优化"。首先让它运行起来,再考虑变得更快--但只有在本身必须这样作、并且经证明在某部分代码中的确存在一个性能瓶颈的时候,才应进行优化。除非用专门的工具分析瓶颈,不然颇有多是在浪费本身的时间。性能提高的隐含代价是本身的代码变得难于理解,并且难于维护。

(28) 请记住,阅读代码的时间比写代码的时间多得多。思路清晰的设计可得到易于理解的程序,但注释、细致的解释以及一些示例每每具备不可估量的价值。不管对你本身,仍是对后来的人,它们都是至关重要的。如对此仍有怀疑,那么请试想本身试图从联机Java文档里找出有用信息时碰到的挫折,这样或许能将你说服。

(29) 如认为本身已进行了良好的分析、设计或者实施,那么请稍微更换一下思惟角度。试试邀请一些外来人士--并不必定是专家,但能够是来自本公司其余部门的人。请他们用彻底新鲜的眼光考察你的工做,看看是否能找出你一度熟视无睹的问题。采起这种方式,每每能在最适合修改的阶段找出一些关键性的问题,避免产品发行后再解决问题而形成的金钱及精力方面的损失。

(30) 良好的设计能带来最大的回报。简言之,对于一个特定的问题,一般会花较长的时间才能找到一种最恰当的解决方案。但一旦找到了正确的方法,之后的工做就轻松多了,不再用经历数小时、数天或者数月的痛苦挣扎。咱们的努力工做会带来最大的回报(甚至无可估量)。并且因为本身倾注了大量心血,最终得到一个出色的设计方案,成功的快感也是使人心动的。坚持抵制草草完工的诱惑--那样作每每得不偿失
java