Java程序员十戒-1

上一篇 / 下一篇 2012-04-20 09:51:07 / 个人分类：Java

Java程序员有许多应遵循的守则或最佳实践方式。本文概述了每个开发者最应该遵循的10条守则或戒律，如果不遵循它们，将会导致灾难性后果。

{:?B4z(I'K0　　1、为代码添加注释（Add comments to your code）。– 每个人都知道这一点，但不是每个人都会这么做。你有多少次“忘记”添加注释了？确实，注释不会为你的程序增加任何函数功能。但是，有多少次，看到2周前写的代码，你都记不起它是干什么的？你很幸运，那些未注释的代码是你自己写的，你脑海中还会有残存的印象。非常不幸，大多时候，代码是别人写的，并且那个人很可能已经离开公司了。有句谚语说的好：“有来有往，互惠互利”，因此程序员应该体谅彼此（还有你自己），给你的代码加上注释。

　　2、不要把简单事情复杂化（Do not complicate things）。– 我曾经这么做过，我相信你也一样。开发者都倾向于采用复杂方式解决简单问题。我们在一个只有5个用户的系统中引入EJB，为一个并不需要框架的应用实现一套框架，采用属性文件、采用面向对象解决方案、使用线程，而这些根本用不着。为什么会这么做？一些人可能不知道有更好的解决方案，但另一些人可能故意这样做来学习新知识，或仅仅是因为有趣。对那些不知道更好解决方案的人，要多听有经验程序员的建议。对于那些纯粹出于个人目的而将设计复杂化的人，我建议你要更加专业一点。

　　3、记住－ “越少越好”并非总是如此（Keep in Mind – "Less is more" is not always better）。– 高效率的代码是件好事，但很多情况下，并非代码行数越少效率就越高。看下面这个“简单”的例子：

`5q"ki4l z1f3i051Testing软件测试网6xy/I*zF|5{

if(newStatusCode.equals("SD") && (sellOffDate == null ||
todayDate.compareTo(sellOffDate)<0 ||
(lastUsedDate != null && todayDate.compareTo(lastUsedDate)>0))
||(newStatusCode.equals("OBS") && (OBSDate == null ||
todayDate.compareTo(OBSDate)<0))){
newStatusCode = "NYP";
}

　　指出这个if条件是什么有多困难？再设想一下，写这段代码的人并没遵循第1条－为代码添加注释。

　　把if条件分解成2个if语句不是更容易理解吗？现在让我们看一下修改过的代码：

6vq$`/m-J$h |051Testing软件测试网&t4Ro pc0N

1 if(newStatusCode.equals("SD") && (sellOffDate == null ||
2 todayDate.compareTo(sellOffDate)<0 || (lastUsedDate != null &&
3 todayDate.compareTo(lastUsedDate)>0))){
4 newStatusCode = "NYP";
5 }else
6 if(newStatusCode.equals("OBS") && (OBSDate == null ||
7 todayDate.compareTo(OBSDate)<0))
8 {
9 newStatusCode = "NYP";
10 }

"X6s|&NA0

8di7c5M |z,h0　　这样可读性不是更好吗？的确，我们写了重复语句；的确，我们多写了一个if和2个大括号；但是代码确实更加易读、更加容易理解了！51Testing软件测试网-N)o oq%la

@&EGU,A n1D+f;r2eWf0　　4、不要“硬编码"（No hard coding please）。– 由于时间紧迫，开发者总是会忘记或故意忽略这一条。然而另一种可能是，遵循这条戒律，我们就不会陷入“时间紧迫”的困境。定义一个static final 变量，增加一行代码，又能花多长时间呢？譬如：51Testing软件测试网6T;e\bl,f'r

1 public class A {
2
3         public static final String S_CONSTANT_ABC = "ABC";
4
5         public boolean methodA(String sParam1){
6
7             if (A.S_CONSTANT_ABC.equalsIgnoreCase(sParam1)){
8                 return true;
9             }
10             return false;
11         }
12 }

Y)Y't}WY2Xb G0　　现在，每次需要比较字符串“ABC”与某个变量的时候，我们只要引用 A.S_CONSTANT_ABC 即可，而不必记住它本身是什么。对这个常量的修改也非常方便，改一个地方即可，而不必在全部代码中查找。

