公司新來了個同事，代碼寫得是真優雅呀！代碼如詩！

来源:https://www.cnblogs.com/javastack/archive/2023/10/25/17786356.html
-Advertisement-
Play Games

來源：https://www.cnblogs.com/liuboren/p/17017421.html 0.前言 本篇文章是<<代碼整潔之道>>的學習總結, 通過這篇文章你將瞭解到整潔的代碼對項目、公司和你的重要性,以及如何書寫整潔的代碼. 通過命名、類、函數、測試這四個章節,使我們的代碼變得整潔. ...


來源：https://www.cnblogs.com/liuboren/p/17017421.html

0.前言

本篇文章是<<代碼整潔之道>>的學習總結, 通過這篇文章你將瞭解到整潔的代碼對項目、公司和你的重要性,以及如何書寫整潔的代碼.

通過命名、類、函數、測試這四個章節,使我們的代碼變得整潔.

1.為什麼要保持代碼整潔?

不整潔的代碼隨著時間的增加而增加時,生產力會隨之降低.
導致的結果就是:

  • 代碼不易擴展或擴展容易引發其他問題
  • 程式崩潰
  • 加班
  • 增加公司成本(加人)
  • 甚至可能造成公司倒閉

一圖勝千言

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

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

later equal never

想想是不是這個道理,你有多少以後再說、以後再改的東西都拋諸腦後了.

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

推薦一個開源免費的 Spring Boot 實戰項目：

https://github.com/javastacks/spring-boot-best-practice

1.2 如何寫出整潔的代碼?

那麼現在的問題就是,怎樣的代碼才算是整潔的代碼呢:

  • 可讀性要高: 代碼要像散文一樣優雅易讀,見碼知意
  • 拒絕重覆代碼
  • 滿足設計模式原則
    • 單一職責
    • 開閉原則
    • 里氏替換原則
    • 依賴倒轉原則
    • 介面隔離原則
    • 迪米特法則
    • 合成復用法則

2.命名

好的命名可提高代碼的可讀性,讓人見碼知意, 降低理解成本,提高效率, 減少加班.

2.1 不好的命名方式

  1. 沒有任何意義的命名方式
public interface Animal {
    void abc();
}

現在我們有一個動物的介面, 裡面有一個方法abc(),看了讓人一頭霧水, 調用這個方法的人也完全不知道這個方法是乾什麼的,因為他的命名毫無意義

有意義的命名方式:

public interface Animal {
    void cry();
}

我們將方法名命名為cry(喊叫,呼喊),調用的人就知道這個方法的作用是什麼了.

所以命名一定要有意義且讓人見碼知意.

  1. 命名前後不一致
    這種情況體現在明明是同一行為,但是卻有不同的命名,前後不一致,讓人造成混淆.
public interface StudentRepository extends JpaRepository<AlertAll, String> {
    Student findOneById(
            @Param("id") String id
    );

    List<Student> queryAllStudent(
    );

}

上面兩個方法都是查詢xxx, 但是命名一會叫query一會叫find,這種情況應該加以規範,保持一致, 修改後:

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

    List<Student> findAll(
    );

}
  1. 命名冗餘
    體現在命名有很多沒必要的成分在裡面, 並且這些"廢話"並不能幫助區分它們的區別, 例如在變數命名中添加了Variable這個詞, 在表名中添加了Table這個詞.

所以命名中不要出現冗餘的單詞, 並且提前約定好命名的規範.

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

3.類

整潔的類應滿足一下內容:

  • 單一職責
  • 開閉原則
  • 高內聚性

3.1單一職責

類應該短小,類或模塊應有且只有一條加以修改的理由, 如果一個類過於龐大的話,那麼說明它承擔的職責過多了.

優點:

  • 降低類的複雜度
  • 提高類的可讀性
  • 提高系統的可維護性
  • 降低變更引起的風險

如何判定類是否足夠短小?
通過計算類的職責來判斷是否夠短小,類的名稱描述其全責, 如果無法為某個類命以準確的名稱, 這個類大概就太長了, 類名越含糊,可能擁有越多的職責.

職責過多的例子,可以看到以下類有兩個職責:

public abstract class Sql {
    // 操作SQL的職責
    public abstract void insert();


    // 統計SQL操作的職責
    public abstract void countInsert();

}

將統計的職責抽取到另一個類

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();
}

如果我們現在要新增查詢的操作,就需要修改Sql這個類,沒有做到面向修改關閉

重構後:

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


}

public class CreateSql extends Sql {

    @java.lang.Override
    public void generate() {
        // 省略實現
    }
}


