編寫高質量代碼的30條黃金守則(首選隱式類型轉換)

2024-07-21 02:03:45

字體：大中小

來源：轉載

供稿：網友

編寫高質量代碼的30條黃金守則-Day 01(首選隱式類型轉換)，本文由比特飛原創發布，轉載務必在文章開頭附帶鏈接：https://www.byteflying.com/archives/6455

該系列文章由比特飛原創發布，計劃用三個月時間寫完全30篇文章，為大家提供編寫高質量代碼的一般準則。

1、概述

隱式類型轉換是微軟為了 C# 支持匿名類型而加入的，使用 var 通常可以使代碼的可讀性更強，甚至是幫我們解決一些嚴重的性能問題。為了清楚的明白 var 的作用機制，我們首先來看看編譯器為 var 做了哪些工作？

2、編譯器為var關鍵字做了什么？

首先 var 為語法糖，編譯器在編譯時根據右值推斷出表達式類型，再由編譯器將推斷出的表達式類型寫入到 IL 中，所以如下2段代碼在 IL 中完全一致。

編譯期間，編譯器根據右值“SomeString”，可以推斷出這個表達式（右值）的類型為 string 類型，于是將var替換為string，再將它寫到IL中，于是以上兩段初始化foo的代碼結果完全一致。

string foo = "SomeString";var foo = "SomeString";

我們再來看一下兩段代碼的IL：

本文示例的源代碼

DnSpy 的反編譯結果

Microsoft 技術支持文檔中 ldstr 的解釋

注意：string也是語法糖，編譯時，string被替換為System.String寫進IL。

于是我們得到了一個重要的結論：

var為語法糖，在編譯期間就已經被編譯器所決定，開發人員無法為編譯器決定類型。

隱式類型轉換為上述代碼帶來了良好的可讀性，任何一名開發人員都會知道第2行代碼的var的類型，它讓我們更加的關注代碼片段中我們所需要關注的部分，而不是把重點放在它的類型上。因為大多數時候，這都是沒有意義的。

3、隱式類型轉換所帶來的良好可讀性

為了明白良好可讀性的問題，我們先來看一個代碼片段：

var foo = new SomeType();

以上代碼清晰明了，對于維護代碼的人來說，它沒有增加任何的理解成本，foo的類型就是SomeType類型。很多優秀開源項目中的大量被使用的工廠模式，也提供了類似的方法，如下代碼片段：

var huaWei = PhoneFactory.CreatePhone();

一個簡單的靜態工廠類 PhoneFactory ，公開了 CreatePhone 方法，閱讀這段代碼的開發人員，在幾乎沒有增加理解成本的情況下，很清楚的知道huaWei代表手機工廠類所生產的一個手機對象。但是下面的代碼，情況可能就稍有不同了：

var result = someObject.DoSomething(someParameter);

你無法輕松的知道result的類型和它所表達的意義，事實上，它的不良好的可讀性，表現在以下幾個方面：

1、在此處，result這個變量名并不是最好的選擇；

2、someObject的含義不明；

3、DoSomething含糊不清；

4、無法明確的知道someParameter代碼什么。

如果換成以下代碼，情況會好很多：

var mostPopularPhone = someObject.DoSomething(someParameter);

情況有所好轉，意思也更清楚。結合語義上下文，var的類型不言自明。但是在這種情況下，我依然建議大家將代碼改為以下形式：

Phone mostPopularPhone = someObject.DoSomething(someParameter);

這被我寫在之前所在公司的開發手冊上，我相信我的經驗一定是正確的。

讓我們再來看一個新的示例：

var score = GetSomeNumber(); var rate = score / 100;

rate的類型由變量score決定，然后開發者無法一眼看出score的類型，所以這是一個不良好的可讀性的代碼片段，我們應該改為：

var score = GetSomeNumber(); double rate = score / 100;

怎么樣，是不是看到這樣的代碼，心里舒服多了？因為你的理解成本更低了，心情舒暢了，一下子搬磚都能搬到5樓了。

于是，我們有了兩點總結：

1、當含義明確，在代碼上下文較為清楚時（簡單的變量定義或工廠方法），建議優先使用var；

2、在其它復雜情況下，盡量直接寫出var的類型。

隱式類型轉換所帶來的絕非僅僅是良好的可讀性，它有時可能會幫我們消除一些難以發現的Bug，這又是怎么回事呢？

4、隱式類型轉換幫我們解決嚴重的性能問題

人自以為自己是世界上最聰明的生物，事實上并非如此，有時候，編譯器比我們聰明得多，也可靠得多。

我們看看以下兩個代碼片段：

public IEnumerable<string> GetPhoneStartsWith1(string prefix) {  IEnumerable<string> phones =          from r in db.Phones          select r.PhoneName;   var result = phones.Where(r => r.StartsWith(prefix));  return result;}public IEnumerable<string> GetPhoneStartsWith2(string prefix) {  var phones =    from r in db.Phones    select r.PhoneName;   var result = phones.Where(r => r.StartsWith(prefix));  return result;}

以上兩段代碼有何不同？GetPhoneStartsWith1 方法中的 phones 原先的返回類型應當為 IQueryable<string>，但在這里被顯式聲明的 phones 的 IEnumerable<string> 強制轉換了，熟悉 EF 的朋友們一定知道，IQueryable<T> 為延遲加載，本身并不會立刻查詢數據庫，事實上它只生成了一個表達式樹，在最終需要使用數據的時候才會真正執行查詢動作。

于是 GetPhoneStartsWith1 方法將數據庫中的可能的所有數據全部取回本地，再由 var result = phones.Where(r => r.StartsWith(prefix)); 執行本地過濾，消耗了太多網絡資源，并且使用了 .Net 的數據過濾機制。

GetPhoneStartsWith2 方法則不然，phones 的類型被編譯器推斷為 IQueryable<string> ，并不會因此執行查詢操作，真正的查詢動作由 var result = phones.Where(r => r.StartsWith(prefix)); 執行，也就是說，它的數據過濾動作由數據庫引擎負責運算，最終只將符合條件的數據發送回本地，既節省了網絡傳遞成本，又節省了運算成本，豈不是一舉兩得？

5、總結