主頁 > 軟體工程 > 不要讓“Clean Code”更難維護,請使用“Rule of Three”

不要讓“Clean Code”更難維護,請使用“Rule of Three”

2022-08-25 08:33:25 軟體工程

“我們如何證明,通過遵循“代碼整潔之道”(Clean Code)就可以撰寫更多的代碼呢?”

當人們試圖將“代碼整潔之道(Clean Code)”的原則應用于現有的代碼庫時,我經常會問這個問題,

我認為這是合情合理的,

當我們開始重構遺留代碼時,通常會將內容提取到較小的方法中,然后再將方法提取到類中,很快,我們可能就能感覺到原來 30 行的方法現在已經分散在不同的類中,

我們想知道的是:這在實際上是否是更容易維護了呢,

也許我們是一個小團隊,也許我們必須支持我們繼承的一個相對較大(并且沒有檔案記錄的)的代碼庫,

尋求代碼可維護性是一件好事,

錯誤在于,認為代碼可維護性與代碼行數(lines of code,LOC)相關,LOC 可能是一個有趣的度量指標,但它并不是關鍵所在!

不要使用 LOC 作為代碼可維護性的度量指標,

 

簡短的代碼并沒有更好的可讀性

如果你對此有所懷疑,那么應該看看“短碼之美(Code Golf )”,

當我們進行“短碼競賽”時,我們的目標是找到一些聰明的技巧,用最少的代碼字符來實作相同的功能:

// 31 個字符  
Math.floor(Math.random() * 100)

// 21 個字符 
~~(Math.random()*100)

// 19 個字符 
Math.random()*100|0

但當然,這只是一個“strawman”的論點!

我相信我們不會以“短碼競賽”的方式來撰寫生產中的代碼,

然而,有一個重要的原則,我們需要記住:

代碼不是我們告訴計算機怎么做的方式;而是告訴另一個程式員我們想要計算機做什么的方式,

簡而言之:撰寫代碼是要供他人閱讀的,

易于理解的代碼才是易于維護的代碼,

還是,難道我們還不夠聰明,而無法閱讀冗長的函式嗎?出于可讀性的考慮,添加一堆一次性使用的助手函式又有什么好處呢?

如果這些問題能引起我們的共鳴,那么我們需要知道一個秘密……

 

過早的重構是專案失敗的根源

任何極端的做法都是有害的,

即使是遵循“代碼整潔之道”的原則,

我們正在嘗試一些事情,當然,我們可以按照最佳實踐來重構代碼,但這同時也會增加了維護的難度,如果我們為了達到此目的而只是封裝了一個條件陳述句,那么它可能沒有幫助!

不,我們不應該為了可讀性,而將所有內容都提取到“一次性助手函式”中,如果我們每次閱讀代碼時都需要閱讀這些函式的主體,那么這一點也沒有幫助,它只會是阻礙,

我們應該做的是,創建正確的抽象,

正確的抽象,正確地劃分職責,它們闡明了代碼的意圖,它們可以防止代碼重復,

當我們找到正確的抽象時,我們會覺得這 4 個類實際上比原來的 30 行代碼更易于維護,

但是,要找到正確的抽象確實很困難,因此,這就是我們應該關注的重點,

 

壞的抽象比重復更糟糕

你是否聽說過“不要重復你自己(Don’t Repeat Yourself,DRY)”原則?

這是一顆共同發展智慧的明珠,而且非常有效,但它也經常被誤解,

兩段代碼看起來是一樣的,但卻代表了不同的概念,不同的抽象,在這種情況下,重復是偶然的,保留重復會更好,

“重復與錯誤的抽象相比,代價要小的多”—— Sandi Metz, 所有的小事

什么時候應該將代碼提取到函式 / 方法 / 類中?什么時候應該保留重復?我們怎么知道我們有正確的抽象呢?

    使用“Rule of Three”

Also called Write Everything Twice (WET). Pun intended.

