四个有害的java习惯

本文不算严格意义上的翻译，算是该文章的摘要以及读后感。

 

文章原始地址:http://www.javaworld.com/javaworld/jw-07-2008/jw-07-harmful-idioms.html

 

John O'Hanley 的这篇文章列举了四个有害的java编码习惯，并提出了改正方案。

这四个习惯普遍存在于java程序员中，并且已经被广泛接受，大家都习以为常，流毒甚远。

 

1.对局部变量(local variables)，字段(fields)，参数(method arguments)这三种变量的命名没有区分，造成了代码的阅读困难，增加了代码的维护成本。

 

作者举了个例子:

public boolean equals (Object arg) {
  if (! (arg instanceof Range)) return false;
  Range other = (Range) arg;
  return start.equals(other.start) && end.equals(other.end);
}

 

在这个方法中，arg直接用argument的缩写，虽然大家一看就知道这是参数了，但这种命名方式却丢失了参数代表的对象本身的含义。大家知道这是参数，却不知道这是什么参数。如果方法的参数多一点，都按照arg1，arg2这样的方式命名，阅读代码的时候很头疼。另外两个字段变量，start和end，突然凭空而出，想一下才知道这应该是字段。当然，这个方法很短，造成的困难还不大，如果这个方法比较长的话，突然看到start和end两个变量，一般会先在前面找一下是不是局部变量，然后才能确定是类的字段变量。

 

这个问题貌似微不足道，但为什么要让代码阅读者花费额外时间在这些琐碎的问题上呢？如果有个方案能让代码阅读者一目了然的明白变量是那种变量，为什么不采用呢？就如同Steve McConnell在 《代码大全》中说的:"让人费神去琢磨神秘杀人凶手这没有问题，但你不需要琢磨程序代码，代码是用来阅读的。"

作者提出了解决方案:

• 方法参数用前缀a开始
• 类字段变量用前缀f开始
• 局部变量不用前缀

修正后的代码样式应该是:

public boolean equals (Object aOther) {
  if (! (aOther instanceof Range)) return false;
  Range other = (Range) aOther;
  return fStart.equals(other.fStart) && fEnd.equals(other.fEnd);
}

 

这样的代码看起来一目了然，如果你没有一目了然，说明还是习惯问题，习惯养成了就好了。

 

不过作者的方案里，给类字段变量前面加 f 前缀，如果用代码生成工具生成get，set方法是会比较麻烦。get，set方法中我们不希望出现个f。不过这个问题可以用修改代码生成工具的方式解决。如果这个习惯普遍被java界接受，这些应该都不成问题了。

 

作者引用了一句名言:

 

"By relieving the brain of all unnecessary work, a good notation sets it free to concentrate on more advanced problems, and in effect increases the mental power of the race. Before the introduction of the Arabic notation, multiplication was difficult, and the division even of integers called into play the highest mathematical faculties. Probably nothing in the modern world would have more astonished a Greek mathematician than to learn that ... a large proportion of the population of Western Europe could perform the operation of division for the largest numbers. This fact would have seemed to him a sheer impossibility ... Our modern power of easy reckoning with decimal fractions is the almost miraculous result of the gradual discovery of a perfect notation."
-- Alfred North Whitehead, An Introduction To Mathematics

 

个人理解大意为:

把大脑从不必需的工作中解放出来，一个好的记号法可以让大脑去关注更高级的问题，提升民族的整体智力。在阿拉伯数字记号法被介绍进来以前，乘法是非常困难的，计算整除也需要非常高的数学才能。一个古希腊的数学家可能非常诧异于西欧的大多数人口可以计算很大数字的除法。这个事实对他来说似乎是不可能的。我们现代人很容易用小数算帐的能力几乎可以说是由逐渐探索出的一套完美的计数法而造成的奇迹。

 

2.包(package)的命名和划分按照行为和层次划分(package-by-layer)而不是根据特征和功能划分(package-by-feature)

 

这个问题在我刚学java的时候就遇到了，在看了众多的网上开源程序后，我也慢慢习惯了按层次命名包。

作者举了个例子:

 

• com.blah.action
• com.blah.dao
• com.blah.model
• com.blah.util

我们已经习惯了按照层次分类或者叫按照行为分类，model一个包，dao一个包，service一个包，action一个包。这样就把具有同样特征或者功能的类划分到了不同的包里。这样的习惯，把java的包内私有(package-private)这个作用域给完全扔掉了，而包内私有是java的默认作用域。（ps:我学java来好像很少用过java的包内私有这个作用域，汗一个）

