JAVA代码编写的30条建议[转]

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

 (2) 为了常规用途而创建一个类时&＃xff0c;请采取"经典形式"&＃xff0c;并包含对下述元素的定义&＃xff1a; equals() hashCode() toString() clone()&＃xff08;implement Cloneable&＃xff09; implement Serializable
 (3) 对于自己创建的每一个类&＃xff0c;都考虑置入一个main()&＃xff0c;其中包含了用于测试那个类的代码。为使用一个项目中的类&＃xff0c;我们没必要删除测试代码。若进行了任何形式的改动&＃xff0c;可方便地返回测试。这些代码也可作为如何使用类的一个示例使用。
 (4) 应将方法设计成简要的、功能性单元&＃xff0c;用它描述和实现一个不连续的类接口部分。理想情况下&＃xff0c;方法应简明扼要。若长度很大&＃xff0c;可考虑通过某种方式将其分割成较短的几个方法。这样做也便于类内代码的重复使用&＃xff08;有些时候&＃xff0c;方法必须非常大&＃xff0c;但它们仍应只做同样的一件事情&＃xff09;。
 (5) 设计一个类时&＃xff0c;请设身处地为客户程序员考虑一下&＃xff08;类的使用方法应该是非常明确的&＃xff09;。然后&＃xff0c;再设身处地为管理代码的人考虑一下&＃xff08;预计有可能进行哪些形式的修改&＃xff0c;想想用什么方法可把它们变得更简单&＃xff09;。
(6) 使类尽可能短小精悍&＃xff0c;而且只解决一个特定的问题。下面是对类设计的一些建议&＃xff1a; ■一个复杂的开关语句&＃xff1a;考虑采用"多形"机制 ■数量众多的方法涉及到类型差别极大的操作&＃xff1a;考虑用几个类来分别实现 ■许多成员变量在特征上有很大的差别&＃xff1a;考虑使用几个类
 (7) 让一切东西都尽可能地"私有"--private。可使库的某一部分"公共化"&＃xff08;一个方法、类或者一个字段等等&＃xff09;&＃xff0c;就永远不能把它拿出。若强行拿出&＃xff0c;就可能破坏其他人现有的代码&＃xff0c;使他们不得不重新编写和设计。若只公布自己必须公布的&＃xff0c;就可放心大胆地改变其他任何东西。在多线程环境中&＃xff0c;隐私是特别重要的一个因素--只有private字段才能在非同步使用的情况下受到保护。
 (8) 谨惕"巨大对象综合症"。对一些习惯于顺序编程思维、且初涉OOP领域的新手&＃xff0c;往往喜欢先写一个顺序执行的程序&＃xff0c;再把它嵌入一个或两个巨大的对象里。根据编程原理&＃xff0c;对象表达的应该是应用程序的概念&＃xff0c;而非应用程序本身。
 (9) 若不得已进行一些不太雅观的编程&＃xff0c;至少应该把那些代码置于一个类的内部。
(10) 任何时候只要发现类与类之间结合得非常紧密&＃xff0c;就需要考虑是否采用内部类&＃xff0c;从而改善编码及维护工作&＃xff08;参见第14章14.1.2小节的"用内部类改进代码"&＃xff09;。
 (11) 尽可能细致地加上注释&＃xff0c;并用javadoc注释文档语法生成自己的程序文档。
 (12) 避免使用"魔术数字"&＃xff0c;这些数字很难与代码很好地配合。如以后需要修改它&＃xff0c;无疑会成为一场噩梦&＃xff0c;因为根本不知道"100"到底是指"数组大小"还是"其他全然不同的东西"。所以&＃xff0c;我们应创建一个常数&＃xff0c;并为其使用具有说服力的描述性名称&＃xff0c;并在整个程序中都采用常数标识符。这样可使程序更易理解以及更易维护。
 (13) 涉及构建器和异常的时候&＃xff0c;通常希望重新丢弃在构建器中捕获的任何异常--如果它造成了那个对象的创建失败。这样一来&＃xff0c;调用者就不会以为那个对象已正确地创建&＃xff0c;从而盲目地继续。
 (14) 当客户程序员用完对象以后&＃xff0c;若你的类要求进行任何清除工作&＃xff0c;可考虑将清除代码置于一个良好定义的方法里&＃xff0c;采用类似于cleanup()这样的名字&＃xff0c;明确表明自己的用途。除此以外&＃xff0c;可在类内放置一个boolean&＃xff08;布尔&＃xff09;标记&＃xff0c;指出对象是否已被清除。在类的finalize()方法里&＃xff0c;请确定对象已被清除&＃xff0c;并已丢弃了从RuntimeException继承的一个类&＃xff08;如果还没有的话&＃xff09;&＃xff0c;从而指出一个编程错误。在采取象这样的方案之前&＃xff0c;请确定finalize()能够在自己的系统中工作&＃xff08;可能需要调用System.runFinalizersonExit(true)&＃xff0c;从而确保这一行为&＃xff09;。 (15) 在一个特定的作用域内&＃xff0c;若一个对象必须清除&＃xff08;非由垃圾收集机制处理&＃xff09;&＃xff0c;请采用下述方法&＃xff1a;初始化对象&＃xff1b;若成功&＃xff0c;则立即进入一个含有finally从句的try块&＃xff0c;开始清除工作。
 (16) 若在初始化过程中需要覆盖&＃xff08;取消&＃xff09;finalize()&＃xff0c;请记住调用super.finalize()&＃xff08;若Object属于我们的直接超类&＃xff0c;则无此必要&＃xff09;。在对finalize()进行覆盖的过程中&＃xff0c;对super.finalize()的调用应属于最后一个行动&＃xff0c;而不应是第一个行动&＃xff0c;这样可确保在需要基础类组件的时候它们依然有效。
 (17) 创建大小固定的对象集合时&＃xff0c;请将它们传输至一个数组&＃xff08;若准备从一个方法里返回这个集合&＃xff0c;更应如此操作&＃xff09;。这样一来&＃xff0c;我们就可享受到数组在编译期进行类型检查的好处。此外&＃xff0c;为使用它们&＃xff0c;数组的接收者也许并不需要将对象"造型"到数组里。
 (18) 尽量使用interfaces&＃xff0c;不要使用abstract类。若已知某样东西准备成为一个基础类&＃xff0c;那么第一个选择应是将其变成一个interface&＃xff08;接口&＃xff09;。只有在不得不使用方法定义或者成员变量的时候&＃xff0c;才需要将其变成一个abstract&＃xff08;抽象&＃xff09;类。接口主要描述了客户希望做什么事情&＃xff0c;而一个类则致力于&＃xff08;或允许&＃xff09;具体的实施细节。
 (19) 在构建器内部&＃xff0c;只进行那些将对象设为正确状态所需的工作。尽可能地避免调用其他方法&＃xff0c;因为那些方法可能被其他人覆盖或取消&＃xff0c;从而在构建过程中产生不可预知的结果&＃xff08;参见第7章的详细说明&＃xff09;。
 (20) 对象不应只是简单地容纳一些数据&＃xff1b;它们的行为也应得到良好的定义。
 (21) 在现成类的基础上创建新类时&＃xff0c;请首先选?quot;新建"或"创作"。只有自己的设计要求必须继承时&＃xff0c;才应考虑这方面的问题。若在本来允许新建的场合使用了继承&＃xff0c;则整个设计会变得没有必要地复杂。