這也稱為“什么都寫兩遍(Everything Twice,WET)”,這是個雙關語(與 DRY 原則相對),

“三次重復攻擊,就重構”

重構原則“Rule of Three”是一條經驗規則,當我們有疑問時可以使用它,

在引入抽象之前,請等待第三次重復的出現,出現重復的次數越多,就越容易找到要提取的共性,

遵循“Rule of Three”原則,它能使我們更容易地找到正確的抽象,

 

超越“Rule of Three”

這里的“Rule of Three”原則是為了提醒我們,重復是可以的,

這也有點教條,就像“代碼整潔之道”的原則一樣,不要在任何時候都盲目地 100% 應用它,

有時,即使出現了 3 次重復,我們也可能找不到正確的抽象,不要強求對代碼庫進行過度的抽象,如果我們不能給它起一個清晰的名字,它就確實不夠清晰,

毫無疑問,違反規則是可以的,等待更多的重復,

寧可重復,也不要錯誤的抽象,不要為了抽象而創建抽象,

如果抽象不好,則必須使用布爾型的引數和 if 陳述句來簡化它的實作,以覆寫新的用例,這只是一種暗示、一種警告,告訴你你走錯了方向,

如果我們還沒有找到抽象的話,那也沒關系,當我們有了更多的背景關系時,仍可以重構它,等著瞧吧!

 

作者丨Nicolas Carlo

 

本文來自博客園,作者:古道輕風,轉載請注明原文鏈接:https://www.cnblogs.com/88223100/p/Rule-of-Three.html

轉載請註明出處,本文鏈接:https://www.uj5u.com/gongcheng/502668.html

標籤:其他

上一篇:4種常見分支模式決議及優劣對比

