要资料 文章 文库 视频 Code iProcess 课程 认证 咨询 工具 讲座吧   专家招募  
会员   
 
  
每天15篇文章
不仅获得谋生技能
更可以追随信仰
 
 
     
   
分享到
如何编写出拥抱变化的代码
 

发布于2013-3-18

 

摘要:编写高效优质的代码一直是程序员所追求的目标之一,那么什么样的代码才叫优质呢?其中最重要的莫过于易维护、易修改。本文作者从面向对象和SOLID两大方面,非常详细地总结了如何编写出易修改的代码,绝对让你受益匪浅。

在实际的开发中,编写出易维护和易接受变化的代码并非易事,想要实现可能更加困难重重:源码难于理解、依赖关系指向不明、耦合也很令人头疼。难道就真的就没有办法了吗?本文中我们一起探讨几个技术原则和一些编码理念,让你的代码跟着需求走,而且易维护易拓展。

介绍些面向对象方法

面向对象编程(OOP)是一种很受欢迎的编程思想,它保证了代码的组织性和重用性。软件公司采用OOP思想编程已经好多年了,如今仍然在项目开发中使用这一思想。OOP拥有一系列非常好的编程原则,如果使用恰当,它会让你的代码更好、更整洁和更易维护。

1.内聚力

这里的内聚力是指拥有一些共同的特征的东西而逐渐凝聚到一起,而不能在一起的东西则会被移除出去。可以用一个类来说明内聚力:

class ANOTCohesiveClass {

   private $firstNumber;

   private $secondNumber;

   private $length;

   private $width;

   function __construct($firstNumber, $secondNumber) {

      $this->firstNumber = $firstNumber;

      $this->secondNumber = $secondNumber;

   }

   function setLength($length) {

      $this->length = $length;

   }

   function setHeight($height) {

      $this->width = $height;

   }

   function add() {

      return $this->firstNumber + $this->secondNumber;

   }

   function subtract() {

      return $this->firstNumber - $this->secondNumber;

   }

   function area() {

      return $this->length * $this->width;

   }

}

该例定义了一个类以及一些表示数字和大小的字段。而这些属性通过他们的名称来判断是否应该在一起。add()和substract()方法来对两个number进行操作,此外还定义了area()来操作length和width这两个字段。

这个类只负责各个独立的群体信息,显然,内聚力很低。重构上面的例子:

class ACohesiveClass {

   private $firstNumber;

   private $secondNumber;

   function __construct($firstNumber, $secondNumber) {

      $this->firstNumber = $firstNumber;

      $this->secondNumber = $secondNumber;

   }

   function add() {

      return $this->firstNumber + $this->secondNumber;

   }

   function subtract() {

      return $this->firstNumber - $this->secondNumber;

   }

}

重构以后,该类明显变成了高内聚特征的类。为什么?因为这个类里的每个部分都与另外一部分彼此联系。虽然在实际开发中编写出高内聚的类比较困难,但开发人员应该坚持这样做,坚持就是胜利。

2.正交性

就简单而言,正交是指隔离或排除副作用。一个方法、类或者模块改变了其他无关的方法、类或模块就不是正交。例如,飞机的黑匣子就具有正交性,它自身就具备电源、麦克风和传感器等这些功能。而它对外在的其他东西没有任何影响,它只提供一种机制,用来保存和检索飞行数据。

一个典型的非正交系统例子就是汽车电子设备。提高汽车的速度也存在些负面影响,比如会增加无线电音量,然而对汽车来说,速度并不是正交。

class Calculator {

   private $firstNumber;

   private $secondNumber;

   function __construct($firstNumber, $secondNumber) {

      $this->firstNumber = $firstNumber;

      $this->secondNumber = $secondNumber;

   }

   function add() {

      $sum = $this->firstNumber + $this->secondNumber;

      if ($sum > 100) {

         (new AlertMechanism())->tooBigNumber($sum);

      }

      return $sum;

   }

