什麼樣的代碼是好代碼?

来源:https://www.cnblogs.com/NaughtyCat/archive/2019/09/25/what-is-good-codes.html
-Advertisement-
Play Games

關於什麼是好代碼,軟體行業爛大街的名詞一大堆,什麼高內聚、低耦合、可復用、可擴展、健壯性等等。也有所謂設計6原則—SOLID,即Single Responsibility (單一職責),Open Close(開閉),Liskov Substitution(里氏替換),Interface Segreg ...


關於什麼是好代碼,軟體行業爛大街的名詞一大堆,什麼高內聚、低耦合、可復用、可擴展、健壯性等等。也有所謂設計6原則—SOLID,即Single Responsibility (單一職責),Open Close(開閉),Liskov Substitution(里氏替換),Interface Segregation(介面隔離),Dependency Inversion(依賴反轉)

詳情可參考: https://www.cnblogs.com/huangenai/p/6219475.html

 

不喜歡這些抽象名詞,我們搞點簡單明瞭的。一匹跑得快,少生病(健壯),可以馱載各類貨物(可擴展),容易辨識(容易看懂),病好治(bug好發現),高大英俊的千里汗血馬是也

 

什麼是好代碼,不好定義,但是關於什麼是代碼里的"壞味道",比較容易搞清楚,避免代碼里的“壞味道",離好的代碼就不遠了,壞味道一二三:

  • 代碼重覆
  • 函數太長

如果太長(一般不宜超過200行,但不絕對),你自己都不太容易讀懂,請不要猶豫,拆成小函數吧。筆者剛畢業,參與一個大型複雜的金融軟體,核心業務類,函數1000行算小case,5000多行的不在少數,我的內心是哇涼哇涼的,一萬隻草泥馬在心中奔騰,還好大致邏輯比較清晰

  • 類太大

一般不宜操過1000行,同樣不絕對,jdk源碼過千行的不少嘛。還是那個大型複雜的金融軟體,核心的幾個Algo C++文件,2萬到3萬行,我的心在滴血

  • 函數參數列表太長

工作中有7個參數的函數調用,搞清楚每個參數的業務含意,和順序有點頭暈。儘管可能有預設函數參數,不小心的時候確實範過錯誤,後面直接引入一個線上bug,緊張

  • 變數名、函數名稱、類名、介面等命名含義不清晰

             圖02 程式員最頭疼的事

苦命的天朝程式員,還要把中文翻譯為英文,我也很頭大鴨。函數名能讓人望名知義,看名字就知道函數的功能是啥,以至於幾乎不需要多少comments最好

  • 太多的if else
  • 在迴圈里定義大量耗資源的變數

大對象,如果可以放在迴圈外,被共用,推薦這麼搞

  • try 塊代碼太長

try塊只包住真的可能發生異常的語句

  • 不用的資源未及時清理掉,流及時關閉

如IO句柄,資料庫連接,網路連接等。不清理掉,後果很嚴重,你若不信,軟體就死給你看

  • try-finally醜陋,明顯更愛try-with-resources,顏控,沒辦法

  1)醜陋的

    static String firstLineOfFile(String path) throws IOException{
        BufferedReader br = new BufferedReader(new FileReader(path));
        try {
            return br.readLine();
        } finally {
            br.close();
        }
    }

  2)漂亮的小姐姐

static String firstLineOfFile(String path) throws IOException{
    try (BufferedReader br = new BufferedReader(new FileReader(path))) {
        return br.readLine();
    }
}

 

  • 迴圈里字元串的拼接不要用”+“

有改過一個OutOfMemery的bug,字元串拼接用”+“,產生了一百多萬的字元串變數。用Visual VM程式占用記憶體空間比較多,數量最大的,通常都是String,所以用StringBuilder的append吧

  •  太巨量的迴圈,不推薦用乘除法

