小酌重構系列[1]——移動方法

来源:http://www.cnblogs.com/keepfool/archive/2016/04/24/5427750.html
-Advertisement-
Play Games

概要 有些開發者在編寫方法時,可能較少地去思考一個問題:方法放在這個class中是否合適? 他們可能會覺得:這個方法已經實現xxx功能了,放在哪個class都一樣的,class不就是一個裝方法的容器嘛。 我贊同class是一個裝東西的容器,且不僅限於方法。 但是,容器是有區別的。本文要講的“移動方法... ...


概要

有些開發者在編寫方法時,可能較少地去思考一個問題:方法放在這個class中是否合適?

他們可能會覺得:這個方法已經實現xxx功能了,放在哪個class都一樣的,class不就是一個裝方法的容器嘛。

我贊同class是一個裝東西的容器,且不僅限於方法。

但是,容器是有區別的。本文要講的“移動方法”,是一種讓方法放進合適的class的重構策略。

選擇合適的容器

生活中我們會用到杯子和箱子,杯子和箱子都是容器。
倘若你用杯子裝書,用箱子裝水,會產生不好的結果——杯子里放不下書,水裝進箱子後,會打濕箱子。

image

隱藏代碼
// 杯子
public class Cup
{
    // 裝書
    public void HoldBook()
    {

    }
}

// 箱子
public class Box
{
    // 裝水
    public void HoldWater()
    {

    }
}


按照生活常識,我們應該用杯子裝水,用箱子裝書。

image

隱藏代碼
// 杯子
public class Cup
{
    // 裝水
    public void HoldWater()
    {

    }
}

// 箱子
public class Box
{
    // 裝書
    public void HoldBook()
    {

    }
}

每個程式員在開發完功能後,都應該回頭讀一讀自己的代碼,確認是否存在一些“牛頭不對馬嘴”的方法。
class是方法的容器,我們應該為每個方法尋找最合適的容器。

移動方法

現在引入本文的主題:“移動方法”。

當某個類的方法實現的功能更多地適用於另外一個類,且符合它的語義時,應將該方法移動到另外一個類。

該定義中有兩個關鍵詞:1. 適用 2. 語義。

“適用性”是指方法實現的功能應該適用它的class,“語義”是指方法的所描述的功能和class的語義是一致的。
“語義”的重要性高於“適用性”,例如:在程式中定義的擴展方法或者幫助類,通常都是被其它class調用的。這種情況下,我們應該著重體現“語義”。

有些開發者在編寫Excel工具類時,在ExcelUtil中出定義了ExportCsv()這樣的方法,儘管導出的Csv格式是可以用Excel打開的。
較好的做法是,新建一個CsvUtil類,將ExportCsv()方法定義在其中,下圖闡述了這個重構過程(藍色表示重構前,紅色表示重構後)。
雖然多了一個class,但這使得Excel工具類和Csv工具類的語義更佳精確,代碼的可讀性也提高了。

image

 

示例

這段代碼定義了兩個類:BankAccount、AccountInterest,分別表示銀行賬戶和賬戶利率。
計算利率的方法CalculateInterestRate()定義在BankAccount類。

隱藏代碼
namespace MoveMethod.Before
{
    /// <summary>
    /// 銀行賬戶
    /// </summary>
    public class BankAccount
    {
        public BankAccount(int accountAge, int creditScore, AccountInterest accountInterest)
        {
            AccountAge = accountAge;
            CreditScore = creditScore;
            AccountInterest = accountInterest;
        }

        public int AccountAge { get; private set; }
        public int CreditScore { get; private set; }
        public AccountInterest AccountInterest { get; private set; }

        // 計算利率
        public double CalculateInterestRate()
        {
            if (CreditScore > 800)
                return 0.02;

            if (AccountAge > 10)
                return 0.03;

            return 0.05;
        }
    }

    /// <summary>
    /// 賬戶利率
    /// </summary>
    public class AccountInterest
    {
        public BankAccount Account { get; private set; }

        public AccountInterest(BankAccount account)
        {
            Account = account;
        }

        public double InterestRate
        {
            get { return Account.CalculateInterestRate(); }
        }

        public bool IntroductoryRate
        {
            get { return Account.CalculateInterestRate() < 0.05; }
        }
    }
}

這兩個class用於描述一件客觀事實——”銀行賬戶和計算賬戶利率的方式“。
咋一看,這兩個類沒有什麼問題。
但由於已經定義了AccountInterest類,這個class的語義是和利率相關的,而CalculateInterestRate()方法用於計算賬戶利率。
所以將CalculateInterestRate()方法放在BankAccount類中不太合適,應將其移動到AccountInterest類中。