   function subtract() {

      return $this->firstNumber - $this->secondNumber;

   }

}

class AlertMechanism {

   function tooBigNumber($number) {

      echo $number . 'is too big!';

   }

}

在这个例子中,Calculator类里的add()方法里列了几个意想不到的行为:它生成AlertMechanism对象并调用其中的一个方法。实际上,该库的使用者并不希望消息被打印到屏幕上,相反,他们则是要计算数字之和。

class Calculator {

   private $firstNumber;

   private $secondNumber;

   function __construct($firstNumber, $secondNumber) {

      $this->firstNumber = $firstNumber;

      $this->secondNumber = $secondNumber;

   }

   function add() {

      return $this->firstNumber + $this->secondNumber;

   }

   function subtract() {

      return $this->firstNumber - $this->secondNumber;

   }

}

class AlertMechanism {

   function checkLimits($firstNumber, $secondNumber) {

      $sum = (new Calculator($firstNumber, $secondNumber))->add();

      if ($sum > 100) {

         $this->tooBigNumber($sum);

      }

   }

   function tooBigNumber($number) {

      echo $number . 'is too big!';

   }

}

这样明显好多了,AlertMechanish在Calculator中没有任何负面影响,相反,在任何需要弹出警告的地方都可以使用AlertMechanish。

3.依赖和耦合

大多数情况下,这两个单词是可以互换的,但是在某些情况下,又存在优先级关系。

那么,什么是依赖呢?当对象A需要使用对象B时,为了执行其规定的行为,我们说A依赖B。在OOP中,依赖是极其常见的。对象之间经常互相依赖才发挥功效。因此消除依赖是一项崇高的追求,这样做几乎是不可能的。控制依赖和减少依赖则是非常完美的。

就紧耦合(heavy-coupling)和松耦合(loose-coupling)而言,通常是指一个对象依赖于其他对象的程度。

在一个松耦合系统中,一个对象的变化会减少对其依赖对象的影响。在这样的系统中,类取决于接口而不是具体的实现(将会在下面提到)。这就是为什么松耦合系统对修改更加开放的原因。

Coupling in a Field

让我们看下面这个例子:

class Display {

   private $calculator;

   function __construct() {

      $this->calculator = new Calculator(1,2);

   }

}

这段代码很常见,在该例中,Display类依赖Calculator类并直接引用该类。Display类里的 $calculator字段属于Calculator类型。该对象和字段直接调用Calculator的构造函数。

通过访问其他类方法进行耦合

大家可以先看下面的代码:

class Display {

   private $calculator;

   function __construct() {

      $this->calculator = new Calculator(1, 2);

   }

   function printSum() {

      echo $this->calculator->add();

   }

}

Display类调用Calculator对象的add()方法。这是另外一种耦合方式,一个类访问另外一个类的方法。

通过方法引用进行耦合

你也可以通过方法引用进行耦合:

class Display {

   private $calculator;

   function __construct() {

      $this->calculator = $this->makeCalculator();

   }

   function printSum() {

      echo $this->calculator->add();

   }

   function makeCalculator() {

      return new Calculator(1, 2);

   }

}

需引起注意的是,makeCalculator()方法返回一个Calculator对象,这也是一种依赖。

利用多态进行耦合

遗传可能是依赖里的最强表现形式。

class AdvancedCalculator extends Calculator {

   function sinus($value) {

      return sin($value);

   }

}

通过依赖注入降低耦合

开发人员可以通过依赖注入来降低耦合度,例如:

class Display {

   private $calculator;

   function __construct(Calculator $calculator = null) {

      $this->calculator = $calculator ? : $this->makeCalculator();

   }

// ... //.

}

利用Display的构造函数对Calculator对象进行注入,从而减少了Display对Calculator类产生的依赖。

利用接口降低耦合

例如:


interface CanCompute {

   function add();

   function subtract();

}

