【Java】Java编程规范

水深无声 2022-05-15 06:54 206阅读 0赞

以下内容摘录自*Java编程思想*一书。

1.  类名首字母应该大写，字段、方法以及对象（句柄）的首字母应该小写。对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。例如：

ThisIsAClassName
    thisIsFieldOrMethodName

若在定义中出现了常数初始化字符，则大写static final基本类型标识符中的所有字母，这样便可标志出它们属于编译器的常数。Java包（package）属于一种特殊情况，它们全都是小写字母，即便中间呢的单词亦是如此。对于域名扩展名称，如com、org、net或者edu等，全部都应小写。  
2. 为了常规用途而创建一个类时，请采取经典形式，并包含对下述元素的定义：

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

1.  对于自己创建的每一个类，都考虑置入一个`main()`，其中包含了用于测试那个类的代码。为使用一个项目中的类，我们没必要删除测试代码，若进行了任何形式的改动，可方便地返回测试，这些代码也可作为如何使用类的一个示例说明。
2.  应将方法设计成简要的、功能性单元，用它描述和实现一个类不连续的类接口部分。理想情况下，方法应简明扼要，若长度很大，可考虑使用某种方式将其分割成较短的几个方法，这样做也便于类内代码的重复使用。有些时候，方法必须非常大，但他们仍应只做同样的一件事情。
3.  设计一个类时，请设身处地为客户程序员考虑一下，类的使用方法应该是非常明确的。然后，再设身处地为管理代码的人考虑一下，预计有可能进行哪些形式的修改，想想用什么方法可把他们变得更简单。
4.  使类尽可能短小精悍，而且只解决一个特定的问题，下面是对类设计的一些建议：

一个复杂的开关语句：考虑采用多态机制。
    数量众多的方法涉及到类型差别极大的操作：考虑用几个类来分别实现。
    许多成员变量在特征上有很大的差别：考虑使用几个类。

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