主頁 > 後端開發 > 垃圾代碼和優質代碼的區別?

垃圾代碼和優質代碼的區別?

2021-11-06 06:11:54 後端開發

作者:三省吾身丶丶
鏈接:https://zhuanlan.zhihu.com/p/99246269

幾個業務場景中的重構示例

請求順序依賴

在這種場景中,首先還是業務的復雜度決定了代碼的復雜度,首先我們來看一個在前端和node都有可能出現的一個簡單的例子:

我們有 A, B, C, D 四個請求獲取資料的函式(函式自己實作), C 依賴 B 的結果,D 依賴 ABC 的結果,最終輸出 D 的結果,

錯誤示例

雖然這個代碼是故意寫成這樣的,不過確實也有在一些初學者身上看到過,這份代碼還是能正確給出結果的,但是寫法丑陋,回呼地獄,如果后來人不進行重構,還有請求依賴,得繼續回呼嵌套,性能太差,沒有考慮 A 和 B 實際上是可以并發的,

這里介紹了一下最原始的 callback ... 中間大家可以去回顧一下 整個 ES2015+ ,callback (async.js) --> Promise --> generator + co --> async + await 的進化程序,其實是從原生的語法層面不斷去簡化和增強我們對于異步的控制能力,

下面直接給目前階段原生提供的終極方案:基于 Promise + async/await

正確示例

我們重新思考了一下上面的問題,理清楚了邏輯順序的依賴,并且用最新的語法,

使用 Promise.all 結合 async/await 的形式,考慮了并發和串行,寫法簡潔,達到了在示例要求下的最快方案,解決了無限嵌套的問題,這是跟隨語言進化本身帶給我們可以進行的優化,

但又不僅僅如此,我們將問題進行歸類 將 B,C 有依賴順序的請求,抽離出單獨的函式,讓他們去處理自身的邏輯,這個點我們稍后再提,

折磨人的 if else

