知识大全敏捷开发技巧-消除代码异味

Posted 2022-07-18 异味

篇首语：知识就是力量，时间就是生命。本文由小常识网(cha138.com)小编为大家整理，主要介绍了知识大全敏捷开发技巧-消除代码异味相关的知识，希望对你有一定的参考价值。

　　摘要:本文通过简单通俗的例子告诉我们如何判断代码的稳定性和代码中的异类并且如何重构此类代码异味这个词可能有点抽象我们先看一下下面的例子这是一个CAD系统现在它已经可以画三种形状了:线条长方形跟圆先认真的看一下下面的代码:class Shape final static int TYPELINE = ; final static int TYPERECTANGLE = ; final static int TYPECIRCLE = ; int shapeType; //线条的开始点 //长方形左下角的点 //圆心 Point p ; //线条的结束点 //长方形的右上角的点 //如果是圆的话这个属性不用 Point p ; int radius; class CADApp void drawShapes(Graphics graphics Shape shapes[]) for (int i = ; i < shapes length; i++) switch (shapes[i] getType()) case Shape TYPELINE: graphics drawLine(shapes[i] getP () shapes[i] getP ()); break; case Shape TYPERECTANGLE: //画四条边 graphics drawLine( ); graphics drawLine( ); graphics drawLine( ); graphics drawLine( ); break; case Shape TYPECIRCLE: graphics drawCircle(shapes[i] getP () shapes[i] getRadius()); break; 代码都是一直在改变的而这也是上面的代码会碰到的一个问题现在我们有一个问题: 如果我们需要支持更多的形状(比如三角形) 那么肯定要改动Shape这个类 CADApp里面的drawShapes这个方法也要改好改为如下的样子: class Shape final static int TYPELINE = ; final static int TYPERECTANGLE = ; final static int TYPECIRCLE = ; final static int TYPETRIANGLE = ; int shapeType; Point p ; Point p ; //三角形的第三个点 Point p ; int radius; class CADApp void drawShapes(Graphics graphics Shape shapes[]) for (int i = ; i < shapes length; i++) switch (shapes[i] getType()) case Shape TYPELINE: graphics drawLine(shapes[i] getP () shapes[i] getP ()); break; case Shape TYPERECTANGLE: //画四条边 graphics drawLine( ); graphics drawLine( ); graphics drawLine( ); graphics drawLine( ); break; case Shape TYPECIRCLE: graphics drawCircle(shapes[i] getP () shapes[i] getRadius()); break; case Shape TYPETRIANGLE: graphics drawLine(shapes[i] getP () shapes[i] getP ()); graphics drawLine(shapes[i] getP () shapes[i] getP ()); graphics drawLine(shapes[i] getP () shapes[i] getP ()); break; 如果以后要支持更多的形状这些类又要改动…… 这可不是什么好事情！理想情况下我们希望当一个类一个方法或其他的代码设计完以后就不用再做修改了它们应该稳定到不用修改就可以重用现在的情况恰好相反！每当我们增加新的形状都得修改Shape这个类跟CADApp里面的drawShapes方法怎么让代码稳定（也就是无需修改）？这个问题是个好问题！不过老规矩先不说我们以行动回答我们先看看另外一个方法当给你一段代码你怎么知道它是稳定的？

