C#8.0 可空參考型別-有解無憂

介紹

我們的專案代碼運行時最頻繁的錯誤之一就是 System.NullReferenceException 例外，c#8.0增加的可為空參考型別就是用來幫助開發者降低甚至消除NULL例外，我們需要注意的是可空參考型別是語法級別的功能，也就是代碼撰寫的時候就會受到編程約束，這個與可為空值型別是不一樣的，專案支持c#8.0請參見C# 語言版本控制，

在專案中啟用可空參考型別支持

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <Nullable>enable</Nullable>
  </PropertyGroup>
    
</Project>

在專案檔案中增加<Nullable>enable</Nullable>后，專案代碼中的參考型別將被決議拆分為不可空參考型別和可空參考型別，

將警告提升為例外

可空參考型別功能是以警告的形式出現，并不會干擾專案生成編譯，約束力較弱，如果想嚴格要求自身，那我們可將特定的警告變為例外來提升約束力，

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <Nullable>enable</Nullable>   				           
    <WarningsAsErrors>
    	$(WarningsAsErrors);CS8600;CS8601;CS8602;CS8603;CS8604;CS8609;CS8610;CS8614;CS8616;CS8618;CS8619;CS8622;CS8625
    </WarningsAsErrors>
  </PropertyGroup>
    
</Project>

相關技術檔案C# 編譯器選項 - 錯誤和警告 | Microsoft Docs，Non-nullable references with C# 8 and .NET Core 3.0 · Cezary Pi?tek Blog (cezarypiatek.github.io)，大家在撰寫代碼時遇到Microsoft.CodeAnalysis.CSharp分析器所給的警告代碼，都可按照自己的要求將其變為例外來約束自己，

將變數標注為可空參考型別

我們平時使用的參考型別屬于不可空參考型別，在其后附加?便為可空參考型別，

string name; //不可空字串
string? adress; //可空字串

泛型

public TKey GetKey<TKey>()
{
    //必須回傳不可空型別
}

public TValue? GetValue<TValue>()
{
    //可回傳可空型別
}

使用示例

如上示例，由于Student擁有默認的空建構式new Student(),此建構式會使Name和Adress屬性為null，所以分析器發出了CS8618的警告，

我們將空建構式寫上，此時警告智能的轉移到建構式上了，

我們在建構式中將可能為null的string型別屬性附上值，警告消除，而string?型別無需處理，因為它是允許為null的，

以上兩種方式也可以消除警告，

在GetStudentNames方法中，我們使用Student的EnglishName屬性時，分析器發出了CS8604警告，因為EnglishName屬性是可空參考型別，無法放入List<string>中，只能放入在List<string?>中，

我們使用??判斷當EnglishName為null時，使用不可空參考型別屬性Name，此時CS8604警告消除，

進階

可空參考型別模式中，屬性是可以被拆分為兩種模式的，其一是屬性是否可被賦值null，其二是屬性的值是否可能為null，大家可能對這句話理解起來有點懵，請接著看下面的講解，

[AllowNull]

不可為null的參考型別屬性允許被賦值null

上面代碼中，Adress屬性即使被賦值null，也不會使其值為null，不會在代碼中引發潛在的Null例外，所以此場景是合理且被允許的，

[DisallowNull]

可為null的參考型別屬性不允許賦值為null

Adress屬性雖然默認值是null，但對其賦值null是不合理的，雖然不能賦值null，但獲取Adress屬性的值時仍可能為null，大家可在合適的場景使用[DisallowNull]，

[NotNull]

可為null的參考型別屬性的值永遠不會是null，可放心使用

我們使用GetStudentAdress方法回傳Student的Adress屬性，分析器并沒有發出警告，因為分析器通過[NotNull]特性也知道了Adress屬性的值永遠不會為null，

我們嘗試將Adress屬性改為可能回傳null值，分析器立馬發出了CS8603警告，很給力，

[NotNullIfNotNull]

這個特性作用于方法中，用于告訴其他程式員只要你不給我的方法傳null參，我就不會回傳null給你，你看著辦，

[return: NotNullIfNotNull("student")]
public string? GetStudentAdress(Student? student)
{
    return student?.Adress;
}

adress和adress2有著不同的待遇，

缺陷

有些場景分析器無法分析出潛在的null例外

Struct

public struct Student
{
    public string FirstName;
    public string? MiddleName;
    public string LastName;
}

public static class Program
{
    public static void PrintStudent(Student student)
    {
        Console.WriteLine($"First name: {student.FirstName.ToUpper()}");
        Console.WriteLine($"Middle name: {student.MiddleName?.ToUpper()}");
        Console.WriteLine($"Last name: {student.LastName.ToUpper()}");
    }

    public static void Main() => PrintStudent(default(FirstName));
    public static void Main2() => PrintStudent(new Student());
}

default(FirstName) 和new Student()中的FirstName 和 LastName 運行時為 null，編輯器此時未出現任何警告，

public struct Foo<T>
{
    public T Bar { get; set; }
}

public static class Program
{
    public static void Main()
    {
        string s = default(Foo<string>).Bar;
        string s2 = new Foo<string>().Bar;
    }
}

屬性 Bar 在運行時為 null,而s和s2是不可為null字串型別，編輯器此時未出現任何警告，

陣列

陣列也是可為 null 的參考型別中的已知缺陷

using System;

public static class Program
{
    public static void Main()
    {
        string[] values = new string[10];
        string s = values[0];
        Console.WriteLine(s.ToUpper());
    }
}

代碼中的陣列宣告其元素為不可為null的string，而其元素在初始化時都為null，編輯器此時未出現任何警告，

總結

將參考型別拆分為可空參考型別和不可空參考型別可以為我們的專案代碼帶來質的提升，團隊之間協作或者使用第三方的類別庫都可以通過?標識來知道方法的某個引數傳null不會引發例外、屬性賦值null不會引發例外，反之我們使用某些屬性或者方法的返參也可以知道其是否可能為null，對于不可能為null的變數我們就無需再麻煩的檢測null值了，而在以前，我們可能需要對每個變數都需要做null判斷，感興趣的同學趕緊給自己的專案加入這個功能吧，

我們正在行動，新的框架、新的生態

我們的目標是自由的、易用的、可塑性強的、功能豐富的、健壯的，

所以我們借鑒Building blocks的設計理念，正在做一個新的框架MASA Framework，它有哪些特點呢？

原生支持Dapr，且允許將Dapr替換成傳統通信方式
架構不限，單體應用、SOA、微服務都支持
支持.Net原生框架，降低學習負擔，除特定領域必須引入的概念，堅持不造新輪子
豐富的生態支持，除了框架以外還有組件庫、權限中心、配置中心、故障排查中心、報警中心等一系列產品
核心代碼庫的單元測驗覆寫率90%+
開源、免費、社區驅動
還有什么？我們在等你，一起來討論

經過幾個月的生產專案實踐，已完成POC，目前正在把之前的積累重構到新的開源專案中

目前原始碼已開始同步到Github（檔案站點在規劃中，會慢慢完善起來）：

MASA.BuildingBlocks

MASA.Contrib

MASA.Utils

MASA.EShop

BlazorComponent

MASA.Blazor

QQ群：7424099

微信群：加技術運營微信（MasaStackTechOps），備注來意，邀請進群

? ------ END ------

作者簡介

吳煒來：MASA技術團隊成員，

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/419889.html

標籤：.NET技术

上一篇：C#8.0 可空參考型別

下一篇：在cshtml檔案中使用預編譯語法

C#8.0 可空參考型別

介紹

目錄