(22) 用继承及方法覆盖来表示行为间的差异&＃xff0c;而用字段表示状态间的区别。一个非常极端的例子是通过对不同类的继承来表示颜色&＃xff0c;这是绝对应该避免的&＃xff1a;应直接使用一个"颜色"字段。
 (23) 为避免编程时遇到麻烦&＃xff0c;请保证在自己类路径指到的任何地方&＃xff0c;每个名字都仅对应一个类。否则&＃xff0c;编译器可能先找到同名的另一个类&＃xff0c;并报告出错消息。若怀疑自己碰到了类路径问题&＃xff0c;胧允栽诶嗦肪兜拿恳桓銎鸬悖阉饕幌峦?class文件。
 (24) 在Java 1.1 AWT中使用事件"适配器"时&＃xff0c;特别容易碰到一个陷阱。若覆盖了某个适配器方法&＃xff0c;同时拼写方法没有特别讲究&＃xff0c;最后的结果就是新添加一个方法&＃xff0c;而不是覆盖现成方法。然而&＃xff0c;由于这样做是完全合法的&＃xff0c;所以不会从编译器或运行期系统获得任何出错提示--只不过代码的工作就变得不正常了。
(25) 用合理的设计方案消除"伪功能"。也就是说&＃xff0c;假若只需要创建类的一个对象&＃xff0c;就不要提前限制自己使用应用程序&＃xff0c;并加上一条"只生成其中一个"注释。请考虑将其封装成一个"独生子"的形式。若在主程序里有大量散乱的代码&＃xff0c;用于创建自己的对象&＃xff0c;请考虑采纳一种创造性的方案&＃xff0c;将些代码封装起来。
 (26) 警惕"分析瘫痪"。请记住&＃xff0c;无论如何都要提前了解整个项目的状况&＃xff0c;再去考察其中的细节。由于把握了全局&＃xff0c;可快速认识自己未知的一些因素&＃xff0c;防止在考察细节的时候陷入"死逻辑"中。
 (27) 警惕"过早优化"。首先让它运行起来&＃xff0c;再考虑变得更快--但只有在自己必须这样做、而且经证实在某部分代码中的确存在一个性能瓶颈的时候&＃xff0c;才应进行优化。除非用专门的工具分析瓶颈&＃xff0c;否则很有可能是在浪费自己的时间。性能提升的隐含代价是自己的代码变得难于理解&＃xff0c;而且难于维护。
 (28) 请记住&＃xff0c;阅读代码的时间比写代码的时间多得多。思路清晰的设计可获得易于理解的程序&＃xff0c;但注释、细致的解释以及一些示例往往具有不可估量的价值。无论对你自己&＃xff0c;还是对后来的人&＃xff0c;它们都是相当重要的。如对此仍有怀疑&＃xff0c;那么请试想自己试图从联机Java文档里找出有用信息时碰到的挫折&＃xff0c;这样或许能将你说服。
 (29) 如认为自己已进行了良好的分析、设计或者实施&＃xff0c;那么请稍微更换一下思维角度。试试邀请一些外来人士--并不一定是专家&＃xff0c;但可以是来自本公司其他部门的人。请他们用完全新鲜的眼光考察你的工作&＃xff0c;看看是否能找出你一度熟视无睹的问题。采取这种方式&＃xff0c;往往能在最适合修改的阶段找出一些关键性的问题&＃xff0c;避免产品发行后再解决问题而造成的金钱及精力方面的损失。
 (30) 良好的设计能带来最大的回报。简言之&＃xff0c;对于一个特定的问题&＃xff0c;通常会花较长的时间才能找到一种最恰当的解决方案。但一旦找到了正确的方法&＃xff0c;以后的工作就轻松多了&＃xff0c;再也不用经历数小时、数天或者数月的痛苦挣扎。我们的努力工作会带来最大的回报&＃xff08;甚至无可估量&＃xff09;。而且由于自己倾注了大量心血&＃xff0c;最终获得一个出色的设计方案&＃xff0c;成功的快感也是令人心动的。坚持抵制草草完工的诱惑--那样做往往得不偿失