編寫高質量代碼改善C#程式的157個建議

来源:http://www.cnblogs.com/shouce/archive/2016/04/07/5362043.html
-Advertisement-
Play Games

前言 建議13、為類型輸出格式化字元串 建議14、正確實現淺拷貝和深拷貝 建議15、使用dynamic來簡化反射實現 建議13、為類型輸出格式化字元串 有兩種方法可以為類型提供格式化的字元串輸出。 一種是意識到類型會產生格式化字元串輸出，於是讓類型繼承介面IFormattable。這對類型來說，是一 ...


前言

　　建議13、為類型輸出格式化字元串

　　建議14、正確實現淺拷貝和深拷貝

　　建議15、使用dynamic來簡化反射實現

建議13、為類型輸出格式化字元串

 　　有兩種方法可以為類型提供格式化的字元串輸出。

　　一種是意識到類型會產生格式化字元串輸出，於是讓類型繼承介面IFormattable。這對類型來說，是一種主動實現的方式，要求開發者可以預見類型在格式化方面的要求。

　　更多的時候，類型的使用者需為類型自定義格式化器，這就是第二種方法，也是最靈活多變的方法，可以根據需求的變化為類型提供多個格式化器。

　　下麵我們就來看一下這兩種方式的實現。

　　最簡單的字元串輸出是為類型重寫ToString()方法，如果沒有為類型重寫該方法，預設會調用Ojbect的ToString方法，它會返回當前類型的類型名稱。但即使是重寫了ToString()方法，提供的字元串輸出也是非常單一的，而通過實現IFormattable介面的ToString()方法，可以讓類型根據用戶的輸入而格式化輸出。

下麵我們來看一個簡單的小例子：