public class UpdateSql extends Sql {

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

當我們要增加刪除方法時可以很容易的擴展.

使用大量的短小的類看似比使用少量龐大的類增加了工作量(增加了更多的類),但是真的是這樣嗎? 這裡有一個很好的類比:

你是想把工具歸置到有許多抽屜、每個抽屜中裝有定義和標記良好的組件的工具箱呢, 還是想要少數幾個能隨便吧所有東西扔進去的抽屜?

最終的結論:

系統應該由許多短小的類而不是少量巨大的類組成,每個小類封裝一個權責,只有一個修改的原因,並與少數其他類一起協同達成期望的系統行為.

3.3 內聚

方法操作的變數越多,就約粘聚到類上. 如果一個類中的每個變數都被每個方法所使用, 則該類具有最大的內聚性.
我們應該將類的內聚性保持在較高的位置. 內聚性高意味著方法和變數互相依賴, 互相結合成一個邏輯整體.

為什麼要保持高內聚?
保持內聚性就會得到許多短小的類,就越滿足單一職責.

內聚性低怎麼辦?
如果類的內聚性就不夠高,就將原有的類拆分為新的類和方法.

4.函數

要想讓函數變得整潔,應保證:

  • 只做一件事
  • 好的命名
  • 整潔的參數
  • 註意返回內容

4.1 只做一件事

what?
函數的第一規則是短小 第二規則是更短小 短小到只做一件事情. (沒錯和類的原則很像)

why?
函數越短小,越能滿足單一職責.

how?
以下是重構前的代碼, 這個方法有三個職責,並且該方法很長達到了80+50+5 = 135行

public class PicService {

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

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

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

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

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

而裡面的每個方法,也都有著自己各自的職責(校驗圖片 、壓縮圖片 、返回結果).

4.2 函數命名

  1. 函數名應見名知意
    函數擁有描述性的名稱，不要害怕長名稱.

不好的命名方式:

public String addCharacter(String originString, char ch);

　這個函數，一咋看，還不錯，從函數字面意思看是給某個字元串添加一個字元。但是到底是在原有字元串首部添加，還是在原有字元串末尾追加呢？亦或是在某個固定位置插入呢？從函數名字完全看不出來這個函數的真正意圖，只能繼續往下讀這個函數的具體實現才知道。

而下麵這幾個名字就比上面要好得多：

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

// 插入指定位置
public String insertCharacter(String originString, char ch, int insertPosition);
  1. 函數應該無副作用
    函數應該無副作用， 意思就是函數應該只做一件事，但是做這件事的時候做了另一件有副作用的事情.

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

4.3 參數

  1. 參數越少越好
    參數越少，越容易理解，參數超過三個可以將參數進行封裝，要按參數的語義進行封裝，不一定封裝成一個大而全的參數，可以封裝為多個，原則是按語義補充;

示例:

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

//封裝參數
public List<Student> findStudent(Student student);
  1. 不要使用標識參數
    標識參數是參數為Boolean 類型, 用戶傳遞true or false . 不要使用標識參數因為這意味著你的函數違背了單一職責(true false 兩套邏輯).

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

//標識參數方法
render(Boolean isSuite);

//重構為兩個方法
reanderForSuite();
renderForSingleTest();
  1. 不要使用輸出參數

什麼是輸出參數?

將變數作為參數傳入方法,並且將變數輸出, 這就是輸出參數

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

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

為什麼不應該有輸出參數?
因為增加了理解成本在裡面,我們需要查看doSomething到底對student 做了什麼. student是輸入還是輸出參數? 都不明確.

重構:

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

4.4 返回值

  1. 分離指令與訊問
    示例代碼:
Pulic Boolean addElement(Element element)

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

這樣做的壞處是職責不單一，所以應該拆分為兩個方法

public void addElement(Element element);
public Boolean isAdd(Element element);
  1. 使用異常替代返回錯誤碼
    直接拋出異常,而不是返回錯誤碼進行判斷, 可以使代碼更簡潔. 因為使用錯誤碼有可能會進行多層嵌套片段

代碼示例:

// 使用錯誤碼導致多層嵌套...
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()); 
	}
}

重構後:

//  將代碼拆分為一小段一小段, 降低複雜度,更加清晰
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){
              // 省略業務邏輯
		throw new DeviceShutDownError("Invalid handle for:"+id.tostring()); 
	}
}

4.5 怎樣寫出這樣的函數?

沒人能一開始就寫出完美的代碼, 先寫出滿足功能的代碼,之後緊接著進行重構

為什麼是緊接著?
因為later equal never!

4.6 代碼質量掃描工具

使用SonarLint可以幫助我們發現代碼的問題,並且還提供了相應的解決方案.
對於每一個問題，SonarLint都給出了示例，還有相應的解決方案，教我們怎麼修改，極大的方便了我們的開發
比如，對於日期類型儘量用LocalDate、LocalTime、LocalDateTime，還有重覆代碼、潛在的空指針異常、迴圈嵌套等等問題
有了代碼規範與質量檢測工具以後，很多東西就可以量化了，比如bug率、代碼重覆率等.

5.測試

測試很重要,可以幫助我們驗證寫的代碼是否沒問題,同樣的測試代碼也應該保持整潔.

5.1 TDD

