薦讀|屬性與可直接訪問的數據成員之間應該如何選

来源:https://www.cnblogs.com/yilezhu/archive/2019/07/22/11221447.html
-Advertisement-
Play Games

寫在前面 在書寫C 代碼的時候你是否有過這樣的經歷:經常混用屬性以及公有的數據成員。畢竟他們的用法基本一致,對於使用來說好像沒什麼區別啊。其實我也經常使用類的公有的數據成員來定義一些常量,為了簡單,在一些僅僅需要對外暴露一些常量的類中(如定義一些全局使用的常量),也都是通過定義公有數據成員實現的。直 ...


寫在前面

在書寫C#代碼的時候你是否有過這樣的經歷:經常混用屬性以及公有的數據成員。畢竟他們的用法基本一致,對於使用來說好像沒什麼區別啊。其實我也經常使用類的公有的數據成員來定義一些常量,為了簡單,在一些僅僅需要對外暴露一些常量的類中(如定義一些全局使用的常量),也都是通過定義公有數據成員實現的。直到看到世界世界知名專家Bill Wagner的那本《More Effective C#》之後才意識到應該儘量“使用屬性而不是可直接訪問的數據成員”。因為屬性具有修改的便捷性,多線程的支持等等。

作者:依樂祝
原文地址:https://www.cnblogs.com/yilezhu/p/11221447.html

為什麼應該儘量使用屬性

屬性一直是C#語言的特色,目前的屬性機制比C#剛引人它的時候更為完備,這使得開發者能夠通過屬性實現很多功能,例如,可以給gettersetter 設定不同的訪問許可權。與直接通過數據成員來編程的方式相比,自動屬性可以省去大量的編程工作,而且開發者可以通過該機制輕鬆地定義出只讀的屬性。此外還可以結合以表達式為主體的 ( expression-bodied) 寫法將代碼變得更緊湊。 有了這些機制就不應該繼續在類型中創建公有 ( publish) 欄位, 也不應該繼續手工編寫getset方法。 屬性既可以令調用者通過公有介面訪問相關的數據成員 , 又可以確保這些成員得到面向對象式的封裝。

註:在C#語言中, 屬性這種元素可以像數據成員一樣被訪問, 但它們其實是通過方法來實現的。

方便修改

在所有的類與結構中,應該多使用屬性,這樣可以讓你在發現新的需求時,更為方便的修改代碼。比如說,如果你現在決定Customer類型的name(名字)數據不應該出現空白值,那麼只需要修改Name屬性的代碼即可:

public class Customer
{
    private string name;
    public string name
    {
        get=>name;
        set
        {
            if(string.IsNullOrWhiteSpace(value))
            {
                throw new ArgumentException(
                    "Name connot be blank",
                    nameof(Name)
                );
            }
            name=value;
        }
    }
}

假如當初沒有通過公有屬性來實現Name,而是採用了公有數據成員,那麼現在我們就必須在代碼庫里找到設置過該成員的每行代碼,並逐個修改,這會浪費很多時間。

多線程支持

由於屬性是通過方法實現的,因此,開發者很容易就能給它添加多線程的支持。例如可以像下麵這樣實現get與·set訪問器,使外界對Name數據的訪問得以同步:

public class Customer
{
    private object syncHandle = new object();

    private string name;
    public string name
    {
        get
        {
            lock (syncHandle)
            {
                return name;
            }
        }
        set
        {
            if (string.IsNullOrWhiteSpace(value))
            {
                throw new ArgumentException(
                    "Name connot be blank",
                    nameof(Name)
                );
            }

            lock (syncHandle)
            {
                name = value;
            }
        }
    }
}

方法具備的好處,屬性全有

C# 方法所具備的一些特性同樣可以體現在屬性身上,其中很明顯的一條就是屬性也可以聲明為virtual:

public class Customer
{
    public virtual string Name
    {
        get;
        set;
    }
}

Note:剛纔幾個例子涉及屬性的地方用的都是隱式寫法。採用隱式寫法時,開發者不用自己在屬性的gettersetter中編寫過多邏輯。也就是說,我們在用屬性來表示比較簡單的欄位時,無需通過大量的模板代碼來構建這個屬性,編譯器會為我們自動創建私有欄位(該欄位通常稱為後援欄位,並實現getset這兩個訪問器所需的簡單邏輯)。

可以是抽象的,併成為介面的一部分

屬性也可以是抽象的,從而成為介面定義的一部分,這種屬性寫起來與隱士屬性相似。下麵這段代碼,就演示了怎樣在泛型介面中定義屬性。雖然與隱士屬性的寫法相似,但這種屬性沒有對應的實現物,定義該屬性的介面只是要求實現本介面的類型都必須滿足介面所訂立的契約,也就是必須正確的提供NameValue這兩個屬性:

public interface INameValuePair<T>
{
    string Name { get; }
    T Value { get; set; }
}

很方便的控制獲取及設置許可權

對於類型中的屬性來說,它的訪問器分成getter(獲取器)setter(設置器)這兩個單獨的方法,這使得我們能夠對二者施加不同的修飾符,以便分別控制外界對該屬性的獲取許可權以及設置許可權。由於這兩種許可權可以分開調整,因此我們能夠通過屬性更為靈活的封裝數據元素:

public class Customer
{
    public virtual string Name
    {
        get;
        protected set;
    }
}

帶參數的屬性

屬性不只適用於簡單的數字欄位。如果某個類型要在其介面中發佈能夠用索引來訪問的內容,那麼就可以創建索引器。這相當於帶有參數的屬性,或者說參數化的屬性。下麵這種寫法很有用,用它創建出的屬性能夠返回序列中的某個元素:

public class Customer
{
    public virtual string Name
    {
        get;
        protected set;
    }

    public int this[int index]
    {
        get => theValues[index];
        set => theValues[index] = value;
    }

    private int[] theValues = new int[100];
}
//Accessing an indexer;
int val=someCustomer[i];

此外,若參數是整數的一維索引器,則可以參與數據綁定,若參數不是整數的一維索引器,則可以用來定義映射關係:

private Dictionary<string, Address> addressValues;
    public Address this[string name]
    {
        get => addressValues[name];
        set => addressValues[name] = value;
    }

註意:索引器一律要用this關鍵字來聲明。由於C#不允許給索引器起名字,因此同一個類型的索引器必須在參數列表上有所區別,否則就會產生歧義。
另外,索引器必須明確的實現出來,而不能像簡單屬性那樣由系統預設生成。

其他說明

後期再把數據成員改成屬性

儘管屬性是個相當好的機制,可是還有人想先創建普通的數據成員,然後在確實有必要的情況下再將其替換成屬性,以便使用屬性所具備的優勢。這種想法聽上去很有道理,但實際並不合適。例如,如下定義一個普通數據成員的代碼:

public class Customer
{
    public string Name;
}
string name = customerOne.Name;
customerOne.Name = "yilezhu";

其實我也經常這樣用,不過都是定義一些靜態的全局常量。
雖然在使用上屬性可以像數據成員那樣來訪問,但是從MSIL的角度來看,卻不是這樣,因為訪問屬性時所使用的指令與訪問數據成員所使用的指令是有區別的。因此如果把數據成員改成屬性,則會破壞二進位層面的相容機制,使得很難單獨更新某一個程式集,需要全部更新。

屬性的性能損耗

你可能要問了,是以屬性的形式訪問數據比較快,還是以數據成員的形式訪問比較快?其實前者的效率雖然不會超過後者,但也未必落後於它。因為JIT編譯器會對某些方法調用進行內聯處理,其中也包括屬性。如果編譯器對屬性進行內聯處理的話,那麼它的效率就會與數據成員相同。即便沒有內聯,兩者的差別也可以忽略不計。

總結

今天給大家介紹了使用屬性來訪問數據成員的諸多優勢,因此建議如果要在類型的公有或受保護的介面中發佈數據,那麼應該以屬性的形式來發佈,對於序列或字典來說,應該以索引器的形式發佈。在日常的開發中雖然用屬性的形式來封裝變數會占用你一到兩分鐘的時間,但是如果你一開始沒有使用屬性,後來想用屬性來設計,那麼可能就得用好幾個小時去修正了。現在多花點時間,將來會省很多功夫。
文章大多內容來自觀看《More Effective C#》第一小節的內容所做的筆記,當然後續我還會對剩下的提升C#代碼的50個方法進行總結記錄,敬請期待吧。如果你有興趣可以加DotNetCore實戰項目交流群637326624跟大伙進行交流。


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

-Advertisement-
Play Games
更多相關文章
  • 一、Angel工作室簡單通用許可權系統簡介 AngelRM(Asp.net MVC Web api)是基於asp.net(C#)MVC+前端bootstrap+ztree+lodash+jquery技術,採用bootstrap為前臺開發展示UI,Web Api主要負責前端的邏輯交互,再結合jQuery ...
  • 一、前言 surging 開源地址:https://github.com/dotnetcore/surging 隨著業務的發展,併發量的增多,業務的複雜度越來越大,對於系統架構能力要求越來越高,這時候微服務的設計思想應運而生,但是對於微服務需要引擎進行驅動,這時候基於.NET CORE 的微服務引擎 ...
  • OSGeo.GDAL.Gdal.SetConfigOption("GDAL_FILENAME_IS_UTF8", "YES");OSGeo.GDAL.Gdal.SetConfigOption("SHAPE_ENCODING", "");OSGeo.GDAL.Gdal.AllRegister();OS... ...
  • 最近一個項目中用到了https的請求,在實際調用過程中發現之前的http方法不支持https,調用一直報錯。 查詢了一下,添加幾行代碼解決問題。 public string HttpPost(string Url, string postDataStr, string useragent = nul ...
  • 描述: 在 C# 中,System.Threading.Thread 類用於線程的工作。它允許創建並訪問多線程應用程式中的單個線程。進程中第一個被執行的線程稱為主線程。 案例: static void Main(string[] args) { int num = 100; for (int i = ...
  • 1 Lambda —— 表達式 Lambda 表達式是一個匿名函數,用它可以高效簡化代碼,常用作委托,回調 Lambda 表達式都使用運算符=>,所以當你見到這個符號,基本上就是一個 Lambda 表達式 Lambda 運算符的左邊是輸入參數(),=>,右邊是表達式或語句塊 Lambda 表達式,是 ...
  • 這篇文章主要是介紹劍指offer中的【位運算:二進位中1的個數】,【代碼的完整性:數值的整數次方】,【代碼的完整性:調整數組順序使奇數位於偶數前面】的實現。 1. 位運算:二進位中1的個數, 題目描述 輸入一個整數,輸出該數二進位表示中1的個數。其中負數用補碼表示。 解題思路 把一個整數減去1,再和 ...
  • 動手造輪子:實現一個簡單的 EventBus Intro EventBus 是一種事件發佈訂閱模式,通過 EventBus 我們可以很方便的實現解耦,將事件的發起和事件的處理的很好的分隔開來,很好的實現解耦。 微軟官方的示例項目 "EShopOnContainers" 也有在使用 EventBus ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...