複製代碼 
    public class Person:IFormattable
    {
        public string IDCode { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
        /// <summary>
        /// 實現介面Iformattable的方法ToString
        /// </summary>
        /// <param name="format"></param>
        /// <param name="formatProvider"></param>
        /// <returns></returns>
        public string ToString(string format, IFormatProvider formatProvider)
        {
            switch (format)
            { 
                case"Ch":
                    return this.ToString();
                case"Eg":
                    return string.Format("{0}{1}", this.FirstName, this.LastName);
                default:
                    return
                        this.ToString();
            }
        }
        ///重寫Object的方法ToString()
        public override string ToString()
        {
            return string.Format("{0}{1}",this.LastName,this.FirstName);
        }
    }
複製代碼

調用代碼如下所示：

複製代碼 
        static void Main(string[] args)
        {
            Person person = new Person() { FirstName="Kris",LastName="aehyok"};
            Console.WriteLine(person);
            Console.WriteLine(person.ToString("Ch",null));
            Console.WriteLine(person.ToString("Eg", null));
            Console.ReadLine();
        }
複製代碼

調用執行結果如下：

　　下麵我們來繼續介紹第二實現方式——格式化器。如果類型本身沒有提供格式化的功能，那麼格式化器就可以派上用場了。格式化器的好處就是可以根據需求的變化，隨時增加或者修改它。

　　接下來我們繼續來看另外的一個小例子：

首先定義一個實體類Person:

    public class Person
    {
        public string IDCode { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
    }

一個典型的格式化器應該繼承IFormatProvider和ICustomerFormatter，看代碼：

複製代碼 
    public class PersonFomatter:IFormatProvider,ICustomFormatter
    {
        #region IFormatProvider成員
        public object GetFormat(Type formatType)
        {
            if (formatType == typeof(ICustomFormatter))
            {
                return this;
            }
            else
            {
                return null;
            }
        }
        #endregion

        #region ICustomFormatter成員
        public string Format(string format, object arg, IFormatProvider formatProvider)
        {
            Person person = arg as Person;
            if (person == null)
            {
                return string.Empty;
            }
            switch (format)
            { 
                case"Ch":
                    return string.Format("{0} {1}",person.LastName,person.FirstName);
                case"":
                    return string.Format("{0} {1}",person.FirstName,person.LastName);
                case"CHM":
                    return string.Format("{0} {1}:{2}", person.LastName, person.FirstName, person.IDCode);
                default:
                    return string.Format("{0} {1}", person.LastName, person.FirstName);
            }
        }
        #endregion
    }
複製代碼

調用代碼如下：

複製代碼 
    class Program
    {
        static void Main(string[] args)
        {
            Person person = new Person() { FirstName="Kris", LastName="aehyok", IDCode="ID000001"};
            Console.WriteLine(person.ToString());
            PersonFomatter pFomatter = new PersonFomatter();
            Console.WriteLine(pFomatter.Format("Ch", person, null));
            Console.WriteLine(pFomatter.Format("Eg", person, null));
            Console.WriteLine(pFomatter.Format("CHM", person, null));
            Console.ReadLine();
        }
    }
複製代碼

調用執行結果如下：

其實還有另外一種變通的形式，就是將這兩種方式合併一起使用的過程，下麵來看一下具體的實現代碼：

複製代碼 
public class Person:IFormattable
    {
        public string IDCode { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
                /// <summary>
        /// 實現介面Iformattable的方法ToString
        /// </summary>
        /// <param name="format"></param>
        /// <param name="formatProvider"></param>
        /// <returns></returns>
        public string ToString(string format, IFormatProvider formatProvider)
        {
            switch (format)
            { 
                case"Ch":
                    return this.ToString();
                case"Eg":
                    return string.Format("{0}{1}", this.FirstName, this.LastName);
                default:
                    //return this.ToString();
                    ICustomFormatter customerFormatter = formatProvider as ICustomFormatter;
                    if (formatProvider == null)
                    {
                        return this.ToString();
                    }
                    return customerFormatter.Format(format, this, null);
            }
        }
        ///重寫Object的方法ToString()
        public override string ToString()
        {
            return string.Format("{0}{1}",this.LastName,this.FirstName);
        }
    }
複製代碼

PersonFomatter自定義格式化器的代碼並沒有發生任何的改變。
調用代碼如下：

複製代碼 
        static void Main(string[] args)
        {
            Person person = new Person() { FirstName="Kris", LastName="aehyok", IDCode="ID000001"};
            Console.WriteLine(person.ToString());
            PersonFomatter pFomatter = new PersonFomatter();
            Console.WriteLine(pFomatter.Format("Ch", person, null));
            Console.WriteLine(pFomatter.Format("Eg", person, null));
            Console.WriteLine(pFomatter.Format("CHM", person, null));

            Console.WriteLine(person.ToString("Ch",pFomatter));
            Console.WriteLine(person.ToString("Eg", pFomatter));
            Console.WriteLine(person.ToString("CHM", pFomatter));
            Console.ReadLine();
        }
複製代碼

調用執行結果如下所示：

建議14、正確實現淺拷貝和深拷貝

為對象創建副本的技術成為拷貝(也叫克隆)。我們將拷貝分為淺拷貝和深拷貝。

淺拷貝 將對象中的所有欄位複製到新的對象(副本)中。其中，值類型欄位的值被覆制到副本中後，在副本中的修改不會影響到源對象對應的值。 而引用類型的欄位被覆制到副本中的是引用類型的引用，而不是引用的對象，在副本中對引用類型的欄位值做修改會影響到源對象本身。

深拷貝 同樣，將對象中的所有欄位複製到新的對象中。不過無論是對象的值類型欄位，還是引用類型欄位，都會被重新創建並賦值，對於副本的修改，不會影響到源對象本身。

無論是淺拷貝還是深拷貝，微軟都建議用類型繼承ICloneable介面的方式明確告訴調用者：該類型可以被拷貝。當然，ICloneable介面只提供了一個聲明為Clone的方法，我們可根據需求在Clone方法內實現淺拷貝或深拷貝。一個簡答的淺拷貝的實現代碼如下所示：

首先定義實體類：

複製代碼 
    public class Employee:ICloneable
    {
        public string IDCode { get; set; }
        public int Age { get; set; }
        public Department Department { get; set; }

        #region OCloneable成員
        public object Clone()
        {
            return this.MemberwiseClone();
        }
        #endregion
    }

    public class Department
    {
        public string Name{get;set;}
        public override string  ToString()
        {
              return this.Name;
        }
    }
複製代碼

然後進行調用代碼如下：

複製代碼 
        static void Main(string[] args)
        {
            Employee Niki = new Employee()
            {
                IDCode = "IDaehyok",
                Age = 25,
                Department = new Department() { Name="Depart1" }
            };
            Employee Kris = Niki.Clone() as Employee;
            Console.WriteLine(string.Format("IDCode:{0}\tAge:{1}\tDepartment:{2}", Kris.IDCode, Kris.Age, Kris.Department));
            ///開始改變Niki的值
            Niki.IDCode = "IDNiki";
            Niki.Age = 23;
            Niki.Department.Name = "Depart2";
            Console.WriteLine(string.Format("IDCode:{0}\tAge:{1}\tDepartment:{2}", Kris.IDCode, Kris.Age, Kris.Department));
            Console.ReadLine();
        }
複製代碼

調用執行結果如下

註意到Employee的IDCode屬string類型。理論上string類型是引用類型，但是由於該引用類型的特殊性（無論是實際還是語義），Object.MemberwiseClone方法仍舊為其創建了副本。也就是說，在淺拷貝過程，我們應該將字元串看成是值類型。Employee的Department屬性是一個引用類型，所以，如果改變了源對象Niki中的值，那麼副本Kris中的值也會隨之一起變動。

 Employee的深拷貝有多種實現方法，最簡單的方式是手動的對欄位進行逐個的賦值。但是這種方法容易出錯，也就是說，如果類型的欄位發生變化或有增減，那麼該拷貝方法也要發生相應的變化，所以，建議使用序列化的形式來進行深拷貝。Employee深拷貝的一種實現方式如下：

複製代碼 
    [Serializable]
    public class Employee:ICloneable
    {
        public string IDCode { get; set; }
        public int Age { get; set; }
        public Department Department { get; set; }

        #region OCloneable成員
        public object Clone()
        {
            using (Stream objectstream = new MemoryStream())
            {
                IFormatter formatter = new BinaryFormatter();
                formatter.Serialize(objectstream, this);
                objectstream.Seek(0, SeekOrigin.Begin);
                return formatter.Deserialize(objectstream) as Employee;
            }
        }
        #endregion
    }

    [Serializable]
    public class Department
    {
        public string Name{get;set;}
        public override string ToString()
        {
              return this.Name;
        }
    }
複製代碼

調用方法如下所示：

複製代碼 
            Employee Niki = new Employee()
            {
                IDCode = "IDaehyok",
                Age = 25,
                Department = new Department() { Name="Depart1" }
            };
            Employee Kris = Niki.Clone() as Employee;
            Console.WriteLine(string.Format("IDCode:{0}\tAge:{1}\tDepartment:{2}", Kris.IDCode, Kris.Age, Kris.Department));
            ///開始改變Niki的值
            Niki.IDCode = "IDNiki";
            Niki.Age = 23;
            Niki.Department.Name = "Depart2";
            Console.WriteLine(string.Format("IDCode:{0}\tAge:{1}\tDepartment:{2}", Kris.IDCode, Kris.Age, Kris.Department));
            Console.ReadLine();
複製代碼

最終代碼調用結果如下

可以發現再次改變Niki的值，不會對副本Kris產生影響。

由於介面ICloneable,只有一個模棱兩可的方法，所以，如果要在一個類中進行淺拷貝和深拷貝，只能由我們額外的實現兩個方法。聲明為DeepClone和Shallow。那麼最終代碼如下所示：

複製代碼 
    [Serializable]
    public class Employee:ICloneable
    {
        public string IDCode { get; set; }
        public int Age { get; set; }
        public Department Department { get; set; }

        #region OCloneable成員
        public object Clone()
        {
            return this.MemberwiseClone();
        }
        #endregion

        public Employee DeeptClone()
        {
            using (Stream objectstream = new MemoryStream())
            {
                IFormatter formatter = new BinaryFormatter();
                formatter.Serialize(objectstream, this);
                objectstream.Seek(0, SeekOrigin.Begin);
                return formatter.Deserialize(objectstream) as Employee;
            }
        }

        public Employee Shallow()
        {
            return Clone() as Employee;
        }
    }
複製代碼

 

建議15、使用dynamic來簡化反射實現

　　Dynamic是Framework4.0的新特性。dynamic的出現讓C#具有了弱類型的特性。編譯器在編譯的時候不再對類型進行檢查，編譯器預設dynamic對象支持開發者想要的任何類型。如果運行時不包含指定的特性，運行時程式會拋出一個RuntimeBinderException異常。

下麵我們先來看一個簡單的例子

複製代碼 
    public class DynamicSample
    {
        public string Name { get; set; }
        public int Add(int a, int b)
        {
            return a + b;
        }
    }
複製代碼

現在我們想調用上面實體類的Add方法，實現方式可以是這樣的：

            DynamicSample dynamicSample = new DynamicSample();
            var addMethod = typeof(DynamicSample).GetMethod("Add");
            int re = (int)addMethod.Invoke(dynamicSample, new object[] { 1, 2 });
            Console.WriteLine(re);

下麵我們再通過使用dynamic來實現一下：

            dynamic dynamic = new DynamicSample();
            int re2 = dynamic.Add(1, 2);
            Console.WriteLine(re2);

可以發現dynamic的實現方式很簡潔，而且性能也有所提升，當然上面一次的調用我們是看不出什麼效果的，假如上面的代碼我們進行調用了10000000次。

複製代碼 
            int times = 10000000;
            ////第一種調用方式
            DynamicSample reflectSample = new DynamicSample();
            var addMethod = typeof(DynamicSample).GetMethod("Add");
            Stopwatch watch1 = Stopwatch.StartNew();///用於測試運行時間
            for (var i = 0; i < times; i++)
            {
                addMethod.Invoke(reflectSample, new object[] { 1, 2 });
            }
            Console.WriteLine(string.Format("普通方法反射耗時：{0} 毫秒", watch1.ElapsedMilliseconds));

            ////第二種調用方式
            dynamic dynamicSample = new DynamicSample();
            Stopwatch watch2 = Stopwatch.StartNew();
            for (int i = 0; i < times; i++)
            {
                dynamicSample.Add(1, 2);
            }
            Console.WriteLine(string.Format("dynamic方式耗時：{0} 毫秒", watch2.ElapsedMilliseconds));

            ////第三種調用方式
            DynamicSample reflectSampleBetter = new DynamicSample();
            var addMethod2 = typeof(DynamicSample).GetMethod("Add");
            var delg = (Func<DynamicSample, int, int, int>)Delegate.CreateDelegate(typeof(Func<DynamicSample, int, int, int>), addMethod2);
            Stopwatch watch3 = Stopwatch.StartNew();
            for (var i = 0; i < times; i++)
            {
                delg(reflectSampleBetter, 1, 2);
            }
            Console.WriteLine(string.Format("優化的反射耗時：{0} 毫秒", watch3.ElapsedMilliseconds));
            Console.ReadLine();
複製代碼

調用執行後的結果為

現在可以看出很明顯的區別，普通方法調用發射執行效率遠遠的低於使用dynamic。第三種方式是我們優化了發射之後的執行時間，比使用dynamic也有所提升，但是並不是特別明顯，雖然帶來了性能的提升，不過卻犧牲了代碼的整潔性。這種實現方式在我看來是得不償失的。所以建議大家使用dynamic來優化發射。

 

到這裡為止，第一章的內容暫時已經整理完畢，感覺自己學了不少知識，繼續加油，接下來繼續進行第二章集合和LINQ的學習。

 

 


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

-Advertisement-
Play Games
更多相關文章
  • 運維自動化工具 Kickstart
    簡介： 批量安裝操作系統工具之 Kickstart ，RedHat 早前推出的產品（ 不多說了，現在都玩 Cobbler 啦 ）。 測試環境：CentOS 6.6 x86_64 minimal 一、安裝軟體包 二、配置 DHCP 三、配置 tftp 四、pxelinux.0 五、配置 NFS 六、最 ...
  • 運維自動化工具 Cobbler
    簡介： 關於操作系統安裝方面的自動化，早前我們使用 RedHat 推出的 Kickstart 來批量安裝操作系統，近年來 RedHat 又推出一個 Cobbler 。 Cobbler 使用 Python 開發，小巧輕便，能夠完成系統安裝、甚至一些服務的管理。（ 號稱是補鞋匠都能學會的工具 ） Cob ...
  • MVC 表單提交提示：已添加了具有相同鍵的項。
    MVC:頁面提交的時候報如下錯誤： 解決方案： 這個Model 裡面定義了重覆的自多so~~~ ...
  • C#icon托盤圖標的簡單知識
    在做整個類似QQ的畢業設計中，有一個小圖標把我給難了一陣子，就是托盤小圖標。 要完成的功能大約是，視窗選擇關閉時變成最小化到托盤圖標，雙擊托盤圖標顯示托盤圖標。 還是以登錄視窗為例子 要有托盤圖標首先需要一個notifyIcon，這個在工具箱中找。然後就是notifyic的相關屬性的設置了，首先需要 ...
  • Jquery頁面初始化的4種方式
    ...
  • .NET WinForm keyDown事件方向鍵不響應----C# C++/CLI
    在做3D漫游時，分別運用WASD和方向鍵，控制視角前後左右，KeyDown事件記錄漫游開始標記，但是WASD可以Debug進入，方向鍵卻始終無法進入，很奇怪的是，進不了KeyDown，卻能響應KeyUp事件 但是Ctrl+方向鍵和Alt+方向鍵卻可以進入，經過一番查找。很多文章中分析可能是因為方向鍵 ...
  • 理解ASP.NET MVC的DependencyResolver組件
    一、前言 DependencyResolver是MVC中一個重要的組件，從名字可以看出，它負責依賴對象的解析，可以說它是MVC框架內部使用的一個IOC容 器。MVC內部很多對象的創建都是通過它完成的，或許我們平時沒有直接用到它，但是如果你在使用unity、autofac，或者在看一些開源項目時，總 ...
  • .net中創建xml文件
    創建二種方式 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類