.NET項目升級手記:可為空引用

来源:https://www.cnblogs.com/podolski/archive/2020/04/13/12692888.html
-Advertisement-
Play Games

c 8引入了新特性:“可為空引用”( "詳情" ),這個功能個人覺得挺好的,能夠非常明確的表現程式設計者的意圖,編譯器能夠進行檢查,盡最大可能減小NullReferenceException錯誤。 如果是新項目,那麼上手很簡單,一點點搭建起來,遇山開山,遇河渡河。但是對於我這種手頭上的項目大多都是以 ...


c# 8引入了新特性:“可為空引用”(詳情),這個功能個人覺得挺好的,能夠非常明確的表現程式設計者的意圖,編譯器能夠進行檢查,盡最大可能減小NullReferenceException錯誤。

如果是新項目,那麼上手很簡單,一點點搭建起來,遇山開山,遇河渡河。但是對於我這種手頭上的項目大多都是以前創建的情況,就要稍微做那邊麽一點操作了。

要看完整說明,請查看開頭的那個鏈接。

準備

首先評估一下幾個條件:

  1. 項目可以基於.NET CORE 3.0及以上編譯。如果不行,那麼就請直接右上角點×。
  2. 是不是大多數的變數都需要null引用?如果是的話,個人覺得不值得費勁了。

操作

以一個ASP.NET WEBAPI為例,項目修改前是能夠正常編譯無錯誤無警告的。

1. 啟用Nullable(可為空引用類型)

Nullable預設是不啟用的,需要做一些修改以啟用。有兩種方式:

  • 修改csproj文件,在ProperyGroup裡面添加enable項。

對於比較小型的項目,可以直接修改,這樣彈出來的警告或者錯誤會比較少,方便我們快速改正。

  • 使用編譯器指令#nullable enable和#nullable restore進行修改。在代碼段的開頭enable,結尾處restore。

對於中大型項目,直接使用第一種方式進行修改會導致大量的警告,很容易一團糟;可以通過編譯器指令對單文件或者單類進行修改操作,一點一點地修改。

2. 修改代碼

我的項目使用第一種方法的的情況下有24個警告(編譯後有67個),也不知道算多還是算少。

實體類

