小酌重構系列[21]——避免雙重否定

来源:http://www.cnblogs.com/keepfool/archive/2016/05/30/5544091.html
-Advertisement-
Play Games

在自然語言中,雙重否定表示肯定。但是在程式中,雙重否定會降低代碼的可讀性,使程式不易理解,容易產生錯覺。 人通常是用“正向思維”去理解一件事情的,使用雙重否定的判斷,需要開發者以“逆向思維”的方式去理解它的含義。 另外,在寫程式時,"!"符號很容易被疏忽和遺漏,一不小心則會編寫出錯誤的代碼,從而產生... ...


避免雙重否定

在自然語言中,雙重否定表示肯定。但是在程式中,雙重否定會降低代碼的可讀性,使程式不易理解,容易產生錯覺。
人通常是用“正向思維”去理解一件事情的,使用雙重否定的判斷,需要開發者以“逆向思維”的方式去理解它的含義。
另外,在寫程式時,"!"符號很容易被疏忽和遺漏,一不小心則會編寫出錯誤的代碼,從而產生bug。
所以,在程式中,我們應當儘量避免使用雙重否定。

優惠券是否未被使用?

還是以線上商城給用戶發放優惠券為例,由於優惠券的初始狀態是未被使用的,所以設計人員將優惠券的使用狀態設計為IsUnused。

/// <summary>
/// 優惠券
/// </summary>
public class Coupon
{
    /// <summary>
    /// 是否未被使用
    /// </summary>
    public bool IsUnused { get; set; }
}


這樣設計會帶來兩個小問題

  • IsUnused表示“優惠券是否未被使用”,這句話本身是比較拗口的,開發人員需要“逆向思維”去理解它的含義。
  • 在寫程式時,如果要判斷“優惠券已經被使用”,則需要編寫比較繞彎的程式

 

// 如果優惠券已經被使用了
if (!coupon.IsUnused)
{
    // 業務邏輯
}

這段代碼如果沒有第1行的註釋,是比較難於理解的,也許你是用以下方式理解的。

SNAGHTML38b01d61

理解這段代碼看起來頗為費勁,我們應該換種方式來理解它。

image

因此,將屬性設計為IsUsed更為合適。

/// <summary>
/// 優惠券
/// </summary>
public class Coupon
{
    /// <summary>
    /// 是否被使用
    /// </summary>
    public bool IsUsed { get; set; }
}

編寫的判斷語句,可讀性良好,也易於理解。

// 如果優惠券已經被使用了
if (coupon.IsUsed)
{
    // 業務邏輯
}

PS:設計程式畢竟不是唱Rap,你沒必要把自己饒進去了,又把別人也繞進去,大家都能輕易讀懂的代碼才可能是好的代碼。

示例

重構前

這段代碼使用!customer.IsNotFlagged判斷“客戶賬戶被標記”,如果沒有註釋,這個判斷就比較難理解。

public class Order
{
    public void Checkout(IEnumerable<Product> products, Customer customer)
    {
        // 如果客戶賬戶被標記了
        if (!customer.IsNotFlagged)
        {
            // 記錄錯誤並返回
            return;
        }

        // 正常的訂單處理流程
    }
}

public class Customer
{
    public decimal Balance { get; private set; }

    public bool IsNotFlagged
    {
        get { return Balance < 30m; }
    }
}

程式本意是為了表達一個肯定的語義——“如果客戶賬戶是被標記的”,既然如此,我們何不直接用肯定的語義來表示它呢?

重構後

重構後,代碼讀起來就更加直觀了,也很容易被理解。

public class Order
{
    public void Checkout(IEnumerable<Product> products, Customer customer)
    {
        // 如果客戶賬戶被標記了
        if (customer.IsFlagged)
        {
            // 記錄錯誤並返回
            return;
        }

        // 正常的訂單處理流程
    }
}

public class Customer
{
    public decimal Balance { get; private set; }

    public bool IsFlagged
    {
        get { return Balance >= 30m; }
    }
}

小結

在設計bool類型的屬性時,不僅要表達清楚它所表示的業務含義,還應當考慮編寫代碼時的複雜性,儘量避免使用雙重否定。

【關註】keepfool
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 一位數組: #include <stdio.h> #include<string.h> #define N 5 void luru(float s[],int n); void shuchu(float s[],int n); void chaxun(float s[],int n); void p ...
  • ...
  • 概述 當條件判斷語句較為複雜時(有多個不同的檢查項),就像下麵這幅圖所表示的,會使得代碼的可讀性會大打折扣,也難以清晰地傳達判斷意圖。 再者,當判斷邏輯變更時,我們不得不去修改if語句裡面的判斷代碼。如果判斷寫得有問題,則會影響方法的正確性,也會給該方法的單元測試帶來一些障礙。 我們可以根據檢查項是... ...
  • 新寵兒 DotNetCore是.net5.0版本,之所以不叫.net5.0為的就是不讓我們把它與前面的.net混為一淡,它將是真正意義的跨平臺開發語言,在網上也有相關介紹,中國的一些大牛也發了相關文章,像張善友大牛也發了幾個文章,來介紹.NetCore,這段時間,大叔將會一步一步說說這個跨平臺的新寵 ...
  • DAO層,Service層,Controller層、View層 http://hovertree.com/hvtart/bjae/sko15s3g.htm 推薦:http://www.cnblogs.com/roucheng/p/chengxuyuan.html ...
  • 原則,故名思議則是本質的意思。所謂擒賊先擒王,研究設計模式自然要先瞭解設計原則,所有的模式都是在這些原則的基礎之上發展起來的,有的是側重一個,有的是多個都有所涉及。看完設計模式之後,我感覺到每個模式都有這些原則的影子,還滲透著面向對象的三大屬性,也覺得這些原則也都有相通之處,,正是有了他們才使我們由 ...
  • 閱讀文章時,如果某個段落已經傳達了關鍵信息,我們可能就不會逐字逐句地將文章讀完,因為我們已經知道了這篇文章的核心內容。 與此類似,如果方法中某些條件判斷可以得到結果,我們應該儘快返回該結果。 儘快返回可以帶來三個好處:1. 節省閱讀代碼的時間 2. 避免執行無效的邏輯 3. 增強代碼的可讀性 ...
  • 在學習java的過程中,我們肯定聽到過設計模式這名詞,在行業中有這麼一句話,若您能熟練的掌握23種設計模式,那麼你便是大牛! 好了,廢話不多說,今天我跟大家分享一下23種設計模式之一的 模板方法 設計模式 首先我們要知道什麼是模板方法設計模式? 測試結果如圖 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...