TDD是測試驅動開發（Test-Driven Development），是敏捷開發中的一項核心實踐和技術，也是一種設計方法論

優點：在任意一個開發節點都可以拿出一個可以使用，含少量bug並具一定功能和能夠發佈的產品。
缺點：增加代碼量。測試代碼是系統代碼的兩倍或更多，但是同時節省了調試程式及挑錯時間。

how?
1.在開發代碼前先寫測試
2.只可編寫剛好無法通過的單元測試，不能編譯也算不通過
3.開發代碼不可超過測試

關於2的解釋: 單測與生產代碼同步進行，寫到一個不可編譯的單測就開始寫生產代碼，如此反覆迴圈，單測就能包含到所有生產代碼。

5.2 FIRST原則

FIRST 原則就是一個指導編寫單元測試的原則
fast 快速 單測執行應該快速的完成
independent 獨立 單測之間相互獨立
repeatable 可重覆 單測不依賴於環境，隨處可運行
self validating 程式可通過輸出的Boolean自我驗證，而不需要通過人工的方式驗證（看日誌輸出、對比兩個文件不同等）
timely 及時 單測在生產代碼之前編寫

單元測試是代碼測試中的基礎測試，FIRST是寫好單元測試的重要原則，它要求我們的單元測試快速，獨立，可重覆，自我校驗，及時/完整。

5.3 測試代碼模式

開發測試代碼可以使用given-when-then模式
given 製造模擬數據
when 執行測試代碼
then 驗證測試結果

代碼示例

/**
  * 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 自動生成單測

介紹兩款IDEA自動生成單測的插件

  • Squaretest插件（收費）
  • TestMe插件(免費)

參考資料：

書籍: <<代碼整潔之道>>

https://www.cnblogs.com/sunny3158/p/16353643.html

https://blog.csdn.net/qq_42289636/article/details/108762981

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆！Java 協程要來了。。。

3.Spring Boot 2.x 教程，太全了！

4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！

5.《Java開發手冊（嵩山版）》最新發佈，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • SpringBoot自動配置原理解析
    在以前單獨使用SpringMVC Web編程框架時，我們需要單獨配置_DispatcherServlet和Tomcat，使用SpringBoot之後，我們只需要引入SpringBoot-Starter-Web就能直接開始編寫Controller等Web相關的代碼，這就是SpringBoot為們提供的... ...
  • 21.2 Python 使用Scapy實現埠探測
    Scapy 是一款使用純Python編寫的跨平臺網路數據包操控工具，它能夠處理和嗅探各種網路數據包。能夠很容易的創建，發送，捕獲，分析和操作網路數據包，包括TCP，UDP，ICMP等協議，此外它還提供了許多有用的功能，例如嗅探網路流量，創建自定義協議和攻擊網路的安全測試工具。使用Scapy可以通過P... ...
  • 開源物流管理系統——【1】菜單整理
    寫開源項目的想法由來已久，先前也做過嘗試，通過插件模式開發的WPF許可權控制框架。然而一直沒有堅持下來，主要有兩方面的原因：一是時間有限，對基礎開發框架也不感冒，畢竟社區裡面已經有不少了；二是走產品路線的話，除了需要瞭解業務，編碼需要更多的時間投入。 但當瞭解到Odoo這樣的低代碼平臺後，我想情況就會 ...
  • python往圖片上面添加數字
    需求背景：做倒計時圖片； 實現思路：先準備好一張圖片作為背景圖，用python往圖片上添加天數，保存圖片；從0-69天，一共生成70張圖片 背景圖如圖： 代碼如下： # 這個程式用來生成70張倒計時圖片 from PIL import Image, ImageDraw, ImageFont for ...
  • Registration Authority 簡介
    RA 功能簡介 在公共密鑰基礎設施（PKI）中，CA（Certificate Authority，證書頒發機構）系統的RA（Registration Authority，註冊機構）是PKI體繫結構的重要組成部分。RA在CA系統中扮演著關鍵角色，負責處理用戶的身份驗證和註冊請求，然後將這些請求傳遞給C ...
  • Go命令大全：全面解析與實踐
    本文詳盡地探討了Go語言的內建命令集，包括但不限於go build、go run、go get等。文章首先列舉了所有常用的Go命令，並用表格形式簡潔地解釋了它們的功能。隨後，我們逐一深入講解了每個命令的使用說明、應用場景，以及實際操作中可能遇到的輸出結果。 關註【TechLeadCloud】，分享互 ...
  • Java服務總在半夜掛，背後的真相竟然是...
    最近有用戶反饋測試環境Java服務總在凌晨00:00左右掛掉，用戶反饋Java服務沒有定時任務，也沒有流量突增的情況，Jvm配置也合理，莫名其妙就掛了 ...
  • 3種方法，用Java找出兩個List中的重覆元素
    在Java編程中，我們經常需要找出兩個列表（List）中的重覆元素。在本文中，我們將探討三種方法來實現這一目標。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類