優(yōu)雅代碼的秘密，都藏在這六個(gè)設(shè)計(jì)原則中

作者：撿田螺的小男孩 2022-10-20 07:57:32

高層模塊不應(yīng)該依賴低層模塊，兩者都應(yīng)該依賴其抽象；抽象不應(yīng)該依賴細(xì)節(jié)，細(xì)節(jié)應(yīng)該依賴抽象。它的核心思想是：要面向接口編程，而不要面向?qū)崿F(xiàn)編程。

?前言

大家好，我是撿田螺的小男孩。

優(yōu)雅的代碼，猶如亭亭玉立的美女，讓人賞心悅目。而糟糕的代碼，卻猶如屎山，讓人避而遠(yuǎn)之。

如何寫出優(yōu)雅的代碼呢？那就要理解并熟悉應(yīng)用這6個(gè)設(shè)計(jì)原則啦：開閉原則、單一職責(zé)原則、接口隔離原則、迪米特法則、里氏替換原則、依賴倒置原則。本文呢，將通過代碼demo，讓大家輕松理解這6個(gè)代碼設(shè)計(jì)原則，加油~

1. 開閉原則

開閉原則，即對(duì)擴(kuò)展開放，對(duì)修改關(guān)閉。

對(duì)于擴(kuò)展和修改，我們?cè)趺慈ダ斫馑兀繑U(kuò)展開放表示，未來業(yè)務(wù)需求是變化萬千，代碼應(yīng)該保持靈活的應(yīng)變能力。修改關(guān)閉表示不允許在原來類修改，保持穩(wěn)定性。

因?yàn)槿粘Ｐ枨笫遣粩嗟碌模晕覀兘?jīng)常需要在原來的代碼中修改。如果代碼設(shè)計(jì)得不好，擴(kuò)展性不強(qiáng)，每次需求迭代，都要在原來代碼中修改，很可能會(huì)引入bug。因此，我們的代碼應(yīng)該遵循開閉原則，也就是對(duì)擴(kuò)展開放，對(duì)修改關(guān)閉。

為了方便大家理解開閉原則，我們來看個(gè)例子：假設(shè)有這樣的業(yè)務(wù)場(chǎng)景，大數(shù)據(jù)系統(tǒng)把文件推送過來，根據(jù)不同類型采取不同的解析方式。多數(shù)的小伙伴就會(huì)寫出以下的代碼：

if(type=="A"){
   //按照A格式解析
 
}else if(type=="B"){
    //按B格式解析
}else{
    //按照默認(rèn)格式解析
}

這段代碼有什么問題呢？

如果分支變多，這里的代碼就會(huì)變得臃腫，難以維護(hù)，可讀性低。

如果你需要接入一種新的解析類型，那只能在原有代碼上修改。

顯然，增加、刪除某個(gè)邏輯，都需要修改到原來類的代碼，這就違反了開閉原則了。為了解決這個(gè)問題，我們可以使用策略模式去優(yōu)化它。

你可以先聲明一個(gè)文件解析的接口，如下：

public interface IFileStrategy {
    
    //屬于哪種文件解析類型，A或者B
    FileTypeResolveEnum gainFileType();
    
    //封裝的公用算法（具體的解析方法）
    void resolve(Object param);
}

然后實(shí)現(xiàn)不同策略的解析文件，如類型A解析：

@Component
public class AFileResolve implements IFileStrategy {
    
    @Override
    public FileTypeResolveEnum gainFileType() {
        return FileTypeResolveEnum.File_A_RESOLVE;
    }

    @Override
    public void resolve(Object objectparam) {
      logger.info("A 類型解析文件，參數(shù)：{}",objectparam);
      //A類型解析具體邏輯
    }
}

如果未來需求變更的話，比如增加、刪除某個(gè)邏輯，不會(huì)再修改到原來的類啦，只需要修改對(duì)應(yīng)的文件解析類型的類即可。

對(duì)于如何使用設(shè)計(jì)模式，大家有興趣的話，可以看我以前的這篇文章哈：實(shí)戰(zhàn)！工作中常用到哪些設(shè)計(jì)模式

2. 單一職責(zé)原則

單一職責(zé)原則：一個(gè)類或者一個(gè)接口，最好只負(fù)責(zé)一項(xiàng)職責(zé)。比如一個(gè)類C?違反了單一原則，它負(fù)責(zé)兩個(gè)職責(zé)P1和P2?。當(dāng)職責(zé)P1?需要修改時(shí)，就會(huì)改動(dòng)到類C?，這就可能導(dǎo)致原本正常的P2也受影響。