移位運算吧,效率快太多,參看redis rehashing.c hash key計算的代碼片段(因為hash key的計算會高頻度用到)

  • 避免運行時大量的反射

不知道Java社區為什麼不太關註反射耗時的問題,以前寫C#都會謹慎使用,C#社區有專門的討論

  • 基本類型優於裝箱基本類型

基本類型更快,更省空間。避免不經意引起自動裝箱和拆箱。是否相等的比較,裝箱基本類型可能回出錯

  • 未作參數有效性檢查

不搞這個,空異常妥妥地

  • 延遲初始化和懶載入

這個的確是一種優化,即需要用到它的值時,才初始化。如果永不用到,就永遠不會被初始化。但要慎用

  •  HashMap、ArrayList等集合類,沒有初始化數量

如果大致知道業務場景下這些集合類的數量,初始哈吧。不然預設好多16,結果你有1100個,會有數次重新分配記憶體和拷貝,費時間啊,我也懶,想耍啊

 

未完待續,困了

 

註:

參考《Effective java》《重構 —— 改善既有代碼的設計》

 

*****************************************************************************************************

精力有限,想法太多,專註做好一件事就行

  • 我只是一個程式猿。5年內把代碼寫好,技術博客字字推敲,堅持零拷貝和原創
  • 寫博客的意義在於鍛煉邏輯條理性,加深對知識的系統性理解,鍛煉文筆,如果恰好又對別人有點幫助,那真是一件令人開心的事

*****************************************************************************************************


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

-Advertisement-
Play Games
更多相關文章
  • 123 /*** 修改*/ function changeTextareaValue(obj) { $(obj).html(obj.value);} /** * 列印 */ function clickPrint(){ bdhtml = window.document.body.innerHTML;... ...
  • Cocos Creator 中 _worldMatrix 到底是什麼(上) 1. (矩陣)Matrix是什麼,有什麼用 (矩陣)Matrix一個神奇的存在?在開發過程中對裡邊各項值的含義是不是抓耳撓腮,百思不得其解?今天我們就來庖丁解牛,撥開它的神秘面紗。由於內容較多,關於Cocos Creator ...
  • 因為<label>的特性有兩點 : ①不呈現任何效果, ②用戶點擊該標簽, 瀏覽器能自動將焦點轉移到相關的表單控制項上. 所以正適合用於修改input的樣式. 進入正文, 修改input[type="checkbox"]的樣式 預設樣式: 選定前選定後; 設置後的樣式:選定前選定後; 本文只是簡單描述 ...
  • 如何這篇文章所述:https://www.cnblogs.com/mmykdbc/p/7418575.html js多次調用創建定時器的函數,會使定時器速度越來越快,多次調用定時器的使用場景比如:監聽頁面尺寸變化,重新初始化定時器函數,但是如果不清除上一次的,定時器實際上會累加在一起,這裡需要註意: ...
  • 具體語法參考:https://www.runoob.com/jsref/met-win-setinterval.html ...
  • 前言 原文鏈接: "Nealyang/personalBlog" ES6 已經不必在過多介紹,在 ES6 之前,裝飾器可能並沒有那麼重要,因為你只需要加一層 wrapper 就好了,但是現在,由於語法糖 class 的出現,當我們想要去在多個類之間共用或者擴展一些方法的時候,代碼會變得錯綜複雜,難以 ...
  • 下表顯示了將不同的JavaScript值轉換為Number,String和Boolean的結果: 註意:引號("")中的值表示字元串值。在紅色的值是程式員可能不希望被轉換為的值。 更多的JavaScript類型轉換相關文章。 ...
  • 微信小程式路由跳轉 1.wx.switchTab(Object object) 這裡的tabBar是底下的導航欄指定的頁面, 跳轉到 tabBar 頁面,並關閉其他所有非 tabBar 頁面 參數 Object object | 屬性 | 類型 | 預設值 | 必填 | 說明 | | | | | | ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 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 ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...