阿里的同事，寫的代碼真 TMD 優(yōu)雅！

• 代碼不易擴(kuò)展或擴(kuò)展容易引發(fā)其他問題

• 程序崩潰

• 加班

• 增加公司成本(加人)

• 甚至可能造成公司倒閉

1.1、所以從一開始就要保持整潔

所以在一開始就要寫整潔的代碼,如果有不整潔的代碼就要及時的整改. 絕對不要有以后再改,以后再說的想法， 因為！

later equal never

如果是一定要做的事情,那就趁早做!

那么現(xiàn)在的問題就是,怎樣的代碼才算是整潔的代碼呢:

• 可讀性要高: 代碼要像散文一樣優(yōu)雅易讀,見碼知意
• 拒絕重復(fù)代碼
• 滿足設(shè)計模式原則
• 單一職責(zé)
• 開閉原則
• 里氏替換原則
• 依賴倒轉(zhuǎn)原則
• 接口隔離原則
• 迪米特法則
• 合成復(fù)用法則

2、命名

1、沒有任何意義的命名方式；

public interface Animal {
    void abc();
}

public interface Animal {
    void cry();
}

public interface StudentRepository extends JpaRepository<AlertAll, String> {
    Student findOneById(
            @Param("id") String id
    );

    List<Student> queryAllStudent(
    );

}

public interface StudentRepository extends JpaRepository<AlertAll, String> {
    Student findOneById(
            @Param("id") String id
    );

    List<Student> findAll(
    );

}

// 獲取單個對象的方法用get做前綴
getXxx();
//獲取多個對象用list做前綴
listXxxx();

3、類

整潔的類應(yīng)滿足一下內(nèi)容:

• 單一職責(zé)
• 開閉原則
• 高內(nèi)聚性

3.1、單一職責(zé)

• 降低類的復(fù)雜度
• 提高類的可讀性
• 提高系統(tǒng)的可維護(hù)性
• 降低變更引起的風(fēng)險

public abstract class Sql {
    // 操作SQL的職責(zé)
    public abstract void insert();
    // 統(tǒng)計SQL操作的職責(zé)
    public abstract void countInsert();

}

將統(tǒng)計的職責(zé)抽取到另一個類

public abstract class CountSql {

    public abstract void countInsert();

}

3.2、開閉原則

public abstract class Sql {
    public abstract void insert();
    public abstract void update();
    public abstract void delete();
}

public abstract class Sql {
    public abstract void generate();
}

public class CreateSql extends Sql {

    @java.lang.Override
    public void generate() {
        // 省略實現(xiàn)
    }
}
public class UpdateSql extends Sql {

    @Override
    public void generate() {
        // 省略實現(xiàn)
    }
}

系統(tǒng)應(yīng)該由許多短小的類而不是少量巨大的類組成,每個小類封裝一個權(quán)責(zé),只有一個修改的原因,并與少數(shù)其他類一起協(xié)同達(dá)成期望的系統(tǒng)行為.

3.3、內(nèi)聚

要想讓函數(shù)變得整潔,應(yīng)保證:

• 只做一件事
• 好的命名
• 整潔的參數(shù)
• 注意返回內(nèi)容

4.1、只做一件事

public class PicService {

    public String upload(){
        // 校驗圖片的方法 偽代碼80行

        // 壓縮圖片的方法 偽代碼50行

        // 返回成功或失敗標(biāo)識 0,1 偽代碼5行
        return "0";
    }
}

原有的upload方法做了很多的事情, 重構(gòu)后只做了一件事情: 把大一些的概念(換言之,函數(shù)的名稱)拆分為另一抽象層上的一系列步驟:

 public String upload(){
        // 校驗圖片的方法
        check();
        // 壓縮圖片的方法
        compress();
        // 返回成功或失敗標(biāo)識 0,1
        return "0";
    }

public String addCharacter(String originString, char ch);

// 追加到末尾
public String appendCharacter(String originString, char ch);   

// 插入指定位置
public String insertCharacter(String originString, char ch, int insertPosition); 

1、函數(shù)應(yīng)該無副作用；
函數(shù)應(yīng)該無副作用， 意思就是函數(shù)應(yīng)該只做一件事，但是做這件事的時候做了另一件有副作用的事情.

例如:校驗密碼時會初始化session，導(dǎo)致會話丟失。如果無法移除這種副作用，應(yīng)該在方法名中展示出來，避免用戶誤用 checkPasswordasswordAndInitializeSession, 從命名上就要體現(xiàn)副作用.

4.3、參數(shù)

1、參數(shù)越少越好；
參數(shù)越少，越容易理解，參數(shù)超過三個可以將參數(shù)進(jìn)行封裝，要按參數(shù)的語義進(jìn)行封裝，不一定封裝成一個大而全的參數(shù)，可以封裝為多個，原則是按語義補(bǔ)充;

示例:

public List<Student> findStudent(int age, String name, String country, int gender);

//封裝參數(shù)
public List<Student> findStudent(Student student);