这中包的划分习惯也违反了面向对象编程的核心原则之--尽量保持私有以减少影响,因为这种习惯强迫你必须扩大类的作用域.

 

下面的包命名方式是按照特征划分命名:

• com.blah.painting
• com.blah.buyer
• com.blah.seller
• com.blah.auction
• com.blah.webmaster
• com.blah.useraccess
• com.blah.util

举个例子，在一个web应用中，com.blah.painting包可能包含下面的成员:

• Painting.java: model对象
• PaintingDAO.java: dao对对象
  
• PaintingAction.java:controller or action 对象
• statements.sql: SQL文件
• view.jsp: JSP文件
  

 

值得注意的是这种情况下，包里包含的不仅仅是java源码文件，同时也包含其他与该特征相关的文件。这点上好像违反大多数java程序员的习惯，并且如果要打包为jar好像也不方便，真实环境中如何应用，有没有别的麻烦，还要待实践一下。

 

作者列举了这种包划分方式的优点:

• 包是高内聚的，并且模块化，包与包之间的耦合性被降到最低。

• 代码的自文档性(或自描述性 self-documenting)增强. 读者只需看包的名字就对程序有些什么功能或特征有了大概的印象。在《代码大全》中, Steve McConnell 将自文档化(self-documenting)的代码比作 "the Holy Grail of legibility."(不知道怎么翻译)

• 把类按照每个特征和功能区分开可以很容易实现分层设计。

• 相关的成员在同一个位置。不需要为了编辑一个相关的成员而去浏览整个源码树。

• 成员的作用域默认是包内私有。只有当另外的包需要访问某个成员的时候，才把它修改为public. (需要注意的是修改一个类为public，并不意味着它的所有类成员都应该改为public。public成员和包内私有(package-private)成员是可以在同一个类里共存的。)

• 删除一个功能或特征只需要简单的删除一个文件夹。
• 每个包内一般只有很少的成员，这样包可以很自然的按照进化式发展。如果包慢慢变的太大，就可以再进行细分，把它重构为两个或者更多新的包，类似于物种进化。而按照层次划分的方式，就没办法进化式发展，重构也不容易。

作者引用了一句Effective Java中的名言:

"The single most important factor that distinguishes a well-designed module from a poorly designed one is the degree to which the module hides its internal data and other implementation details from other modules."
-- Joshua Bloch, Effective Java

 

 

3.习惯用JavaBeans而不是不可变对象

 

按照javabeans的说明书(JavaBeans specification )，javabeans是用来解决特殊领域的问题:在图形界面程序的设计中充当小部件。但现在通常用javabean来做数据库记录的映射。作者反对javabean的这种用法。他提出了一个问题:

假如你要从数据库记录集映射一行为对象，不考虑现有的持久化方案和框架，你会将这个对象设计成什么样子？跟javabean相似呢还是完全不一样？

 

作者倾向于设计一个完全不一样的，他列举他的设计的几个特点:

 

• 它不包含一个无参数构造方法（这一特征是javabean必备的。）。作者认为一个数据库记录的对象如果不包含任何数据是没有意义的。一个数据库表的所有字段都是可选的情况有多少？

• It would likely not have anything to say about events and listeners.(不太明白作者的意思)

• 它不强迫你用可变的对象。

• 它内部有一个数据验证机制。这样一个验证机制对大多数数据库应用非常重要。(记住对象的第一原则：一个对象应该同时封装数据和对数据的操作。在这种情况下，操作就是验证数据。)

• 数据验证机制可以给最终用户(end user)报错。

 

作者的这一点我没看太明白。希望达人指点。作者不满于现有的数据库持久化框架滥用javabean，提出了几个观点，但没有具体的代码演示。据我的理解，作者的意思和前一段时间javaeye上争论的充血模型和贫血模型有点类似。

 

4.类成员的排序没有按照成员的作用域(scope) 的大小从大到小排列，而是喜欢把private放在前面。

 

作者举了一个常见的类样式：

public class OilWell implements EnergySource {
   private Long id;
   private String name;
   private String location;
   private Date discoveryDate;
   private Long totalReserves;
   private Long productionToDate;
   
   public Long getId() {
      return id;
   }
   public void setId(Long id) {
      this.id = id;
   }
   
  //..elided
}

 这种方式将private变量放在最前面。作者认为应该倒过来，把private变量的申明放在最后面。

 

因为人们认识一个事物的通常过程都是从一般到特殊，从抽象层次来说，是从高到底的认识过程。如果你倒过来的话，就不能从整体上把握事物，也不能抓住事物的本质，只能在一堆具体的片段事实中迷失。

 