class Calculator implements CanCompute {

   private $firstNumber;

   private $secondNumber;

   function __construct($firstNumber, $secondNumber) {

      $this->firstNumber = $firstNumber;

      $this->secondNumber = $secondNumber;

   }

   function add() {

      return $this->firstNumber + $this->secondNumber;

   }

   function subtract() {

      return $this->firstNumber - $this->secondNumber;

   }

}

class Display {

   private $calculator;

   function __construct(CanCompute $calculator = null) {

      $this->calculator = $calculator ? : $this->makeCalculator();

   }

   function printSum() {

      echo $this->calculator->add();

   }

   function makeCalculator() {

      return new Calculator(1, 2);

   }

}

该代码定义了一个CanCompute接口,在OOP中,接口可以看作一个抽象类型,它所定义的成员必须由类或结构来实现。在上述代码中,Calculator类来实现CanCompute接口。

Display构造函数期望有个对象来实现Cancompute接口,这时,Display的依赖对象Calculator被打破。然而,我们可以创建另一个类对象来实现Cancompute,并且传递一个对象到Display的构造函数中。Display现在只依赖于Cancompute接口,但即使这样依赖关系仍然是可选的。如果我们不传递任何参数给Display的构造函数,那么它将通过调用makeCalculator()方法来创建一个Calculator对象。这种技术经常被开发者们使用,尤其对驱动测试开发(TDD)极其有帮助。

SOLID原则

SOLID是一套代码编写守则,也就是大家常常说的敏捷开发原则,最初由Robert C. Martin所提出。使用它编写出来的代码不仅干净整洁,而且易维护、易修改和易扩展。实践表明,其在可维护性上有着非常积极的影响,更多资料大家可以阅读: Agile Software Development, Principles, Patterns, and Practices

SOLID所涵盖的话题非常广,下面我将会针对本文的主旨介绍一些简单易学的方法。

1.单一责任原则(SRP)

一个类只干一件事。听起来简单,但在实践中却可能相当难。

class Reporter {

   function generateIncomeReports();

   function generatePaymentsReports();

   function computeBalance();

   function printReport();

}

查看上面的代码,你认为该类的受益者会是哪个部门?会计部是用于收支平衡、财政部可能用来编写收入/支出报告,甚至归档部来打印和存档报告。然而每个部门都希望有属于自己的方法,并且根据自身需求来做些自定义的方法。

这样的类往往都是高内聚低耦合的。

2.Open-Closed原则(OCP)

类(和模块)应具备很好的功能扩展性,以及对现有功能具有一定的保护能力。让我们一起来看下典型的电风扇例子,你有一个开关来控制风扇:

class Switch_ {

   private $fan;

   function __construct() {

      $this->fan = new Fan();

   }

   function turnOn() {

      $this->fan->on();

   }

   function turnOff() {

      $this->fan->off();

   }

}

这段代码创建了Switch_类,用来创建和控制Fan对象。注意这里的下划线,在PHP中是不允许把类名定义为Switch的。

这时,你的老板希望能利用该开关控制电风扇上的电灯,那么你就不得不修改Switch_这个类。

对现有代码进行修改存在一部分风险,很有可能对系统其他部分产生影响。所以在添加新功能时的最好的方法是避开现有功能。

在OOP中,你可以发现Switch_对Fan类有很强的依赖性。这正是我们的问题所在,基于此,做出如下修改:

interface Switchable {

   function on();

   function off();

}

class Fan implements Switchable {

   public function on() {

      // code to start the fan.

   }

   public function off() {

      // code to stop the fan.

   }

}

class Switch_ {

   private $switchable;

   function __construct(Switchable $switchable) {

      $this->switchable = $switchable;

   }

   function turnOn() {

      $this->switchable->on();

   }

   function turnOff() {

      $this->switchable->off();

   }

}