[DataContract]
    [Table("recordinfo")]
    public class RecordInfo : InfoBase
    {
        /// <summary>
        /// 記錄ID
        /// </summary>
        [DataMember]
        [Key]
        public string RecordNum { get; set; }
        /// <summary>
        /// 車輛RFID號碼
        /// </summary>
        [DataMember]
        public string CarID { get; set; }

RecordNum為主鍵,通過EF進行映射,結果也不會為null,所以聲明應該保持原樣即可。CarID不是主鍵,有可能是null,因此應當顯式聲明為string?,表示可以為空,刪除警告。

編譯器檢查,RecordNum沒有被初始化,我們的設計意圖告訴編譯器了,但是代碼還沒有保證這個不能為空,因此需要修改代碼保證RecordNum不為空。

這裡使用null包容運算符(!)來進行操作,提示編譯器這個位置實際上不會為null。

//string的default為null,通過增加!告訴編譯器,這塊初始化的時候實際上是不為空的。
public string RecordNum { get; set; } = default!;

null包容運算符並不能確保不是null,如果可以使用代碼確保不為null,那麼使用代碼會是更優選擇。考慮如下代碼:

//我經常使用String.IsNullOrWhiteSpace來進行檢查,空文本對我的業務沒有意義,因此適用。
public string RecordNum { get; set; } = "";

特別提示:
可為空引用類型檢查是編譯器的行為,它可以提供編譯時檢查,但是不提供運行時檢查,如果使用外部代碼調用,那麼是否為空都可以進行賦值。

很明顯,上面代碼運行時也很難保證不是null,我們可以再改進一下。

public string RecordNum
{
    get => recordNum;
    set => recordNum = value ?? "";
}
private string recordNum = "";

官方推薦對POCO類使用構造函數保證不為空。
指定了default!的情況,ASP.NET CORE WEBAPI會內部自動標註[Required],遠程調用如果缺失參數,會提示bad request。

DataContext類

DataContext也是類似的,主要是DbSet對象的引用問題。

來自.NET Class Library

//BaseDirectory的返回是string?類型的
var baseDirectory = System.AppDomain.CurrentDomain.BaseDirectory;
//Path.Combine()不接受string?,提示錯誤。
var xmlPath = Path.Combine(baseDirectory, System.AppDomain.CurrentDomain.FriendlyName + ".xml");

這是一個潛在的bug點,對於以上代碼,很顯然BaseDirectory的返回為null不符合我們的設計,我們可以進行如下改造。

var baseDirectory = System.AppDomain.CurrentDomain.BaseDirectory;
if (baseDirectory == null) throw new ArgumentNullException("baseDirectory");
var xmlPath = Path.Combine(baseDirectory, System.AppDomain.CurrentDomain.FriendlyName + ".xml");

泛型類

public class ReturnData<T>
{
    //整個類型會提示Data未能初始化,ErrorMsg未能初始化。
    public ReturnData(){ }
    public ReturnData(T data) => Data = data;
    public ReturnData(string error) => ErrorMsg = error;
    /// <summary>
    /// 頁面數據
    /// </summary>
    public T Data { get; set; }
    public string ErrorMsg { get; set; }
}

設計意圖:Data與ErrorMsg不同時為空,也不同時有值。

基於設計,可以做如下修改。註意添加了class約束。

public class ReturnData<T>
    where T: class
{
    public ReturnData(){ }
    public ReturnData(T data) => Data = data;
    public ReturnData(string error) => ErrorMsg = error;
    /// <summary>
    /// 頁面數據
    /// </summary>
    public T? Data { get; set; }
    public string? ErrorMsg { get; set; }
}

其他例子

using ManageDataContext context = new ManageDataContext();
var props = contextType.GetProperty($"{namestring}s");
//props提示有可能為null
var dbset = (props.GetValue(context) as DbSet<T>);
//提示dbset可能為null
var res = await dbset.FindAsync(value);

可以調整為下麵的形式:

using ManageDataContext context = new ManageDataContext();
var props = contextType.GetProperty($"{namestring}s");
//判斷props可以解決問題。
if (props == null) throw new ArgumentNullException("Props");
var dbset = (props.GetValue(context) as DbSet<T>);
//判斷dbset可以解決問題。
if (dbset == null) throw new ArgumentNullException("dbset");
var res = await dbset.FindAsync(value);

註意,將as替換為強制轉換,並不能消除警告。

總結

最後消除了所有的警告,改造結束。

這個新的語言特性可以幫助我們發現一些潛在的bug點,幫助我們養成良好的編程習慣,也便於我們告訴其他人我們的設計意圖。

編譯器能幫我們做的工作,就沒必要自己再費勁做了,懶的不行,我得歇會兒。


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

-Advertisement-
Play Games
更多相關文章
  • 標題可能有點不好理解,我解釋一下: 術語指的是常用辭彙,比如用戶(User)、名稱(Name)、郵箱(Email)等。 帶修飾符指的是UI上需要呈現`用戶:`、`名稱:`、`郵箱:`等這些情況。 由於之前已經定義過了用戶此類辭彙的多語言,如果還需要再對它們帶冒號的版本定義一次多語言,這個過程會非常冗 ...
  • WPF的UI多語言切換核心代碼: CultureInfo.CurrentUICulture = CultureInfo.CreateSpecificCulture("語種"); 關於上面的語種如何傳進去,什麼時候調用上面的方法是跟你具體業務有關的。 我的做法: 1. 什麼時候調用 因為用戶的語種基本 ...
  • 關於多語言,其實有很多經驗可以分享。本篇文章先說說最基礎的。 下圖:利用自帶的resx文件格式記錄各種通用辭彙的多語言(簡體中文、繁體中文、英文) 下圖是英文的示例(註意:Access Modifier必須是`Public`,否則無法在xaml文件中引用) 使用方法: 1. 聲明命名空間 xmlns ...
  • 前言 代碼胡亂寫,維護火葬場! 在平時工作中遇到前同事寫介面這樣返回值 當介面返回1時,不去看他的代碼就永遠猜不到這個1代表的是返回成功還是返回值 稍微好點的 維護和改bug簡直讓人瘋狂,導致大部分時間浪費在“體會”別人返回值的邏輯中 天天加班與救bug於水火之中 合理分配前後端返回值很重要! 一般 ...
  • 3.1中提到我定義了一些公共配置項,現在我來說一說配置項的用法: 1. 提供軟體標識符 1 public static class CfgIndentifiers 2 { 3 public static readonly string Identifier = 4 #if DEBUG 5 "DEBU ...
  • 在上一篇文章abp(net core)+easyui+efcore實現倉儲管理系統——入庫管理之七(四十三)中我們實現了測試了入庫單新增功能,不過還存在一些BUG。今天我們來繼續完善入庫單信息新增功能。同時講講如何通過瀏覽器的調試功能來調整CSS樣式。 ...
  • 1.什麼是Swagger/OpenAPI? Swagger是一個與語言無關的規範,用於描述REST API。因為Swagger項目已捐贈給OpenAPI計劃,所以也叫OpenAPI。它允許電腦和人員瞭解服務的功能,可以直接線上訪問測試API功能。而Swagger UI提供了基於Web的UI,它使用 ...
  • 視頻, 圖文向新手解釋, 如何快速獲得開發Blazor的環境. ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...