1、不要使用標(biāo)識參數(shù)；
標(biāo)識參數(shù)是參數(shù)為Boolean 類型, 用戶傳遞true or false . 不要使用標(biāo)識參數(shù)因為這意味著你的函數(shù)違背了單一職責(zé)(true false 兩套邏輯).

正確的做法是拆分為兩個方法:

//標(biāo)識參數(shù)方法
render(Boolean isSuite);

//重構(gòu)為兩個方法
reanderForSuite();
renderForSingleTest();

1、不要使用輸出參數(shù)；

什么是輸出參數(shù)?

將變量作為參數(shù)傳入方法,并且將變量輸出, 這就是輸出參數(shù)

public void findStudent(){
Student student = new Student();
doSomething(student);
return student;
}

int doSomething(Student student){
// 省略一些student邏輯
return student;
}

為什么不應(yīng)該有輸出參數(shù)?
因為增加了理解成本在里面,我們需要查看doSomething到底對student 做了什么. student是輸入還是輸出參數(shù)? 都不明確.

重構(gòu):

// 將doSomething()方法內(nèi)聚到student對象本身
student.doSomething();

4.4、返回值

1、分離指令與訊問；
示例代碼:

Pulic Boolean addElement(Element element)

指令為增加某個元素,詢問是否成功,

這樣做的壞處是職責(zé)不單一，所以應(yīng)該拆分為兩個方法

public void addElement(Element element);
public Boolean isAdd(Element element);

1、使用異常替代返回錯誤碼；
直接拋出異常,而不是返回錯誤碼進(jìn)行判斷, 可以使代碼更簡潔. 因為使用錯誤碼有可能會進(jìn)行多層嵌套片段

代碼示例:

// 使用錯誤碼導(dǎo)致多層嵌套...
public class DeviceController{

 public void sendShutDown(){
  DeviceHandle handle=getHandle(DEV1);
   //Check the state of the device 
  if (handle != DeviceHandle.INVALID){
   // Save the device status to the record field 
   retrieveDeviceRecord(handle);
   // If nat suspended,shut down
   if (record.getStatus()!=DEVICE_SUSPENDED){
     pauseDevice(handle);
     clearDeviceWorkQueue(handle);
     closeDevice(handle);
   }else{
    logger.log("Device suspended. Unable to shut down"); 
   }
  }else{
   logger.log("Invalid handle for: " +DEV1.tostring()); 
 }
} 

重構(gòu)后:

//  將代碼拆分為一小段一小段, 降低復(fù)雜度,更加清晰
public class DeviceController{

 public void sendShutDowm(){ 
  try{
   tryToShutDown();
  } catch (DeviceShutDownError e){ 
   logger.log(e);
  }

 private void tryToShutDown() throws DeviceShutDownError{
   DeviceHandle handle =getHandle(DEV1);
   retrieveDeviceRecord(handle);
   pauseDevice(handle);
   clearDeviceWorkQueue(handle);
   closeDevice(handle);
 }

 private DeviceHandle getHandle(DeviceID id){
              // 省略業(yè)務(wù)邏輯
  throw new DeviceShutDownError("Invalid handle for:"+id.tostring()); 
 }
}

4.5、怎樣寫出這樣的函數(shù)?

關(guān)于2的解釋: 單測與生產(chǎn)代碼同步進(jìn)行，寫到一個不可編譯的單測就開始寫生產(chǎn)代碼，如此反復(fù)循環(huán)，單測就能包含到所有生產(chǎn)代碼。

5.2、FIRST原則

FIRST 原則就是一個指導(dǎo)編寫單元測試的原則
fast 快速 單測執(zhí)行應(yīng)該快速的完成
independent 獨立 單測之間相互獨立
repeatable 可重復(fù) 單測不依賴于環(huán)境，隨處可運行
self validating 程序可通過輸出的Boolean自我驗證，而不需要通過人工的方式驗證（看日志輸出、對比兩個文件不同等）
timely 及時 單測在生產(chǎn)代碼之前編寫

單元測試是代碼測試中的基礎(chǔ)測試，F(xiàn)IRST是寫好單元測試的重要原則，它要求我們的單元測試快速，獨立，可重復(fù)，自我校驗，及時/完整。

5.3、測試代碼模式

開發(fā)測試代碼可以使用given-when-then模式
given 制造模擬數(shù)據(jù)
when 執(zhí)行測試代碼
then 驗證測試結(jié)果

代碼示例

/**
  * If an item is loaded from the repository, the name of that item should 
  * be transformed into uppercase.
  */
@Test
public void shouldReturnItemNameInUpperCase() {
 
    // Given
    Item mockedItem = new Item("it1", "Item 1", "This is item 1", 2000, true);
    when(itemRepository.findById("it1")).thenReturn(mockedItem);
 
    // When
    String result = itemService.getItemNameUpperCase("it1");
 
    // Then
    verify(itemRepository, times(1)).findById("it1");
    assertThat(result, is("ITEM 1"));
}

使用give-when-then 模式可提高測試代碼的可讀性.

5.4、自動生成單測

介紹兩款I(lǐng)DEA自動生成單測的插件

• Squaretest插件（收費）

• TestMe插件(免費)

6、結(jié)束語