主頁 > 軟體工程 > 代碼整潔之道

代碼整潔之道

2021-09-16 07:39:36 軟體工程

軟體質量不但依賴于架構及專案管理,還與代碼質量緊密相關,

代碼質量與整潔度成正比,干凈的代碼即在質量上較為可靠,也為后期維護、升級奠定良好基礎,

另一種概念叫做極限編程

原則

  • SOLID
  • DRY
  • KISS

童子軍軍規

讓營地比你來時更干凈

有意義的命名

  • 名副其實,表達真實意義
  • 不誤導
  • 做有意義的區分,避免 a、b、c
  • 可讀、可搜索

函式

  • 單一職責
  • 行數 20-100

函式引數

  • 0引數最佳,3個引數已經勉為其難
  • 標識引數丑陋不堪,向引數傳入布林值駭人聽聞
  • 如果函式需要三個以上的引數,說明這些引數應該封裝為類了
Circle makeCircle(double x,double y,double radius);
Circle makeCircle(Point center,double radius);
class Foo {
    public function bar($flag = true) {
    }

無副作用

函式承諾只做一件事,實際上還做了其他的,

public class UserValidator {
private Cryptographer cryptographer;

public boolean checkPassword(String userName, String password){
    User user = UserGateway.findByName(userName) ;
    if (user != User.NULL) {
    String codedPhrase = user.getPhraseEncodedByPassword();
    String phrase = cryptographer.decrypt (codedPhrase,password );
    if("Valid Password".equals(phrase)){
    Session.initialize(); //實際上還做了session 初始化的操作
    return true;
    }
    return false;
}

要么抽離Session.initialize(),要么重命名為checkPasswordAndInitializeSession 不要給人誤導,

使用例外代替錯誤碼

使用錯誤碼就要定義錯誤碼列舉,列舉類被大量匯入呼叫,一旦增加或修改錯誤列舉,就要對所有引入的檔案進行編譯,

 if (deletePage(page)==E_OK){
        if (registry.deleteReference(page.name)==E_OK){
            if (configKeys.deleteKey(page.name.makeKey())==E_OK){
            logger.log("page deleted");
        } else {
            logger.log("configKey not deleted");
        } else {
            logger. log("deleteReference from registry failed");
        } else {
            logger.log("delete failed");
        }
      return E_ERROR;
    }
try {
    deletePage(page);
    registry.deleteReference(page.name);
    configKeys.deleteKey(page.name.makeKey());
}
catch (Exception e) {
    logger.log(e.getMessage());
}

注釋

注釋并不像辛德勒的名單,它們并不“純然地好”,實際上,注釋最多也就是一種必須的惡,若編程語言足夠有表達力,或者我們長于用這些語言來表達意圖,就不那么需要注釋——也許根本不需要,

注釋掉的代碼

20世紀60年代,曾經有那么一段時間,注釋掉的代碼可能有用,但我們已經擁有優良的源代碼控制系統如此之久,這些系統可以為我們記住不要的代碼,我們無需再用注釋來標記,刪掉即可,它們丟不了,我擔保,

格式

檔案長度

200-500

行字符數

上限120

物件和資料結構

德莫特定律

著名的得墨式耳律(The Law of Demeter)認為,模塊不應了解它所操作物件的內部形,如上節所見,物件隱藏資料,曝露操作,這意味著物件不應通過存取器曝露其內部結構
因為這樣更像是曝露而非隱藏其內部結構,
更準確地說,得墨式耳律認為,類C的方法f只應該呼叫以下物件的方法:

  • C
  • 由f創建的物件;
  • 作為引數傳遞給f的物件;
  • 由C的物體變數持有的物件,

null

  • 別傳null值
  • 別回傳null值

系統

“復雜要人命,它消磨開發者的生命,讓產品難以規劃、構建和測驗,”
——Ray Ozzie,微軟公司首席技術官

依賴注入

在依賴管理情景中,物件不應負責物體化對自身的依賴,反之,它應當將這份權責移交給其他“有權力”的機制,從而實作控制的反轉,因為初始設定是一種全域問題,這種授權機制通常要么是main例程,要么是有特定目的的容器,

擴容

“一開始就做對系統”純屬神話,

代理

AOP有時會與實作它的技術相混淆,例如方法攔截和通過代理做的“封包”,AOP系統的真正價值在于用簡潔和模塊化的方式指定系統行為,

并發編程

并發編程很難,非常難,如果你不那么細
心,就會搞出不堪入目的東西來,看看以下常見的迷思和誤解:

  • 并發總能改進性能
    并發有時能改進性能,但只在多個執行緒或處理器之間能分享大量等待時間的時候管用,
    事情沒那么簡單,

  • 撰寫并發程式無需修改設計
    事實上,并發演算法的設計有可能與單執行緒系統的設計極不相同,目的與時機的解藕往往對系統結構產生巨大影響,

  • 在采用Web或EJB容器的時候,理解并發問題并不重要
    實際上,你最好了解容器在做什么,了解如何對付本章后文將提到的并發更新、死鎖等問題,

下面是一些有關撰寫并發軟體的中肯說法:

  • 并發會在性能和撰寫額外代碼上增加一些開銷;
  • 正確的并發是復雜的,即便對于簡單的問題也是如此;
    并發缺陷并非總能重現,所以常被看做偶發事件而忽略,未被當做真的缺陷看待;
  • 并發常常需要對設計策略的根本性修改,

味道建議

命名常量代替魔術數

準確

  • 用浮點數表示貨幣幾近于犯罪,
  • 因為你不想做并發更新就避免使用鎖和/或事務管理往好處說也是一種懶惰行為,在代碼中做決定時,確認自己足夠準確,
  • 明確自己為何要這么做,如果遇到例外情況如何處理,
  • 別懶得理會決定的準確性,如果你打算呼叫可能回傳null的函式,確認自己檢查了null值,
  • 如果查詢你認為是資料庫中唯一的記錄,確保代碼檢查不存在其他記錄,
  • 如果要處理貨幣資料,使用整數!并恰當地處理四舍五入,
  • 如果可能有并發更新,確認你實作了某種鎖定機制,
  • 代碼中的含糊和不準確要么是意見不同的結果,要么源于懶惰,無論原因是什么,都要消除,

回傳例外

   /**
     * 
     * @param array $awbnos
     * @throws Exception|ConnectionTimeOutException
     * @return array Description
     */
    public function fetchTrace(array $awbnos):array
    {
    }

php 利用 phpdoc 和 php7 特性能支持讓呼叫者注意例外和回傳值的正確處理,

 public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception{
 }

java 函式定義語法天生支持,

避免過多嵌套

基本法

  • 單一職責,貫徹落實
  • 短、少,類1000行,方法120行,引數3個,嚴格要求,
  • 消滅mess,有1個就會有無數個
  • Later equals never 稍后等于永不,別等現在就去做
  • 打磨,分解函式、修改名稱、消除重復,縮短和重新安置方法,有拆散類,同時保持測驗通過,保持重構、熱愛重構、注意單元測驗回歸測驗

推薦閱讀

  1. 《Clean Code》
  2. http://kaelzhang81.github.io/2020/04/10/譯-設計高質量軟體/

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

標籤:其他

上一篇:代碼整潔之道

下一篇:????用最簡單的方法在Webstorm中打開已存在專案 和 新建Vue專案 (親測實用)????

標籤雲
其他(123570) Java(13369) Python(12731) C(7545) 區塊鏈(7372) JavaScript(7059) 基礎類(6313) AI(6244) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4120) MySQL(4012) Linux(3394) C語言(3288) C++語言(3117) Java相關(2746) 疑難問題(2699) 單片機工控(2479) Web開發(1951) 網絡通信(1793) 數據庫相關(1767) VB基礎類(1755) PHP(1727) 開發(1646) 系統維護與使用區(1617) .NETCore(1586) 基礎和管理(1579) JavaEE(1566) C++(1527) 專題技術討論區(1515) Windows客戶端使用(1484) HtmlCss(1466) ASP.NET(1428) Unity3D(1354) VCL組件開發及應用(1353) HTML(CSS)(1220) 其他技術討論專區(1200) WindowsServer(1192) .NET技术(1165) 交換及路由技術(1149) 語言基礎算法系統設計(1133) WindowsSDKAPI(1124) 界面(1088) JavaSE(1075) Qt(1074) VBA(1048) 新手樂園(1016) 其他開發語言(947) Go(907) HTML5(901) 新技術前沿(898) 硬件設計(872) 區塊鏈技術(860) 網絡編程(857) 非技術版(846) 一般軟件使用(839) 網絡協議與配置(835) Eclipse(790) Spark(750) 下載資源懸賞專區(743)

熱門瀏覽
  • 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
最新发布
  • 在執行com.android.build.gradle.internal.tasks.Workers$Action

    我創建的安卓應用有兩種產品口味,一種是生產型,一種是暫存型,當我為生產型設定動態鏈接時,我在清單中使用了以下資料代碼
    android:scheme="https"。
    />...

    uj5u.com 2021-10-16 15:31:15 more
  • 向kotlin springboot gradle匯入jar檔案

    請幫助,我有兩個使用Kotlin DSL Gradle的spring boot專案,但是,我需要將其中一個專案匯入另一個專案,但是,這不起作用。
    向 IntelliJ IDEA 專案添加外部 jars(lib/*.jar)的正確...

    uj5u.com 2021-10-16 15:30:34 more
  • 賽普拉斯測驗在iframe處掛起

    當我運行這個測驗時,一切似乎都很正常,直到我嘗試點擊iframe中的按鈕。我從下拉選單中選擇沒有問題,但是當我走到最后一步想點擊按鈕時,測驗在加載iframe后掛起。
    另外,是否有更...

    uj5u.com 2021-10-16 15:29:36 more
  • 如何復制HttpRequest

    PayPal提供了如何接收購買通知的示例代碼(或類似的)。遺憾的是,我沒有看到手動測驗的方法,我很難看到如何復制Microsoft.AspNetCore.Http HttpRequest。
    https://github.com/pay...

    uj5u.com 2021-10-16 15:29:15 more
  • 是否有適合測驗的WindowsActiveDirectory容器?

    我正在尋找一個像 openshift/openldap-2441-centos7 或 https://github.com/osixia/docker-openldap 的容器,它將運行一個 Windows 作業系統并具有一些合理的默認值。
    我想添...

    uj5u.com 2021-10-16 15:29:12 more
  • cypress上的invoke()方法如果呼叫兩次就不作業了

    我是Cypress的新手,我想用一個已經存在的網頁來實作一些簡單的測驗。我對結果有點困惑,因為我呼叫了兩次invoke():第一次是檢查初始值(0%),第二次是設定一個新的值并檢查變化,但是...

    uj5u.com 2021-10-16 15:29:08 more
  • 我如何測驗CriteriaBuidler查詢?

    如果我有一個需要測驗的方法,它依賴于用criticalBuilder和criticalQuery進行的查詢,我如何做到這一點? 我遇到的問題是,在測驗環境中的entityManager將是空的。模擬EntityManage...

    uj5u.com 2021-10-16 15:28:34 more
  • 從基類重寫通用方法

    我有一個類的繼承關系,定義如下: 我有一個類的繼承關系,定義如下: 我有一個類的繼承關系。
    class ClassA{}。

    class ClassB extends ClassA{}。

    class BaseClass{}。
    {
    pu...

    uj5u.com 2021-10-16 15:27:43 more
  • 為什么一個帶有常量通用布林值的方法不能呼叫一個對真和假都實作

    這段代碼完美地作業(playground):
    struct MyStruct<const B: bool> 。

    impl MyStruct<false> {
    pub fn bar() {
    println!("false") 。
    }
    }
    impl MyStruct<tru...

    uj5u.com 2021-10-16 15:26:44 more
  • Swift5-通過泛型分配相同型別的屬性值時出錯

    class SQS_Record {
    var table: SQS_Table? = nil?
    }

    class SQS_Table<RecordType: SQS_Record> {

    func newRecord() -> RecordType {
    let new = RecordType()...

    uj5u.com 2021-10-16 15:26:36 more