整体的抽象允许你忽略细节。抽象的层次越高，你可以忽略越多的细节。读者阅读一个类时可以忽略的细节越多他会越高兴。脑袋里填充太多的细节是痛苦的，所以细节越少越好。因此，将private成员方在最后会显得更富有同情心，因为这样阻止了不必要的细节显露给读者。

 

原来C++程序的习惯也是把private成员放在最开始。然而，C++社区迅速的认识到这是一个有害的规范，这个规范现在已经被修正。(参看 a typical C++ style guide )

注意:public 接口应该放在class的最开始，其次是protected成员，最后是private成员。原因是:

• 程序员应该更关心接口而不是具体实现。
• 当程序员需要用一个类的时候，他们需要的是接口而不是实现。

把接口放在开始是非常有意义的。把实现部分，private 片段，放在开始是一个历史遗留问题。最后还是要反复强调一下，一个类的接口的重要性超过实现细节。

 

将私有成员放在类的开始是一个等待打破的怀习惯，它似乎是sun早期的编码规范造成的。

 

将代码按照javadoc的顺序编排是非常好的：首先是构造方法，然后是非私有方法，最后是私有字段和方法。这样读者阅读的时候很自然的从抽象层次的高向低运动。

 

作者的这个观点确实很有道理，以前也没仔细思考过。可以考虑给IDE做个重构插件，专门按照这种排序格式化代码。

 

 

作者介绍:

John O'Hanley 是 javapractices.com 的专栏作者， 同时也是 WEB4J framework  的创建者。他拥有10年编程经验，现在居住于Prince Edward Island, Canada.

 

参考资料:

• 在线阅读 Steve McConnell's 《代码大全》 .
• 学习关于Hungarian notation .（匈牙利命名法）
• The Java Language Specification has more on Java's default scoping rules .
• 阅读JavaBeans specification
•  Possibility.com C++ style guide 和 Imperial College London C++ Style Guide 同时建议将private成员放在最后。

评论

8 楼 tom.liu 2008-08-21  

不同观点：

1：一般的编辑器都把类数据和方法数据用颜色区分开，一目了然。加个a，f啥的根本就不醒目，有时对某些名字可能造成误导

2.按功能分包：有利之处是包私有，但是大的项目，许多功能，都分包？对数据库A的存取可能在多个包中用到，代码重复不？OOD的好处之一是代码重复使用。

请指教。

7 楼 jolestar 2008-08-01  

to 42087743
但问题在于javabean只是很少一部分java类，并且对代码的可维护性上影响很小。javabean里你可以只看private属性的原因在于这些属性一般都有默认的get set方法，其实这些private属性和public属性基本是等效的。

6 楼 42087743 2008-07-31  

to jolestar :
    你已经说了,javabean里只需要看一下几个变量就可以了,那么把get和set方法放在前面,不就影响阅读了吗!

5 楼 jolestar 2008-07-31  

to coolnight

你说的这种情况只是javabean里的情况，而javabean一般没有啥可读的必要，一般是看一下有哪几个属性而已。

4 楼 coolnight 2008-07-31  

很不同意第四点

field声明只有一行， 把field声明放在最上面，更容易看清class的全貌，

而那一堆的get/set，一屏幕又能显示几个？

3 楼 wmcoo 2008-07-31  

"2.包(package)的命名和划分按照行为和层次划分(package-by-layer)而不是根据特征和功能划分(package-by-feature) "

我一直都是这样用的,
com.XXX.特征和功能.层次划分.javasrc
不过还是扔掉了这点
"java的包内私有(package-private)这个作用域给完全扔掉"
以后得改成
com.XXX.特征和功能.javasrc

java包的两种浏览方式
flat
hierarchical
我用的是flat,这种方式找javasrc绝对要比hierarchical效率

2 楼 jolestar 2008-07-31  

to 42087743
那为什么一定要把变量申明放在方法前面呢？有什么道理么？

1 楼 42087743 2008-07-31  

      第一点,我感觉这做法挺有意思的,也确实有效果,确实看得清晰了不少,但要大家都来使用它,让它成为规范才有用.并且,我觉得应该类字段变量不用前缀,这样符合我的命名习惯.第二点和第三点已经算是标准了.但是第四点我不敢苟同,平常的习惯是把变量写在方法的前面,并不是把private写在public的前面,但是恰巧变量是private,所以才会让人家误解,你是特意把private放在public的前面,所以他的那种说法没有依据.
      本人卓见,大家见笑了.