该代码定义了一个Switchable接口,它里面所定义的方法需要开关启用选项来实现。Fan对象实现Switchable和Switch_并且接受一个参数到Switchable对象的构造函数里。

这样做有哪些好处?

首先,该解决方案打破了Switch_和Fan之间的依赖关系。Switch_不知道它要开启风扇,并且也不关心。其次引进的Light类不会影响Switch_或Switchable。难道你想用Switch_类来控制Light对象吗?代码如下:

class Light implements Switchable {

   public function on() {

      // code to turn ligh on.

   }

   public function off() {

      // code to turn light off.

   }

}

class SomeWhereInYourCode {

   function controlLight() {

      $light = new Light();

      $switch = new Switch_($light);

      $switch->turnOn();

      $switch->turnOff();

   }

}

3.Liskov替换原则(LSP)

LSP是指子类永不打破父类的功能,这点是非常重要的。用户定义一个子类只是希望能实现其自有功能,而不是去影响原来的功能。

乍看有点困惑,还是让我们一起来看看代码吧:

class Rectangle {

   private $width;

   private $height;

   function setWidth($width) {

      $this->width = $width;

   }

   function setHeigth($heigth) {

      $this->height = $heigth;

   }

   function area() {

      return $this->width * $this->height;

   }

}

定义一个简单的Rectangle类,我们可以设置它的高度和宽度,并且area()方法可以计算出该矩形的面积。再看下面例子:

class Geometry {

   function rectArea(Rectangle $rectangle) {

      $rectangle->setWidth(10);

      $rectangle->setHeigth(5);

      return $rectangle->area();

   }

}

rectArea()方法接受一个Rectangle对象作为一个参数,设置其高度和宽度并且返回该图形的面积。

正方形乃是矩形中的一个特殊图形,我们定义Square类来继承Rectangle:

class Square extends Rectangle {

   // What code to write here?.

}

我们有好几种方法来重写area()方法并且返回该正方形的宽度:

class Rectangle {

   protected $width;

   protected $height;

   // ... //.

}

class Square extends Rectangle {

   function area() {

      return $this->width ^ 2;

   }

}

把Rectangle的字段改为protected,好让Square有访问的权限。从几何的角度来看是非常合理的,因为正方形的边长是相等的,所以返回正方形的宽度是非常合理的。

然而从编程的角度来看又存在一个问题;如果Square是一个Rectangle,把它馈入到Geometry类是没有任何问题的,但这样做以后,Geometry的代码就显的多余,毫无意义可言。它设置了高度和宽度两个值,这也就是为什么square不是rectangle编程。LSP正很好是说明了这一点。