隱藏代碼
namespace MoveMethod.After
{
    /// <summary>
    /// 銀行賬戶
    /// </summary>
    public class BankAccount
    {
        public BankAccount(int accountAge, int creditScore, AccountInterest accountInterest)
        {
            AccountAge = accountAge;
            CreditScore = creditScore;
            AccountInterest = accountInterest;
        }

        public int AccountAge { get; private set; }
        public int CreditScore { get; private set; }
        public AccountInterest AccountInterest { get; private set; }
    }

    /// <summary>
    /// 賬戶利率
    /// </summary>
    public class AccountInterest
    {
        public BankAccount Account { get; private set; }

        public AccountInterest(BankAccount account)
        {
            Account = account;
        }

        public double InterestRate
        {
            get { return CalculateInterestRate(); }
        }

        public bool IntroductoryRate
        {
            get { return CalculateInterestRate() < 0.05; }
        }

        /// <summary>
        /// 計算利率
        /// </summary>
        public double CalculateInterestRate()
        {
            if (Account.CreditScore > 800)
                return 0.02;

            if (Account.AccountAge > 10)
                return 0.03;

            return 0.05;
        }
    }
}

下圖描述了重構前後的區別(藍色表示重構前,紅色表示重構後)。

image

總結

移動方法是較簡單的一種重構策略,它旨在將方法移動到合適的類。
這個策略的關鍵在於找到方法體現的行為(功能),以及該行為對應的語義。
找到語義,我們就能將它放到合適的類。
其中的難點也在於語義,語義應該具備“準確性”。
有時候業務知識、對現實物體(對象)的理解可能會阻礙我們尋找到準確的語義。


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

-Advertisement-
Play Games
更多相關文章
  • 代碼: using System; using System.Collections; using System.Collections.Generic; using System.ComponentModel; using System.Configuration; using System.Da ...
  • EF6引入一個彈性連接的功能,也就是允許重新嘗試執行失敗的資料庫操作。某些複雜的場景中,可能需要啟用或停用重試執行的策略,但是EF框架暫時尚未提供直接的設置開關,將來可能會加入這種配置。幸運的是,很容易自己實現該設置功能。 最簡單的註冊執行策略的方法是通過基於代碼的配置。下麵代碼是一個典型的配置類, ...
  • Chapter 05 變數的更多內容 5.1類型轉換 1.無論什麼類型,所有的數據都是一系列的位,即一組0和1。變數的含義是通過解釋這些數據的方式來傳達的。最簡單的示例是char類型,這種類型用一個數字表示Unicode字元集中的一個字元。實際上,這個數字與ushort的存儲方式相同 他們都是存儲0 ...
  • AnkhSVN是一款在VS中管理Subversion的插件,您可以在VS中輕鬆的提交、更新、添加文件,而不用在命令行或資源管理器中提交。而且該插件屬於開源項目。AnkhSvn安裝下載完畢後,進行安裝,安裝嚮導安裝即可,如下步驟。【步驟1】安裝界面,見圖。 【步驟2】安裝成功 AnkhSvn連接Vis ...
  • ASP.NET 頁運行時,此頁將經歷一個生命周期,在生命周期中將執行一系列處理步驟。這些步驟包括初始化、實例化控制項、還原和維護狀態、運行事件處理程式代碼以及進行呈現。瞭解頁生命周期非常重要,因為這樣做您就能在生命周期的合適階段編寫代碼,以達到預期效果。此外,如果您要開發自定義控制項,就必須熟悉頁生命周 ...
  • 距離上一篇OpenAuth.net的文章已經有5個多月了,在這段時間里項目得到了很多朋友的認可,開源中國上面的Star數接近300,於是堅定了我做下去的信心。最近稍微清閑點,正式推出1.0版,併在阿裡雲上部署了一個線上演示(文章結尾處給出線上演示鏈接)。相比剛開始時的版本,現在整個架構已經穩定,系統 ...
  • 一、線上聊天室 1、新建解決方案 SignalROnlineChatDemo 2、新建MVC項目 SignalROnlineChatDemo.Web (無身份驗證) 3、安裝SignalR PM> install-package Microsoft.AspNet.SignalR 4、 創建一個稱為 ...
  • 調試網站時,異常出現:Unrecognized attribute 'targetFramework'. Note that attribute names are case-sensitive. Server Error in '/' Application. Configuration Erro ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...