如何更好理解呢？比如你實(shí)現(xiàn)一個(gè)圖書管理系統(tǒng)，一個(gè)類既有圖書的增刪改查，又有讀者的增刪改查，你就可以認(rèn)為這個(gè)類違反了單一原則。因?yàn)檫@個(gè)類涉及了不同的功能職責(zé)點(diǎn)，你可以把這個(gè)拆分。

以上圖書管理系統(tǒng)這個(gè)例子，違反單一原則，按業(yè)務(wù)拆分。這比較好理解，但是有時(shí)候，一個(gè)類并不是那么好區(qū)分。這時(shí)候大家可以看這個(gè)標(biāo)準(zhǔn)，來判斷功能職責(zé)是否單一:

類中的私有方法過多
你很難給類起一個(gè)合適的名字
類中的代碼行數(shù)、函數(shù)或者屬性過多
類中大量的方法都是集中操作類中的某幾個(gè)屬性
類依賴的其他類過多，或者依賴類的其他類過多

比如，你寫了一個(gè)方法，這個(gè)方法包括了日期處理和借還書的業(yè)務(wù)操作，你就可以把日期處理抽到私有方法。再然后，如果你發(fā)現(xiàn)，很多私有方法，都是類似的日期處理，你就可以把這個(gè)日期處理方法抽成一個(gè)工具類。

日常開發(fā)中，單一原則的思想都有體現(xiàn)的。比如微服務(wù)拆分。

3. 接口隔離原則

接口隔離原則：接口的調(diào)用者或者使用者，不應(yīng)該強(qiáng)迫依賴它不需要的接口。它要求建立單一的接口，不要建立龐大臃腫的接口，盡量細(xì)化接口，接口中的方法盡量少，讓接口中只包含客戶（調(diào)用者）感興趣的方法。即一個(gè)類對(duì)另一個(gè)類的依賴應(yīng)該建立在最小的接口上。

比如類A?通過接口I?依賴類B?，類C?通過接口I?依賴類D?，如果接口I?對(duì)于類A?和類B?來說，都不是最小接口，則類B?和類D必須去實(shí)現(xiàn)他們不需要的方法。如下圖：

這個(gè)圖表達(dá)的意思是：類A?依賴接口I?中的method1、method2?，類B是對(duì)類A依賴的實(shí)現(xiàn)。類C依賴接口I?中的method1、method3，類D是對(duì)類C依賴的實(shí)現(xiàn)。對(duì)于實(shí)現(xiàn)類B和D，它們都存在用不到的方法，但是因?yàn)閷?shí)現(xiàn)了接口I，所以必須要實(shí)現(xiàn)這些用不到的方法。

可以看下以下代碼：

public interface I {

    void method1();

    void method2();

    void method3();
}

@Service
public class A {

    @Resource(name="B")
    private I i;

    public void depend1() {
        i.method1();
    }

    public void depend2(){
        i.method2();
    }

}

@Service("B")
public class B implements I {

    @Override
    public void method1() {
        System.out.println("類B實(shí)現(xiàn)接口I的方法1");
    }

    @Override
    public void method2() {
        System.out.println("類B實(shí)現(xiàn)接口I的方法2");
    }

    //沒用到這個(gè)方法，但是也要默認(rèn)實(shí)現(xiàn)，因?yàn)镮有這個(gè)接口方法
    @Override
    public void method3() {

    }
}

@Service
public class C {

    @Resource(name="D")
    private I i;

    public void depend1(I i){
        i.method1();
    }

    public void depend3(I i){
        i.method3();
    }

}

@Service("D")
public class D implements I {

    @Override
    public void method1() {
        System.out.println("類D實(shí)現(xiàn)接口I的方法1");
    }

    //沒用到這個(gè)方法，但是也要默認(rèn)實(shí)現(xiàn)，因?yàn)镮有這個(gè)接口方法
    @Override
    public void method2() {

    }

    @Override
    public void method3() {
        System.out.println("類D實(shí)現(xiàn)接口I的方法3");
    }
}

大家可以發(fā)現(xiàn)，如果接口過于臃腫，只要接口中出現(xiàn)的方法，不管對(duì)依賴于它的類有沒有用到，實(shí)現(xiàn)類都必須去實(shí)現(xiàn)這些方法。實(shí)現(xiàn)類B?沒用到method3?，它也要有個(gè)默認(rèn)實(shí)現(xiàn)。實(shí)現(xiàn)類D?沒用到method2，它也要有個(gè)默認(rèn)實(shí)現(xiàn)。

顯然，這不是一個(gè)好的設(shè)計(jì)，違反了接口隔離原則。我們可以對(duì)接口I進(jìn)行拆分。拆分后的設(shè)計(jì)如圖2所示：