4.接口隔离原则(ISP

该原则主要集中用在把大接口分成多个小接口和特殊的接口。基本思路是在同一个类中,不同的用户不应该知道不同的接口——除非该用户需要用到那个接口。即使一个用户不需要使用该类的所有方法,但它仍然依赖于这些方法。所以为什么不根据用户需要定义相应的接口呢?

想象下,如果我们要实现一个股票市场应用,我们要有一个经纪人(Broker)来购买和出售股票,并且报告每天的收益和损失。一个简单的实现方法是定义一个Broker接口,一个NYSEBroker类用来实现Broker和一些用户的接口类:创建交易(TransactionUI)和写报告(DailyReporter)。代码可以类似下面这样:

interface Broker {

   function buy($symbol, $volume);

   function sell($symbol, $volume);

   function dailyLoss($date);

   function dailyEarnings($date);

}

class NYSEBroker implements Broker {

   public function buy($symbol, $volume) {

      // implementsation goes here.

   }

   public function currentBalance() {

      // implementsation goes here.

   }

   public function dailyEarnings($date) {

      // implementsation goes here.

   }

   public function dailyLoss($date) {

      // implementsation goes here.

   }

   public function sell($symbol, $volume) {

      // implementsation goes here.

   }

}

class TransactionsUI {

   private $broker;

   function __construct(Broker $broker) {

      $this->broker = $broker;

   }

   function buyStocks() {

      // UI logic here to obtain information from a form into $data.

      $this->broker->buy($data['sybmol'], $data['volume']);

   }

   function sellStocks() {

      // UI logic here to obtain information from a form into $data.

      $this->broker->sell($data['sybmol'], $data['volume']);

   }

}

class DailyReporter {

   private $broker;

   function __construct(Broker $broker) {

      $this->broker = $broker;

   }

   function currentBalance() {

      echo 'Current balace for today ' . date(time()) . "\n";

      echo 'Earnings: ' . $this->broker->dailyEarnings(time()) . "\n";

      echo 'Losses: ' . $this->broker->dailyLoss(time()) . "\n";

   }

}

虽然这段代码可以正常工作,但它违反了ISP。DailyReporter和TransactionUI都依赖Broker接口。然而,它们只使用接口的一部分。TransactionUI使用buy()和sell()方法,而DailyReporter只用到dailyEarnings()和dailyLoss()方法。

你怀疑Broker没有内聚力,因为它的一些方法没有任何相关性。也许你说的对,但是具体答案还得由Broker说了算;销售和购买可能与当前的盈余有相当大的关系。例如当亏本的时候有可能就不会执行购买操作。

此时,你可能会说Broker违反了SRP,因为有两个类以不同的方式在使用它,可能有两个不同的执行者。好吧,其实它并没有违反SRP。唯一的执行者就是Broker。他会根据当前的形式做出购买/出售操作,其最终的依赖对象是整个系统和业务。

毫无疑问,上述代码肯定是违反了ISP,两个UI类都依赖于整个Broker。这是很常见的问题,改变下观点,代码可以这样修改:

interface BrokerTransactions {

   function buy($symbol, $volume);

   function sell($symbol, $volume);

}

interface BrokerStatistics {

   function dailyLoss($date);

   function dailyEarnings($date);

}

class NYSEBroker implements BrokerTransactions, BrokerStatistics {

   public function buy($symbol, $volume) {

      // implementsation goes here.

   }

   public function currentBalance() {

      // implementsation goes here.

   }

   public function dailyEarnings($date) {

      // implementsation goes here.

   }

   public function dailyLoss($date) {

      // implementsation goes here.

   }

   public function sell($symbol, $volume) {

      // implementsation goes here.

   }

}

class TransactionsUI {

   private $broker;

   function __construct(BrokerTransactions $broker) {

      $this->broker = $broker;

   }

   function buyStocks() {

      // UI logic here to obtain information from a form into $data.

      $this->broker->buy($data['sybmol'], $data['volume']);

   }

   function sellStocks() {

      // UI logic here to obtain information from a form into $data.

      $this->broker->sell($data['sybmol'], $data['volume']);

   }

}

class DailyReporter {

   private $broker;

   function __construct(BrokerStatistics $broker) {

      $this->broker = $broker;

   }

   function currentBalance() {

      echo 'Current balace for today ' . date(time()) . "\n";

      echo 'Earnings: ' . $this->broker->dailyEarnings(time()) . "\n";

      echo 'Losses: ' . $this->broker->dailyLoss(time()) . "\n";

   }

}

修改后的代码明显变的有意义而且尊重了ISP。DailyReporter只依赖BrokerStatistics,它无需关心和知道出售和购买这两个操作。另一方面,TransactionUI只关心购买和出售。NYSEBroker和先前的定义是一样的,实现BrokerTransactions和BrokerStatistics接口。

更复杂的例子你可以前往Rober C.Martin博客上查看 The Interface Segregation Principle里的首篇论文。

5.依赖倒置原则(DIP

这条原则指出高层模块不应该依赖低层模块,两者都应该依赖于抽象。抽象不应该依赖细节,细节反过来应依赖于抽象。简单地说,你应该尽可能的依赖于抽象而不是实现。

DIP的诀窍是你想反转依赖,但是又想一直保持着整个控制流。回顾下OCP(Switch和Light类),在原始实现中是直接利用开关来控制灯的。

你会看到整个依赖和控制流都是由Switch流向Light。当不想直接控制Light时,你可以引进接口这一概念。

非常神奇!引进接口后,代码同时满足了DIP和OCP两大原则。正如你上图所看到的,倒置了依赖,但整个控制流是不变的。

高级设计

关于代码的另一重要方面是高级设计和通用体系结构。一个混乱的架构所产生的代码往往是很难修改的,所以保持一个干净整洁的架构是必不可少的,第一步就是理解如何根据不同的内容分离代码。

这张图中,最主要的部分是业务逻辑,它能够如预期那样正常有效的工作并且与其他部分不存在任何瓜葛。站在高级设计角度可以看作为正交性。

从右边的“main”开始看,箭头进入应用程序——创建对象工厂。一个理想的解决方案是从各个特定的工厂中得到相应的对象,但这有点不切实际。不过当有机会这样做的时候还是要使用,并且让它们保持在业务逻辑之外。

再看底部,定义持久层(数据库、文件访问、网络通信)用来保证信息的持久性。业务逻辑层是没有对象知道持久层是如何工作的。

左边则是交互机制。MVC比如Laravel、CakePHP,只能是交付机制而已。

当你看到应用程序架构或目录时,你应该注意其架构是说明程序将要做什么,而不是使用什么技术或数据库。

最后,为了确保所有的依赖项都指向业务逻辑层。用户接口、工厂、数据库则是具体的实现,而你永远不要只依赖于它们。依赖倒置指向业务逻辑模块,无需修改业务逻辑的依赖关系即可允许我们改变依赖。

关于设计模型

在使代码变得易于修改和理解的过程中,设计模型扮演着非常重要的角色。从结构的角度来看,设计模式显然是很有好处的,它们是行之有效并且深思熟虑的解决方案。更多关于设计模式内容,可以前往 Tuts+ Premium course 。

测试的力量

测试驱动开发(TDD)所编写出来的代码是很容易测试的。TDD迫使你尊重以上原则来编写代码,从而使你的程序更易被测试。单元测试运行速度很快,应该非常快,当你在一个类里使用10个对象来测试一个单独方法时,你的代码很有可能是有问题的。

总结

俗话说,实践乃是检验真理的唯一标准,所以开发者只有在平时的工作中坚持使用这些原则才能编写出理想的代码。与此同时,不要轻易满足于自己所编写出的代码,要努力让你的代码易于维护、干净并且拥抱变化


相关文章 相关文档 相关课程



深度解析:清理烂代码
如何编写出拥抱变化的代码
重构-使代码更简洁优美
团队项目开发"编码规范"系列文章
重构-改善既有代码的设计
软件重构v2
代码整洁之道
高质量编程规范
基于HTML5客户端、Web端的应用开发
HTML 5+CSS 开发
嵌入式C高质量编程
C++高级编程

 
分享到
 
 
     


WEB应用程序UI模版代码编写
C# 编码规范和编程好习惯
什么是防御性编程
善于防守-健壮代码的防御性
Visual C++编程命名规则
JavaScript程序编码规范
更多...   


设计模式原理与应用
从需求过渡到设计
软件设计原理与实践
如何编写高质量代码
单元测试、重构及持续集成
软件开发过程指南


某全球知名通信公司 代码整洁
横河电机 如何编写高质量代码
某知名金融软件服务商 代码评审
东软集团 代码重构
某金融软件服务商 技术文档
中达电通 设计模式原理与实践
法国电信 技术文档编写与管理
更多...   
 
 
 
 
 
每天2个文档/视频
扫描微信二维码订阅
订阅技术月刊
获得每月300个技术资源
 
 

关于我们 | 联系我们 | 京ICP备10020922号 京公海网安备110108001071号