可能存在下面一些問題

  1. 過多的嵌套
  2. 邏輯處理冗余
  3. 沒有做好防御編程(錯誤處理

直接來一個代碼例子,這是一個獲取背景顏色的方法,但是隨著業務的不斷變化,背景顏色的來源越來越多,在一些業務人員的處理下可能是這樣的:

錯誤示例

相信你在讀上面的代碼的時候是極為痛苦的,想要一目了然的知道最侄訓進入哪個分支,基本不可能,于是基于下面兩個原則

  • 合理的抽取成函式
  • 錯誤優先回傳

有了一個基礎版本的重構:

正確示例

可以看到整個邏輯,經過了重新梳理,拆分成了三個函式,子方法分別去處理對應層級的邏輯,由一個主方法負責調度,整體都變得一目了然了,

當然,在我們基于上面的原則進行重構之后,這個代碼有沒有問題呢?當然有,可以看到我們這三個函式,都依賴了全域變數,函式本身就不純了,如果是全域的問題,還是不易于排查,

我們可以將其修改為純函式,讓這一份代碼易于理解和測驗,

以一個函式的修改為示例:我們將 全域變數變成了引數,只需要在呼叫的時候,將全域變數傳入即可,但是這樣,我們得到了一個純函式,

為什么會在這里特別強調這個點呢,其實在函式式編程中的一個最基礎的問題那就是純函式,只有這樣輸入輸出才是可被觀測的,一個輸入一定會有一個輸出,也只有通過這樣的方式,才能讓系統中非純的函式越來越少,讓代碼變得更易于測驗,

當然作為我們如果以重構的角度去思考的話,我們還需要關注到這個點:

這里的邏輯會將會 最后一個被匹配到的資料,設定為 bgColor ,(我們都知道 find indexOf 等基本都是從前匹配,)是否真的是業務的需求呢?

可以看到將業務代碼寫好/重構的程序中其實也是對業務邏輯和業務理解的再一次提升,不論是抽取成函式還是錯誤優先回傳的設計,這其實也都是可以解決這樣一個問題:能在不去讀懂全域的情況下,了解某一個區域的細節邏輯,也就做到了讓代碼易于理解和修改,

... 這里的代碼即便是經過這樣的重構后,依然有可以考慮進一步優化的空間,比如函式與引數的命名,完整的測驗用例等等,受限于文章篇幅,暫不展開說明,

一些代碼中可能存在的其他問題

  1. 邏輯耦合在視圖層,

    a === 'a' && b ==='b' && c==='c' && d ==='d'? <div>...</div>:null

  2. 組件復用,函式復用,不封裝,代碼重復,

  3. 函式功能不單一,一個函式處理太多職責,且這些職責沒有任何關聯,但是都耦合在同一個區塊內,

  4. 引數串列混亂,有做好防御編程,不處理錯誤(介面錯誤,超時,重復提交等等

  5. 魔法數字,魔法字串,且沒說明,

  6. 糟糕資料結構 / 糟糕命名 (其實上面的具體代碼示例也存在)

關于優化代碼的思想準備

首先來說一下為什么會說需要優化代碼?

  1. 技術追求,
  2. 公司要求,線上有系統在用,有用戶在用,不寫好出問題實際上苦的還是自己,
  3. 團隊協作,我不好好寫,團隊成員其他人也不好好寫,惡性回圈苦的還是自己,
  4. 快速迭代,系統需要不斷的增加新功能,必須要寫好代碼才能做到,
  5. 其他人的看法,怕別人覺得自己技術能力差... xxxx....

那么就會有下面這些要求:

  • 易于理解系統的架構
  • 易于理解系統的生命周期與執行流程
  • 易于理解每一個函式的作用
  • 易于理解函式之間是如何呼叫與傳遞的(輸入輸出)
  • 易于理解變數的含義,運算式的含義,
  • 易于擴展...

最終實際上又回到了寫出來的代碼應該是 整潔的代碼,要使代碼易于理解/修改/測驗,(這里其實大部分時候,都隱含了一個人員協作的條件在里面,所以,既要寫好代碼,又不能過度封裝,讓團隊其他成員看不懂(當然如果確實有些人經驗不夠,那么是他自身的問題,需要他自己去加強,))

一些建議

  1. 更加清晰的去了解業務,去思考可能的變化,思考和設計清楚再動手,
  2. 看一些開源專案與業界最佳實踐,明白什么樣的是好代碼,什么樣的是不好的代碼,
  3. 建立明白代碼雖然是給計算機運行的,但最侄訓是人看的,不僅僅是沒有 bug 就行了,這樣的心智模型,
  4. 建立業務與代碼質量同等重要的思考模型,避免因為時間導致的不得不這么寫的代碼,
  5. 明白 code review 本身可能能發現和指出來一些問題,但最終的落實還的靠自己,不能變成形式,而是需要融合成自身的思考,
  6. 使用錯誤優先原則,盡可能的讓出錯的先回傳, 這樣后面就會得到干凈的代碼,(寫代碼的時候,不僅僅正向,反向的判斷也需要思考)
  7. 合理的拆分成獨立的函式,明確輸入輸出,錯誤處理等在函式內部的處理,(比如在一些場景中確實會存在大量邏輯判斷,首先就要思考在判斷內部的陳述句是否能被歸類與拆分出去)
  8. 對于多種狀態的判斷與組合,可以使用 組合狀態表 (map表)狀態機等模式
  9. 學習設計模式與重構等相關知識,
  10. 重構!!只要你覺得這個地方有問題了,那就不要等到以后,以后往往就是再也不,

結束

說到這可能會有一種戛然而止的感覺,在這一篇文章里面,我們首先以兩個優化代碼的具體實體為引子,讓大家明白了一些業務代碼的優化思路,在之后從列舉了一些其他可能出現的錯誤,以及是優化代碼的思想準備和理論指導,

其實都是希望大家能夠在業務中去發現問題,再去思考如何解決問題,因為說了那么多,到底能不把代碼寫好,還是得靠自己,

近期熱文推薦:

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

2.別在再滿屏的 if/ else 了,試試策略模式,真香!!

3.臥槽!Java 中的 xx ≠ null 是什么新語法?

4.Spring Boot 2.5 重磅發布,黑暗模式太炸了!

5.《Java開發手冊(嵩山版)》最新發布,速速下載!

覺得不錯,別忘了隨手點贊+轉發哦!

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

標籤:Java

上一篇:使用策略模式重構電商折扣和支付場景

下一篇:面試官:GET 請求能上傳圖片嗎?我蒙了。。

標籤雲
其他(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)

熱門瀏覽
  • 【C++】Microsoft C++、C 和匯編程式檔案

    ......

    uj5u.com 2020-09-10 00:57:23 more
  • 例外宣告

    相比于斷言適用于排除邏輯上不可能存在的狀態,例外通常是用于邏輯上可能發生的錯誤。 例外宣告 Item 1:當函式不可能拋出例外或不能接受拋出例外時,使用noexcept 理由 如果不打算拋出例外的話,程式就會認為無法處理這種錯誤,并且應當盡早終止,如此可以有效地阻止例外的傳播與擴散。 示例 //不可 ......

    uj5u.com 2020-09-10 00:57:27 more
  • Codeforces 1400E Clear the Multiset(貪心 + 分治)

    鏈接:https://codeforces.com/problemset/problem/1400/E 來源:Codeforces 思路:給你一個陣列,現在你可以進行兩種操作,操作1:將一段沒有 0 的區間進行減一的操作,操作2:將 i 位置上的元素歸零。最終問:將這個陣列的全部元素歸零后操作的最少 ......

    uj5u.com 2020-09-10 00:57:30 more
  • UVA11610 【Reverse Prime】

    本人看到此題沒有翻譯,就附帶了一個自己的翻譯版本 思考 這一題,它的第一個要求是找出所有 $7$ 位反向質數及其質因數的個數。 我們應該需要質數篩篩選1~$10^{7}$的所有數,這里就不慢慢介紹了。但是,重讀題,我們突然發現反向質數都是 $7$ 位,而將它反過來后的數字卻是 $6$ 位數,這就說明 ......

    uj5u.com 2020-09-10 00:57:36 more
  • 統計區間素數數量

    1 #pragma GCC optimize(2) 2 #include <bits/stdc++.h> 3 using namespace std; 4 bool isprime[1000000010]; 5 vector<int> prime; 6 inline int getlist(int ......

    uj5u.com 2020-09-10 00:57:47 more
  • C/C++編程筆記:C++中的 const 變數詳解,教你正確認識const用法

    1、C中的const 1、區域const變數存放在堆疊區中,會分配記憶體(也就是說可以通過地址間接修改變數的值)。測驗代碼如下: 運行結果: 2、全域const變數存放在只讀資料段(不能通過地址修改,會發生寫入錯誤), 默認為外部聯編,可以給其他源檔案使用(需要用extern關鍵字修飾) 運行結果: ......

    uj5u.com 2020-09-10 00:58:04 more
  • 【C++犯錯記錄】VS2019 MFC添加資源不懂如何修改資源宏ID

    1. 首先在資源視圖中,添加資源 2. 點擊新添加的資源,復制自動生成的ID 3. 在解決方案資源管理器中找到Resource.h檔案,編輯,使用整個專案搜索和替換的方式快速替換 宏宣告 4. Ctrl+Shift+F 全域搜索,點擊查找全部,然后逐個替換 5. 為什么使用搜索替換而不使用屬性視窗直 ......

    uj5u.com 2020-09-10 00:59:11 more
  • 【C++犯錯記錄】VS2019 MFC不懂的批量添加資源

    1. 打開資源頭檔案Resource.h,在其中預先定義好宏 ID(不清楚其實ID值應該設定多少,可以先新建一個相同的資源項,再在這個資源的ID值的基礎上遞增即可) 2. 在資源視圖中選中專案資源,按F7編輯資源檔案,按 ID 型別 相對路徑的形式添加 資源。(別忘了先把檔案拷貝到專案中的res檔案 ......

    uj5u.com 2020-09-10 01:00:19 more
  • C/C++編程筆記:關于C++的參考型別,專供新手入門使用

    今天要講的是C++中我最喜歡的一個用法——參考,也叫別名。 參考就是給一個變數名取一個變數名,方便我們間接地使用這個變數。我們可以給一個變數創建N個參考,這N + 1個變數共享了同一塊記憶體區域。(參考型別的變數會占用記憶體空間,占用的記憶體空間的大小和指標型別的大小是相同的。雖然參考是一個物件的別名,但 ......

    uj5u.com 2020-09-10 01:00:22 more
  • 【C/C++編程筆記】從頭開始學習C ++:初學者完整指南

    眾所周知,C ++的學習曲線陡峭,但是花時間學習這種語言將為您的職業帶來奇跡,并使您與其他開發人員區分開。您會更輕松地學習新語言,形成真正的解決問題的技能,并在編程的基礎上打下堅實的基礎。 C ++將幫助您養成良好的編程習慣(即清晰一致的編碼風格,在撰寫代碼時注釋代碼,并限制類內部的可見性),并且由 ......

    uj5u.com 2020-09-10 01:00:41 more
最新发布
  • Rust中的智能指標:Box<T> Rc<T> Arc<T> Cell<T> RefCell<T> Weak

    Rust中的智能指標是什么 智能指標(smart pointers)是一類資料結構,是擁有資料所有權和額外功能的指標。是指標的進一步發展 指標(pointer)是一個包含記憶體地址的變數的通用概念。這個地址參考,或 ” 指向”(points at)一些其 他資料 。參考以 & 符號為標志并借用了他們所 ......

    uj5u.com 2023-04-20 07:24:10 more
  • Java的值傳遞和參考傳遞

    值傳遞不會改變本身,參考傳遞(如果傳遞的值需要實體化到堆里)如果發生修改了會改變本身。 1.基本資料型別都是值傳遞 package com.example.basic; public class Test { public static void main(String[] args) { int ......

    uj5u.com 2023-04-20 07:24:04 more
  • [2]SpinalHDL教程——Scala簡單入門

    第一個 Scala 程式 shell里面輸入 $ scala scala> 1 + 1 res0: Int = 2 scala> println("Hello World!") Hello World! 檔案形式 object HelloWorld { /* 這是我的第一個 Scala 程式 * 以 ......

    uj5u.com 2023-04-20 07:23:58 more
  • 理解函式指標和回呼函式

    理解 函式指標 指向函式的指標。比如: 理解函式指標的偽代碼 void (*p)(int type, char *data); // 定義一個函式指標p void func(int type, char *data); // 宣告一個函式func p = func; // 將指標p指向函式func ......

    uj5u.com 2023-04-20 07:23:52 more
  • Django筆記二十五之資料庫函式之日期函式

    本文首發于公眾號:Hunter后端 原文鏈接:Django筆記二十五之資料庫函式之日期函式 日期函式主要介紹兩個大類,Extract() 和 Trunc() Extract() 函式作用是提取日期,比如我們可以提取一個日期欄位的年份,月份,日等資料 Trunc() 的作用則是截取,比如 2022-0 ......

    uj5u.com 2023-04-20 07:23:45 more
  • 一天吃透JVM面試八股文

    什么是JVM? JVM,全稱Java Virtual Machine(Java虛擬機),是通過在實際的計算機上仿真模擬各種計算機功能來實作的。由一套位元組碼指令集、一組暫存器、一個堆疊、一個垃圾回收堆和一個存盤方法域等組成。JVM屏蔽了與作業系統平臺相關的資訊,使得Java程式只需要生成在Java虛擬機 ......

    uj5u.com 2023-04-20 07:23:31 more
  • 使用Java接入小程式訂閱訊息!

    更新完微信服務號的模板訊息之后,我又趕緊把微信小程式的訂閱訊息給實作了!之前我一直以為微信小程式也是要企業才能申請,沒想到小程式個人就能申請。 訊息推送平臺🔥推送下發【郵件】【短信】【微信服務號】【微信小程式】【企業微信】【釘釘】等訊息型別。 https://gitee.com/zhongfuch ......

    uj5u.com 2023-04-20 07:22:59 more
  • java -- 緩沖流、轉換流、序列化流

    緩沖流 緩沖流, 也叫高效流, 按照資料型別分類: 位元組緩沖流:BufferedInputStream,BufferedOutputStream 字符緩沖流:BufferedReader,BufferedWriter 緩沖流的基本原理,是在創建流物件時,會創建一個內置的默認大小的緩沖區陣列,通過緩沖 ......

    uj5u.com 2023-04-20 07:22:49 more
  • Java-SpringBoot-Range請求頭設定實作視頻分段傳輸

    老實說,人太懶了,現在基本都不喜歡寫筆記了,但是網上有關Range請求頭的文章都太水了 下面是抄的一段StackOverflow的代碼...自己大修改過的,寫的注釋挺全的,應該直接看得懂,就不解釋了 寫的不好...只是希望能給視頻網站開發的新手一點點幫助吧. 業務場景:視頻分段傳輸、視頻多段傳輸(理 ......

    uj5u.com 2023-04-20 07:22:42 more
  • Windows 10開發教程_編程入門自學教程_菜鳥教程-免費教程分享

    教程簡介 Windows 10開發入門教程 - 從簡單的步驟了解Windows 10開發,從基本到高級概念,包括簡介,UWP,第一個應用程式,商店,XAML控制元件,資料系結,XAML性能,自適應設計,自適應UI,自適應代碼,檔案管理,SQLite資料庫,應用程式到應用程式通信,應用程式本地化,應用程式 ......

    uj5u.com 2023-04-20 07:22:35 more