除去代码异味 敏捷开发(二)

 

 

    要判断代码的稳定性，我们可能会这样来判定：先假设一些具体的情况或者需求变动了，然后来看一看，要
满足这些新的需求，代码是否需要被修改？

    可惜，这也是一件很麻烦的事，因为有那么多的可能性！我们怎么知道哪个可能性要考虑，哪些不用考虑？
有个更简单的方法，如果发现说，我们已经第三次修改这些代码了，那我们就认定这些代码是不稳定的。
这样的方法很“懒惰”，而且“被动”！因为这是在我们被伤到了以后，才开始处理问题。虽然这种方法还算
是一个很有效的方法。

    此外，还有一个简单，而且“主动”的方法：如果这段代码是不稳定或者有一些潜在问题的，那么代码往往
会包含一些明显的痕迹。正如食物要腐坏之前，经常会发出一些异味一样（当然，食物如果有异味了，再怎么处
理我们都不想吃了。但是代码可不行。）。我们管这些痕迹叫做“代码异味”。并不是所有的食物有异味都不能吃
了，但大多数情况下，确实是不能吃了。并不是所有的代码异味都是坏事，但大多数情况下，它们确实是坏事情！

 

第一种异味：代码用了类别代码（type code）。
 class Shape {
  final int TYPELINE = 0;
  final int TYPERECTANGLE = 1;
  final int TYPECIRCLE = 2;
  int shapeType;
  ...
 }
 这样的异味，是一种严肃的警告：我们的代码可能有许多问题。

 

第二种异味：Shape 这个类有很多属性有时候是不用的。例如，radius 这个属性只有在这个Shape 是个圆的时候才用到：
 class Shape {
  ...
  Point p1;
  Point p2;
  int radius; //有时候不用
 }

 

第三种异味：我们想给p1,p2 取个好一点的变量名都做不到，因为不同的情况下，它们有不同的含义：
 class Shape {
  ...
  Point p1; //要取作“起始点”，“左下点”，还是“圆心”？
  Point p2;
 }

 

第四种异味：drawShapes这个方法里面，有个switch表达式。当我们用到switch（或者一大串的if-then-else-if）时，小心了。switch表达式经常是跟类别代码（type code）同时出现的。

 

 

//原代码

class Shape { final static int TYPELINE = 0; final static int TYPERECTANGLE = 1; final static int TYPECIRCLE = 2; final static int TYPETRIANGLE = 3; int shapeType; Point p1; Point p2; //三角形的第三个点. Point p3; int radius; } class CADApp { void drawShapes(Graphics graphics, Shape shapes[]) { for (int i = 0; i < shapes.length; i++) { switch (shapes[i].getType()) { case Shape.TYPELINE: graphics.drawLine(shapes[i].getP1(), shapes[i].getP2()); break; case Shape.TYPERECTANGLE: //画四条边. graphics.drawLine(...); graphics.drawLine(...); graphics.drawLine(...); graphics.drawLine(...); break; case Shape.TYPECIRCLE: graphics.drawCircle(shapes[i].getP1(), shapes[i].getRadius()); break; case Shape.TYPETRIANGLE: graphics.drawLine(shapes[i].getP1(), shapes[i].getP2()); graphics.drawLine(shapes[i].getP2(), shapes[i].getP3()); graphics.drawLine(shapes[i].getP3(), shapes[i].getP1()); break; } } } }

 

//Fixed:

interface Shape { void draw(Graphics graphics); } class Line implements Shape { Point startPoint; Point endPoint; void draw(Graphics graphics) { graphics.drawLine(getStartPoint(), getEndPoint()); } } class Rectangle implements Shape { Point lowerLeftCorner; Point upperRightCorner; void draw(Graphics graphics) { graphics.drawLine(...); graphics.drawLine(...); graphics.drawLine(...); graphics.drawLine(...); } } class Circle implements Shape { Point center; int radius; void draw(Graphics graphics) { graphics.drawCircle(getCenter(), getRadius()); } } class CADApp { void drawShapes(Graphics graphics, Shape shapes[]) { for (int i = 0; i < shapes.length; i++) { shapes[i].draw(graphics); } } }

 

 

 总结一下类别代码的移除

要移动一些类别代码和switch表达式，有两种方法：
 1.用基于同一父类的不同子类来代替不同的类别。
 2.用一个类的不同对象来代替不同的类别。
 当不同的类别具有比较多不同的行为时，用第一种方法。当这些类别的行为非常相似，或者只是差别在一些值上面的时候，用第二个方法。

 

普遍的代码异味

类别代码和switch表达式是比较普遍的代码异味。此外，还有其他的代码异味也很普遍。

下面是大概的异味列表：

代码重复
> 太多的注释
> 类别代码（type code）
> switch或者一大串if-then-else-if
> 想给一个变量，方法或者类名取个好名字时，也怎么也取不好
> 用类似XXXUtil, XXXManager, XXXController 和其他的一些命名
> 在变量，方法或类名中使用这些单词“And”，“Or”等等
> 一些实例中的变量有时有用，有时没用
> 一个方法的代码太多，或者说方法太长
> 一个类的代码太多，或者说类太长
> 一个方法有太多参数
> 两个类都引用了彼此（依赖于彼此）