下一篇:20 年老程式員告訴你的 20 條編碼原則

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • Git本地庫既關聯GitHub又關聯Gitee

    創建代碼倉庫 使用gitee舉例(github和gitee差不多) 1.在gitee右上角點擊+,選擇新建倉庫 ? 2.選擇填寫倉庫資訊,然后進行創建 ? 3.服務端已經準備好了,本地開始作準備 (1)Git 全域設定 git config --global user.name "成鈺" git c ......

    uj5u.com 2020-09-10 05:04:14 more
  • CODING DevOps 代碼質量實戰系列第二課,相約周三

    隨著 ToB(企業服務)的興起和 ToC(消費互聯網)產品進入成熟期,線上故障帶來的損失越來越大,代碼質量越來越重要,而「質量內建」正是 DevOps 核心理念之一。**《DevOps 代碼質量實戰(PHP 版)》**為 CODING DevOps 代碼質量實戰系列的第二課,同時也是本系列的 PHP ......

    uj5u.com 2020-09-10 05:07:43 more
  • 推薦Scrum書籍

    推薦Scrum書籍 直接上干貨,推薦書籍清單如下(推薦有順序的哦) Scrum指南 Scrum精髓 Scrum敏捷軟體開發 Scrum捷徑 硝煙中的Scrum和XP : 我們如何實施Scrum 敏捷軟體開發:Scrum實戰指南 Scrum要素 大規模Scrum:大規模敏捷組織的設計 用戶故事地圖 用 ......

    uj5u.com 2020-09-10 05:07:45 more
  • CODING DevOps 代碼質量實戰系列最后一課,周四發車

    隨著 ToB(企業服務)的興起和 ToC(消費互聯網)產品進入成熟期,線上故障帶來的損失越來越大,代碼質量越來越重要,而「質量內建」正是 DevOps 核心理念之一。 **《DevOps 代碼質量實戰(Java 版)》**為 CODING DevOps 代碼質量實戰系列的最后一課,同時也是本系列的 ......

    uj5u.com 2020-09-10 05:07:52 more
  • 敏捷軟體工程實踐書籍

    Scrum轉型想要做好,第一步先了解并真正落實Scrum,那么我推薦的Scrum書籍是要看懂并實踐的。第二步是團隊的工程實踐要做扎實。 下面推薦工程實踐書單: 重構:改善既有代碼的設計 決議極限編程 : 擁抱變化 代碼整潔代碼 程式員的職業素養 修改代碼的藝術 撰寫可讀代碼的藝術 測驗驅動開發 : ......

    uj5u.com 2020-09-10 05:07:55 more
  • Jenkins+svn+nginx實作windows環境自動部署vue前端專案

    前面文章介紹了Jenkins+svn+tomcat實作自動化部署,現在終于有空抽時間出來寫下Jenkins+svn+nginx實作自動部署vue前端專案。 jenkins的安裝和配置已經在前面文章進行介紹,下面介紹實作vue前端專案需要進行的哪些額外的步驟。 注意:在安裝jenkins和nginx的 ......

    uj5u.com 2020-09-10 05:08:49 more
  • CODING DevOps 微服務專案實戰系列第一課,明天等你

    CODING DevOps 微服務專案實戰系列第一課**《DevOps 微服務專案實戰:DevOps 初體驗》**將由 CODING DevOps 開發工程師 王寬老師 向大家介紹 DevOps 的基本理念,并探討為什么現代開發活動需要 DevOps,同時將以 eShopOnContainers 項 ......

    uj5u.com 2020-09-10 05:09:14 more
  • CODING DevOps 微服務專案實戰系列第二課來啦!

    近年來,工程專案的結構越來越復雜,需要接入合適的持續集成流水線形式,才能滿足更多變的需求,那么如何優雅地使用 CI 能力提升生產效率呢?CODING DevOps 微服務專案實戰系列第二課 《DevOps 微服務專案實戰:CI 進階用法》 將由 CODING DevOps 全堆疊工程師 何晨哲老師 向 ......

    uj5u.com 2020-09-10 05:09:33 more
  • CODING DevOps 微服務專案實戰系列最后一課,周四開講!

    隨著軟體工程越來越復雜化,如何在 Kubernetes 集群進行灰度發布成為了生產部署的”必修課“,而如何實作安全可控、自動化的灰度發布也成為了持續部署重點關注的問題。CODING DevOps 微服務專案實戰系列最后一課:**《DevOps 微服務專案實戰:基于 Nginx-ingress 的自動 ......

    uj5u.com 2020-09-10 05:10:00 more
  • CODING 儀表盤功能正式推出,實作作業資料可視化!

    CODING 儀表盤功能現已正式推出!該功能旨在用一張張統計卡片的形式,統計并展示使用 CODING 中所產生的資料。這意味著無需額外的設定,就可以收集歸納寶貴的作業資料并予之量化分析。這些海量的資料皆會以圖表或串列的方式躍然紙上,方便團隊成員隨時查看各專案的進度、狀態和指標,云端協作迎來真正意義上 ......

    uj5u.com 2020-09-10 05:11:01 more