1C v8vWo3L*]k:m(j0　　5、不要发明你自己的框架（Do not invent your own frameworks）。– 不夸张地讲，已经有几千个框架存在了，大多数还是开源的。很多框架都是极完美的解决方案，并已被用到成千的系统中。我们只要关注最新的流行的框架，至少表面上要熟悉一下。一个最成功的、也是被广泛使用的例子是Struts框架，这个开源的web框架是建立web系统的极佳选择，不要试图构造你自己的Struts版本，会累死的。但你必须记住第2条（译注：原文是“第3条”，显然不对）戒律 —— 不要把简单事情复杂化。如果你要开发的系统只有3个界面，就不要用Struts. 对于这样一个系统，没有足够的需要被“控制”的东西（译注：Struts将界面做MVC划分，C即controller，所以作者说there isn't much "controlling" required）。

6、对Print行或字符串说不（Say no to Print lines and String Concatenations）。– 我知道为了调试方便，程序员喜欢到处用System.out.println ,然后对自己说过一会就删掉。但我们常常忘记删掉这些行或不愿删掉，我们用System.out.println 做测试，为什么测完后还要去改代码？这很可能导致误删一行我们需要的代码。不要低估System.out.println 的危害，看下面代码：

51Testing软件测试网 EJ'^Q~ y

1 public class BadCode {
2 public static void calculationWithPrint(){
3 double someValue = 0D;
4 for (int i = 0; i < 10000; i++) {
5 System.out.println(someValue = someValue + i);
6 }
7 }
8 public static void calculationWithOutPrint(){
9
10 double someValue = 0D;
11 for (int i = 0; i < 10000; i++) {
12 someValue = someValue + i;
13 }
14
15 }
16 public static void main(String [] n) {
17 BadCode.calculationWithPrint();
18 BadCode.calculationWithOutPrint();
19 }
20 }

0X{,HF*IT}EVEL0

　　下面表格可以看出，calculationWithOutPrint() 方法执行时间是0.001204 s. 作为对比，calculationWithPrint() 方法居然需要令人难以置信的10.52 s来执行！

　　（若你想知道怎么做一个这样的表，请阅读另一篇文章"Java Profiling with WSAD"）

　　为了避免CPU浪费，最好的办法是引入一个包装的方法，如下：

1 public class BadCode {
2
3         public static final int DEBUG_MODE = 1;
4         public static final int PRODUCTION_MODE = 2;
5
6     public static void calculationWithPrint(int logMode){
7         double someValue = 0D;
8         for (int i = 0; i < 10000; i++) {
9             someValue = someValue + i;
10             myPrintMethod(logMode, someValue);
11         }
12     }
13
14     public static void myPrintMethod(int logMode, double value) {
15         if (logMode > BadCode.DEBUG_MODE) {    return; }
16         System.out.println(value);
17     }
18     public static void main(String [] n) {
19         BadCode.calculationWithPrint(BadCode.PRODUCTION_MODE);
20         }
21 }

　　字符串（String）连接是另一种CPU浪费方式，看下面的例子：

1 public static void concatenateStrings(String startingString) {
2 for (int i = 0; i < 20; i++) {
3 startingString = startingString + startingString;
4 }
5 }
6
7 public static void concatenateStringsUsingStringBuffer(
8 String startingString) {
9 StringBuffer sb = new StringBuffer();
10 sb.append(startingString);
11 for (int i = 0; i < 20; i++) {
12 sb.append(sb.toString());
13 }
14 }

p-HrW"Ek c0

收藏举报

TAG:

查看全部评论

bob123654

不要让那些真正对你好的人，慢慢的从你的生活中消失，无论爱情还是友情，都需要用心经营。

Java程序员十戒-1

用户菜单

我的栏目

标题搜索

日历

我的存档

数据统计

RSS订阅