接口是不是分得越細(xì)越好呢？并不是。日常開發(fā)中，采用接口隔離原則對(duì)接口進(jìn)行約束時(shí)，要注意以下幾點(diǎn)：

接口盡量小，但是要有限度。對(duì)接口進(jìn)行細(xì)化可以提高程序設(shè)計(jì)靈活性是不掙的事實(shí)，但是如果過小，則會(huì)造成接口數(shù)量過多，使設(shè)計(jì)復(fù)雜化。所以一定要適度。

為依賴接口的類定制服務(wù)，只暴露給調(diào)用的類它需要的方法，它不需要的方法則隱藏起來。只有專注地為一個(gè)模塊提供定制服務(wù)，才能建立最小的依賴關(guān)系。

提高內(nèi)聚，減少對(duì)外交互。使接口用最少的方法去完成最多的事情。運(yùn)用接口隔離原則，一定要適度，接口設(shè)計(jì)的過大或過小都不好。設(shè)計(jì)接口的時(shí)候，只有多花些時(shí)間去思考和籌劃，才能準(zhǔn)確地實(shí)踐這一原則。

4. 迪米特法則

定義：又叫最少知道原則。一個(gè)類對(duì)于其他類知道的越少越好，就是說一個(gè)對(duì)象應(yīng)當(dāng)對(duì)其他對(duì)象有盡可能少的了解,只和朋友談心，不和陌生人說話。它的核心思想就是，盡量降低類與類之間的耦合，盡最大能力減小代碼修改帶來的對(duì)原有的系統(tǒng)的影響。

比如一個(gè)生活例子：你對(duì)你的對(duì)象肯定了解的很多，但是如果你對(duì)別人的對(duì)象也了解很多，你的對(duì)象要是知道，那就要出大事了。

我們來看下一個(gè)違反迪米特法則的例子，業(yè)務(wù)場(chǎng)景是這樣的：一個(gè)學(xué)校，要求打印出所有師生的ID。

//學(xué)生  
class Student{  
    private String id;  
    public void setId(String id){  
        this.id = id;  
    }  
    public String getId(){  
        return id;  
    }  
}  

//老師  
class Teacher{  
    private String id;  
    public void setId(String id){  
        this.id = id;  
    }  
    public String getId(){  
        return id;  
    }  
}  

//管理者（班長(zhǎng)）
public class Monitor {
 
    //所有學(xué)生
    public List<Student> getAllStudent(){
        List<Student> list = new ArrayList<Student>();
        for(int i=0; i<100; i++){
            Student student = new Student();
            //為每個(gè)學(xué)生分配個(gè)ID
            student.setId("學(xué)生Id："+i);
            list.add(student);
        }
        return list;
    }

}

//校長(zhǎng)
public class Principal {

    //所有教師
    public List<Teacher> getAllTeacher(){
        List<Teacher> list = new ArrayList<Teacher>();
        for(int i=0; i<20; i++){
            Teacher emp = new Teacher();
            //為全校老師按順序分配一個(gè)ID
            emp.setId("老師編號(hào)"+i);
            list.add(emp);
        }
        return list;
    }

    //所有師生
    public void printAllTeacherAndStudent(ClassMonitor classMonitor) {

        List<Student> list1 = classMonitor.getAllStudent();
        for (Student s : list1) {
            System.out.println(s.getId());
        }

        List<Teacher> list2 = this.getAllTeacher();
        for (Teacher teacher : list2) {
            System.out.println(teacher.getId());
        }
    }
}

這塊代碼。問題出在類Principal?中，根據(jù)迪米特法則，只能與直接的朋友發(fā)生通信，而Student?類并不是Principal?類的直接朋友（以局部變量出現(xiàn)的耦合不屬于直接朋友），從邏輯上講校長(zhǎng)Principal?只與管理者M(jìn)onitor?耦合就行了，可以讓Principal?繼承類Monitor?，重寫一個(gè)printMember的方法。優(yōu)化后的代碼如下:

public class Monitor {

    public List<Student> getAllStudent(){
        List<Student> list = new ArrayList<Student>();
        for(int i=0; i<100; i++){
            Student student = new Student();
            //為每個(gè)學(xué)生分配個(gè)ID
            student.setId("學(xué)生Id："+i);
            list.add(student);
        }
        return list;
    }

    public void printMember() {
        List<Student> list = this.getAllStudent();
        for (Student student : list) {
            System.out.println(student.getId());
        }
    }
}

public class Principal extends Monitor {