最新发布
  • windows系統git使用ssh方式和gitee/github進行同步

    使用git來clone專案有兩種方式:HTTPS和SSH:
    HTTPS:不管是誰,拿到url隨便clone,但是在push的時候需要驗證用戶名和密碼;
    SSH:clone的專案你必須是擁有者或者管理員,而且需要在clone前添加SSH Key。SSH 在push的時候,是不需要輸入用戶名的,如果配置... ......

    uj5u.com 2023-04-19 08:41:12 more
  • windows系統git使用ssh方式和gitee/github進行同步

    使用git來clone專案有兩種方式:HTTPS和SSH:
    HTTPS:不管是誰,拿到url隨便clone,但是在push的時候需要驗證用戶名和密碼;
    SSH:clone的專案你必須是擁有者或者管理員,而且需要在clone前添加SSH Key。SSH 在push的時候,是不需要輸入用戶名的,如果配置... ......

    uj5u.com 2023-04-19 08:35:34 more
  • 2023年農牧行業6大CRM系統、5大場景盤點

    在物聯網、大資料、云計算、人工智能、自動化技術等現代資訊技術蓬勃發展與逐步成熟的背景下,數字化正成為農牧行業供給側結構性變革與高質量發展的核心驅動因素。因此,改造和提升傳統農牧業、開拓創新現代智慧農牧業,加快推進農牧業的現代化、資訊化、數字化建設已成為農牧業發展的重要方向。 當下,企業數字化轉型已經 ......

    uj5u.com 2023-04-18 08:05:44 more
  • 2023年農牧行業6大CRM系統、5大場景盤點

    在物聯網、大資料、云計算、人工智能、自動化技術等現代資訊技術蓬勃發展與逐步成熟的背景下,數字化正成為農牧行業供給側結構性變革與高質量發展的核心驅動因素。因此,改造和提升傳統農牧業、開拓創新現代智慧農牧業,加快推進農牧業的現代化、資訊化、數字化建設已成為農牧業發展的重要方向。 當下,企業數字化轉型已經 ......

    uj5u.com 2023-04-18 08:00:18 more
  • 計算機組成原理—存盤器

    計算機組成原理—硬體結構 二、存盤器 1.概述 存盤器是計算機系統中的記憶設備,用來存放程式和資料 1.1存盤器的層次結構 快取-主存層次主要解決CPU和主存速度不匹配的問題,速度接近快取 主存-輔存層次主要解決存盤系統的容量問題,容量接近與價位接近于主存 2.主存盤器 2.1概述 主存與CPU的聯 ......

    uj5u.com 2023-04-17 08:20:31 more
  • 談一談我對協同開發的一些認識

    如今各互聯網公司普通都使用敏捷開發,采用小步快跑的形式來進行專案開發。如果是小專案或者小需求,那一個開發可能就搞定了。但對于電商等復雜的系統,其功能多,結構復雜,一個人肯定是搞不定的,所以都是很多人來共同開發維護。以我曾經待過的商城團隊為例,光是后端開發就有七十多人。 為了更好地開發這類大型系統,往 ......

    uj5u.com 2023-04-17 08:18:55 more
  • 專案管理PRINCE2核心知識點整理

    PRINCE2,即 PRoject IN Controlled Environment(受控環境中的專案)是一種結構化的專案管理方法論,由英國政府內閣商務部(OGC)推出,是英國專案管理標準。
    PRINCE2 作為一種開放的方法論,是一套結構化的專案管理流程,描述了如何以一種邏輯性的、有組織的方法,... ......

    uj5u.com 2023-04-17 08:18:51 more
  • 談一談我對協同開發的一些認識

    如今各互聯網公司普通都使用敏捷開發,采用小步快跑的形式來進行專案開發。如果是小專案或者小需求,那一個開發可能就搞定了。但對于電商等復雜的系統,其功能多,結構復雜,一個人肯定是搞不定的,所以都是很多人來共同開發維護。以我曾經待過的商城團隊為例,光是后端開發就有七十多人。 為了更好地開發這類大型系統,往 ......

    uj5u.com 2023-04-17 08:18:00 more
  • 專案管理PRINCE2核心知識點整理

    PRINCE2,即 PRoject IN Controlled Environment(受控環境中的專案)是一種結構化的專案管理方法論,由英國政府內閣商務部(OGC)推出,是英國專案管理標準。
    PRINCE2 作為一種開放的方法論,是一套結構化的專案管理流程,描述了如何以一種邏輯性的、有組織的方法,... ......

    uj5u.com 2023-04-17 08:17:55 more
  • 計算機組成原理—存盤器

    計算機組成原理—硬體結構 二、存盤器 1.概述 存盤器是計算機系統中的記憶設備,用來存放程式和資料 1.1存盤器的層次結構 快取-主存層次主要解決CPU和主存速度不匹配的問題,速度接近快取 主存-輔存層次主要解決存盤系統的容量問題,容量接近與價位接近于主存 2.主存盤器 2.1概述 主存與CPU的聯 ......

    uj5u.com 2023-04-17 08:12:06 more