良好的Java风格：第二部分
良好的Java风格：第二部分
作者：Thornton Rose
日期：2001年2月28日
翻译：ant21

简介

这是这个两部分的关于Java编码风格系列的结论部分。在第一部分中，我介绍了我用良好的习惯来编写Java的一些情况，解释了为什么我们应该关心我们代码的样子，并且展示了良好Java风格的一些基本要素。在这个部分，我会展示良好Java风格的更多要素，并把我的情况作一个总结。

源文件

有很多种方式来组织Java源文件。这是工作得很好的一个：

文件头注释（可选）。
包声明。
空行或其它分隔符。
导入声明。
空行或其它分隔符。
类。


例1. 坏的文件组织。




例2. 好的文件组织。

导入声明

一个复杂的类可以有大量的导入，这些导入会变得不可控制，特别是如果你喜欢导入单个类而不是整个包（比如，java.awt.*）。为了能够处理这些导入，像下面这样来处理它们：

Java标准类（java.*）。
Java扩展类（javax.*）。
第三方类。
应用程序类。

一定要为第三方类和应用程序类作注释，特别是那些名字不容易让人辨认的类。使用行尾注释，或者在这一部分的开头放一个注释。同样，如果你真的想成为一个完美主义者，那么按照字母顺序为导入的每一组类进行排序。


例3. 坏的导入风格。




例4a. 好的导入风格。



例4b. 好的导入风格。

类

组织Java源文件的时候如果不把类组织好，那么你同样得不到良好的风格。现在教你如何组织源文件里的类。


Javadoc注释或者其它头注释。
类声明。
域(Field)声明。
空行或其它分隔符。
构建器。
空行或其它分隔符。
方法，除了main()，有逻辑的聚合起来。
空行或其它分隔符。
内部类。
空行或其它分隔符。
main()。


例5. 坏的类风格。




例6. 好的类风格。

域声明

一些类有大量的域，如果不组织好的话，维护起来是非常难的。像下面这样来组织它们：

public常量（final和static final）。
public变量。
protected常量
protected变量。
package常量。
package变量。
private常量。
private变量。


而且，写域声明的时候遵守下面的原则：

每行只写一个声明。
最起码，为public和protected域写Javadoc注释。
常量名用大写，因为大写使它们在声明和表达式中都更加显眼。
如果你使用能够产生域声明的工具，比如JBuilder或者Visual Cafe，要把自动产生的域和其它的域分开，这样维护UI代码的时候会容易一些。


例7. 坏的域风格。




例8. 好的域风格。

方法声明

编写方法声明的时候遵守下面的原则：


总是要有Javadoc注释或其它头注释。
总是要把访问修饰符放在前面。
如果行太长，把它分为一行或多行。
如果方法参数过多，考虑每行只放一个。
不要在方法名和开圆括号（"("）之间加入空格。
总是在闭圆括号（")"）和开大括号（"{"）之间加入空格（它可以是一个分行符）。


例9. 坏的方法风格。




例10. 好的方法风格。

结论

至于结论，在关于编码风格的主题上，我有一个最终的想法告诉你。无论你遵守怎样的原则，也无论你关于一些事情比如缩进风格（参看， Raymond, "Indent Style"）的信仰是如何强烈，你要记住的是当你编写代码的时候你总的目标应该是让代码在别人眼里看起来是可以理解和可以维护的。