　　怎么判断代码的稳定性？ 要判断代码的稳定性我们可能会这样来判定先假设一些具体的情况或者需求变动了然后来看一看要满足这些新的需求代码是否需要被修改？可惜这也是一件很麻烦的事因为有那么多的可能性！我们怎么知道哪个可能性要考虑哪些不用考虑？有个更简单的方法如果发现说我们已经第三次修改这些代码了那我们就认定这些代码是不稳定的这个方法很懒惰而且被动！我们被伤到了才开始处理状况不过至少这种方法还是一个很有效的方法此外还有一个简单而且主动的方法如果这段代码是不稳定或者有一些潜在问题的那么代码往往会包含一些明显的痕迹正如食物要腐坏之前经常会发出一些异味一样（当然食物如果有异味了再怎么处理我们都不想吃了但是代码可不行）我们管这些痕迹叫做代码异味正如并不是所有的食物有异味都不能吃了但大多数情况下确实是不能吃了并不是所有的代码异味都是坏事但大多数情况下它们确实是坏事情！因此当我们感觉出有代码异味时我们必须小心谨慎的检查了现在我们来看看上面例子中的代码异味吧示例代码中的代码异味第一种异味代码用了类别代码（type code） class Shape final int TYPELINE = ; final int TYPERECTANGLE = ; final int TYPECIRCLE = ; int shapeType; 这样的异味是一种严肃的警告我们的代码可能有许多问题第二种异味 Shape这个类有很多属性有时候是不用的例如 radius这个属性只有在这个Shape是个圆的时候才用到 class Shape Point p ; Point p ; int radius; //有时候不用第三种异味我们想给p p 取个好一点的变量名都做不到因为不同的情况下它们有不同的含义 class Shape Point p ; //要取作起始点左下点还是圆心？ Point p ; 第四种异味 drawShapes这个方法里面有个switch表达式当我们用到switch（或者一大串的if then else if）时小心了 switch表达式经常是跟类别代码（type code）同时出现的现在让我们将这个示例中的代码异味消除吧消除代码异味怎么去掉类别代码（type code）大多数情况下要想去掉一个类别代码我们会为每一种类别建立一个子类比如（当然并不是每次要去掉一个类别代码都要增加一个新类我们下面的另一个例子里面会讲另一种解决方法） class Shape class Line extends Shape Point startPoint; Point endPoint; class Rectangle extends Shape Point lowerLeftCorner; Point upperRightCorner; class Circle extends Shape Point center; int radius; 因为现在没有类别代码了 drawShapes这个方法里面就要用instanceof来判断对象是哪一种形状了因此我们不能用switch了而要改用if then else class CADApp void drawShapes(Graphics graphics Shape shapes[]) for (int i = ; i < shapes length; i++) if (shapes[i] instanceof Line) Line line = (Line)shapes[i]; graphics drawLine(line getStartPoint() line getEndPoint()); else if (shapes[i] instanceof Rectangle) Rectangle rect = (Rectangle)shapes[i]; graphics drawLine( ); graphics drawLine( ); graphics drawLine( ); graphics drawLine( ); else if (shapes[i] instanceof Circle) Circle circle = (Circle)shapes[i]; graphics drawCircle(circle getCenter() circle getRadius()); 因为没有类别代码了现在每个类（Shape Line Rectangle Circle）里面的所有属性就不会有时用得到有时用不到了现在我们也可以给它们取一些好听点的名字了（比如在Line里面 p 这个属性可以改名为startPoint了）现在四种异味只剩一种了那就是在drawShapes里面还是有一大串if then else if 我们下一步就是要去掉这长长的一串消除代码异味如何去掉一大串if then else if（或者switch）经常地为了去掉if then else if或者switch 我们需要先保证在每个条件分支下的要写的代码是一样的在drawShapes这个方法里面我们先以一个较抽象的方法（伪码）来写吧 class CADApp void drawShapes(Graphics graphics Shape shapes[]) for (int i = ; i < shapes length; i++) if (shapes[i] instanceof Line) 画线条; else if (shapes[i] instanceof Rectangle) 画长方形; else if (shapes[i] instanceof Circle) 画圆; 条件下的代码还是不怎么一样不如再抽象一点 class CADApp void drawShapes(Graphics graphics Shape shapes[]) for (int i = ; i < shapes length; i++) if (shapes[i] instanceof Line) 画出形状; else if (shapes[i] instanceof Rectangle) 画出形状; else if (shapes[i] instanceof Circle) 画出形状; 好现在三个分支下的代码都一样了我们也就不需要条件分支了 class CADApp void drawShapes(Graphics graphics Shape shapes[]) for (int i = ; i < shapes length; i++) 画出形状; 最后将画出形状这个伪码写成代码吧: class CADApp void drawShapes(Graphics graphics Shape shapes[]) for (int i = ; i < shapes length; i++) shapes[i] draw(graphics);

　　当然我们需要在每种Shape的类里面提供draw这个方法 abstract class Shape abstract void draw(Graphics graphics); class Line extends Shape Point startPoint; Point endPoint; void draw(Graphics graphics) graphics drawLine(getStartPoint() getEndPoint()); class Rectangle extends Shape Point lowerLeftCorner; Point upperRightCorner; void draw(Graphics graphics) graphics drawLine( ); graphics drawLine( ); graphics drawLine( ); graphics drawLine( ); class Circle extends Shape Point center; int radius; void draw(Graphics graphics) graphics drawCircle(getCenter() getRadius()); 将抽象类变成接口现在看一下Shape这个类它本身没有实际的方法所以它更应该是一个接口 interface Shape void draw(Graphics graphics); class Line implements Shape class Rectangle implements Shape class Circle implements Shape 改进后的代码改进后的代码就像下面这样 interface Shape void draw(Graphics graphics); class Line implements Shape Point startPoint; &nbs

知识大全 敏捷开发技巧-消除代码异味

知识大全敏捷开发技巧-消除代码异味