    public List<Teacher> getAllTeacher(){
        List<Teacher> list = new ArrayList<Teacher>();
        for(int i=0; i<30; i++){
            Teacher emp = new Teacher();
            //為全校老師按順序分配一個(gè)ID
            emp.setId("老師編號(hào)"+i);
            list.add(emp);
        }
        return list;
    }

    public void printMember() {
        super.printMember();

        for (Teacher teacher : this.getAllTeacher()) {
            System.out.println(teacher.getId());
        }
    }
}

5. 里氏替換原則

里氏替換原則：

如果對(duì)每一個(gè)類型為S?的對(duì)象o1?，都有類型為T?的對(duì)象o2?，使得以T?定義的所有程序P?在所有的對(duì)象o1?都代換成o2?時(shí)，程序P?的行為沒有發(fā)生變化，那么類型S?是類型T的子類型。

一句話來描述就是：只要有父類出現(xiàn)的地方，都可以用子類來替代，而且不會(huì)出現(xiàn)任何錯(cuò)誤和異常。更通俗點(diǎn)講，就是子類可以擴(kuò)展父類的功能，但是不能改變父類原有的功能。

其實(shí)，對(duì)里氏替換原則的定義可以總結(jié)如下：

子類可以實(shí)現(xiàn)父類的抽象方法，但不能覆蓋父類的非抽象方法
子類中可以增加自己特有的方法
當(dāng)子類的方法重載父類的方法時(shí)，方法的前置條件（即方法的輸入?yún)?shù)）要比父類的方法更寬松
當(dāng)子類的方法實(shí)現(xiàn)父類的方法時(shí)（重寫/重載或?qū)崿F(xiàn)抽象方法），方法的后置條件（即方法的的輸出/返回值）要比父類的方法更嚴(yán)格或相等

我們來看個(gè)例子：


public class Cache {

    public void set(String key, String value) {

    }
}

public class RedisCache extends Cache {

    public void set(String key, String value) {

    }

}

這里例子是沒有違反里氏替換原則的，任何父類、父接口出現(xiàn)的地方子類都可以出現(xiàn)。如果給RedisCache加上參數(shù)校驗(yàn)，如下：


public class Cache {

    public void set(String key, String value) {

    }
}

public class RedisCache extends Cache {

    public void set(String key, String value) {
        if (key == null || key.length() < 10 || key.length() > 100) {
            System.out.println("key的長(zhǎng)度不符合要求");
            throw new IllegalArgumentException();
        }
    }
}

這就違反了里氏替換原則了，因?yàn)樽宇惙椒ㄔ黾恿思恿藚?shù)校驗(yàn)，拋出了異常，雖然子類仍然可以來替換父類。

6.依賴倒置原則

依賴倒置原則定義：

依賴倒置原則可以降低類間的耦合性、提高系統(tǒng)的穩(wěn)定性、減少并行開發(fā)引起的風(fēng)險(xiǎn)、提高代碼的可讀性和可維護(hù)性。要滿足依賴倒置原則，我們需要在項(xiàng)目中滿足這個(gè)規(guī)則：

每個(gè)類盡量提供接口或抽象類，或者兩者都具備。
變量的聲明類型盡量是接口或者是抽象類。
任何類都不應(yīng)該從具體類派生。
使用繼承時(shí)盡量遵循里氏替換原則。

我們來看一段違反依賴倒置原則的代碼，業(yè)務(wù)需求是：顧客從淘寶購物。代碼如下：

class Customer{
    public void shopping(TaoBaoShop shop){
        //購物
        System.out.println（shop.buy());
    }
}

以上代碼是存在問題的，如果未來產(chǎn)品變更需求，改為顧客從京東上購物，就需要把代碼修改為：

class Customer{
    public void shopping(JingDongShop shop){
        //購物
        System.out.println（shop.buy());
    }
}

如果產(chǎn)品又變更為從天貓購物呢？那有得修改代碼了，顯然這違反了開閉原則?。顧客類設(shè)計(jì)時(shí)，同具體的購物平臺(tái)類綁定了，這違背了依賴倒置原則。可以設(shè)計(jì)一個(gè)shop接口，不同購物平臺(tái)（如淘寶、京東）實(shí)現(xiàn)于這個(gè)接口，即修改顧客類面向該接口編程，就可以解決這個(gè)問題了。代碼如下：

class Customer{
    public void shopping(Shop shop){
        //購物
        System.out.println（shop.buy());
    }
}

interface Shop{
   String buy();
}

Class TaoBaoShop implements Shop{
     public String buy(){
       return "從淘寶購物";
     }
}

Class JingDongShop implements Shop{
      public String buy(){
       return "從京東購物";
     }
}

責(zé)任編輯：武曉燕來源：撿田螺的小男孩

高層模塊設(shè)計(jì)代碼