.NET WebAPI 自定義 NullableConverter 解決可為空類型欄位入參“”空字元觸發轉換異常問題

来源:https://www.cnblogs.com/berkerdong/archive/2022/09/20/16712772.html
-Advertisement-
Play Games

最近在項目中啟用了Nullable 可為空的類型,這個特性確實很好用,在 WebAPI 的入參上可以直接採用 ? 來標記一個欄位是否允許為空,但是使用過程中遇到瞭如下一個問題,比如創建部門介面 我們定義入參模型如下: public class DtoDepartment { /// <summary ...


最近在項目中啟用了Nullable 可為空的類型,這個特性確實很好用,在 WebAPI 的入參上可以直接採用 ? 來標記一個欄位是否允許為空,但是使用過程中遇到瞭如下一個問題,比如創建部門介面

我們定義入參模型如下:

public class DtoDepartment
{
    /// <summary>
    /// 部門名稱
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// 上級部門ID
    /// </summary>
    public Guid? ParentId { get; set; }
}

我們這裡將上級部門ID定義為可以為空的類型,因為有些部門不存在上級部門
然後定義這樣一個介面

[HttpPost("CreateDepartment")]
public bool CreateDepartment(DtoDepartment department)
{
    //省略業務邏輯
    return true;
}

當前端請求的時候傳入如下Json 時則就會觸發異常

{
  "name": "商務一部",
  "parentId": ""
}

異常內容為:

{
  "errMsg": "The department field is required. | The JSON value could not be converted to System.Nullable`1[System.Guid]. Path: $.parentId | LineNumber: 2 | BytePositionInLine: 16."
}

像這樣的情況是因為雖然我們定義的 Dto 允許上級部門ID欄位為空,但是前端調用的時候 parentId 實際傳入的是 "" 空字元串,當空字元串給 Guid? 轉換的時候就會產生這樣的異常,當遇到這樣的情況時,我們可以要求前端調整 JSON 格式如下

{
  "name": "商務一部",
  "parentId": null
}

前端只要給 parentId 的賦值從 "" 調整為 null 之後我們的介面就可以正常運行了,但是有的時候前端的組件這裡取值可能是和一些組件庫綁定的,不太方便綁定預設值為 null,很多情況下組件庫組件的預設值都是 "" 空字元串的形式,所以經過和前端同事多次溝通之後想著從後端徹底解決這個問題,經過研究之後編寫了下麵的 NullableConverter 轉換器,只要在項目啟動的時候註冊到 AddJsonOptions 其中即可。

using System.Text.Json;
using System.Text.Json.Serialization;

namespace Common.JsonConverter
{
    public class NullableConverter<T> : JsonConverter<T?> where T : struct
    {

        public override T? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
            if (reader.TokenType == JsonTokenType.String)
            {
                if (string.IsNullOrEmpty(reader.GetString()) || string.IsNullOrWhiteSpace(reader.GetString()))
                {
                    return null;
                }
            }
            return JsonSerializer.Deserialize<T>(ref reader, options);
        }


        public override void Write(Utf8JsonWriter writer, T? value, JsonSerializerOptions options)
        {
            JsonSerializer.Serialize(writer, value!.Value, options);
        }

    }
}

上面我們只是用 Guid? 舉了一個例子,實際情況下

  • DateTime?
  • DateTimeOffset?
  • long?
  • int?
  • double?
  • decimal?
  • float?
  • Guid?
  • bool?

都有可能存在這個問題,所以我們為這幾種類型都配置了這個可為空類型轉換器。這樣前端在調用介面時配到這類型的欄位,傳 "" 和 null 我們後端就都可以接收了,收到之後欄位的值都是 null

我這裡項目採用的是微軟的 System.Text.Json 處理的 Json 序列化,註冊配置 NullableConverter 代碼如下:

#region 註冊 Json 序列化配置
builder.Services.AddControllers().AddJsonOptions(options =>
{
    options.JsonSerializerOptions.Converters.Add(new Common.JsonConverter.NullableConverter<DateTime>());
    options.JsonSerializerOptions.Converters.Add(new Common.JsonConverter.NullableConverter<DateTimeOffset>());
    options.JsonSerializerOptions.Converters.Add(new Common.JsonConverter.NullableConverter<long>());
    options.JsonSerializerOptions.Converters.Add(new Common.JsonConverter.NullableConverter<int>());
    options.JsonSerializerOptions.Converters.Add(new Common.JsonConverter.NullableConverter<double>());
    options.JsonSerializerOptions.Converters.Add(new Common.JsonConverter.NullableConverter<decimal>());
    options.JsonSerializerOptions.Converters.Add(new Common.JsonConverter.NullableConverter<float>());
    options.JsonSerializerOptions.Converters.Add(new Common.JsonConverter.NullableConverter<Guid>());
    options.JsonSerializerOptions.Converters.Add(new Common.JsonConverter.NullableConverter<bool>());
});
#endregion

至此 .NET WebAPI 自定義 NullableConverter 解決可為空類型欄位入參“”空字元觸發轉換異常問題 就講解完了,有任何不明白的,可以在文章下麵評論或者私信我,歡迎大家積極的討論交流,有興趣的朋友可以關註我目前在維護的一個 .NET 基礎框架項目,項目地址如下
https://github.com/berkerdong/NetEngine.git
https://gitee.com/berkerdong/NetEngine.git


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

-Advertisement-
Play Games
更多相關文章
  • 多用戶即時通訊系統01 1.項目開發流程 2.需求分析 用戶登錄 拉取線上用戶列表 無異常退出(包括客戶端和服務端) 私聊 群聊 發文件 伺服器推送新聞/廣播 3.設計階段 3.1界面設計 用戶登錄: 拉取線上用戶列表: 私聊: 群聊: 發文件: 文件伺服器推送新聞: 3.2通訊系統整體設計 總結: ...
  • 實時展示用戶上傳的頭像 總體思路 """ 1.首先需要給對應的上傳頭像input框綁定一個文本域變化事件 (當檢測到用戶對該文件框上傳了頭像就會觸發一系列操作) 2.再生成一個文件閱讀器對象 3.再獲取用戶上傳的文件頭像 4.把用戶上傳的文件頭像交給文件閱讀器對象FileReader讀取 5.利用文 ...
  • 1 垃圾收集三件事 哪些記憶體需要回收:死去的對象需要回收 什麼時候回收 如何回收 按照jvm記憶體區域劃分原則:程式計數器、虛擬機棧、本地方法棧3個區域的記憶體隨線程創建而劃分,因此線程結束時,記憶體也自動釋放。 本章節分析的是Java堆和方法區的記憶體管理策略 1、虛擬機棧、本地方法棧,棧中的棧幀隨著方法 ...
  • Python中,要想知道一個字元串有多少個字元(獲得字元串長度),或者一個字元串占用多少個位元組,可以使用len()函數。 語法格式: len(string) string 用於指定要進行長度統計的字元串 示例: a = 'www.baidu.com' print(len(a)) 輸出 13 在 Py ...
  • 二、散點圖 import seaborn as sns import matplotlib.pyplot as plt sns.set_theme(style = 'whitegrid') # 載入 diamonds 數據集 diamonds = sns.load_dataset('diamonds ...
  • 能對比測試 為了直觀地感受 Disruptor 有多快,設計了一個性能對比測試:Producer 發佈 1 億次事件,從發佈第一個事件開始計時,捕捉 Consumer 處理完所有事件的耗時。 測試用例在 Producer 如何將事件通知到 Consumer 的實現方式上,設計了兩種不同的實現: Pr ...
  • 學習網站: http://seaborn.pydata.org/examples/scatterplot_matrix.html 一、Anscombe's quartet(安斯庫姆四重奏) 1973年,統計學家F.J. Anscombe構造出了四組奇特的數據。它告訴人們,數據分析之前,描繪數據所對應 ...
  • 類型載入器設計(Type Loader Design) 原文:https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/botr/type-loader.md 作者: Ladi Prosek - 2007 翻譯:幾秋 (https ...
一周排行
    -Advertisement-
    Play Games
  • 一:背景 1.講故事 在分析的眾多dump中,經常會遇到各種奇葩的問題,僅通過dump這種快照形式還是有很多問題搞不定,而通過 perfview 這種粒度又太粗,很難找到問題之所在,真的很頭疼,比如本篇的 短命線程 問題,參考圖如下: 我們在 t2 時刻抓取的dump對查看 短命線程 毫無幫助,我根 ...
  • 在日常後端Api開發中,我們跟前端的溝通中,通常需要協商好入參的數據類型,和參數是通過什麼方式存在於請求中的,是表單(form)、請求體(body)、地址欄參數(query)、還是說通過請求頭(header)。 當協商好後,我們的介面又需要怎麼去接收這些數據呢?很多小伙伴可能上手就是直接寫一個實體, ...
  • 許多情況下我們需要用到攝像頭獲取圖像,進而處理圖像,這篇博文介紹利用pyqt5、OpenCV實現用電腦上連接的攝像頭拍照並保存照片。為了使用和後續開發方便,這裡利用pyqt5設計了個相機界面,後面將介紹如何實現,要點包括界面設計、邏輯實現及完整代碼。 ...
  • 思路分析 註冊頁面需要對用戶提交的數據進行校驗,並且需要對用戶輸入錯誤的地方進行提示! 所有我們需要使用forms組件搭建註冊頁面! 平時我們書寫form是組件的時候是在views.py裡面書寫的, 但是為了接耦合,我們需要將forms組件都單獨寫在一個地方,需要用的時候導入就行! 例如,在項目文件 ...
  • 思路分析 登錄頁面,我們還是採用ajax的方式提交用戶數據 唯一需要學習的是如何製作圖片驗證碼! 具體的登錄頁面效果圖如下: 如何製作圖片驗證碼 推導步驟1:在img標簽的src屬性里放上驗證碼的請求路徑 補充1.img的src屬性: 1.圖片路徑 2.url 3.圖片的二進位數據 補充2:字體樣式 ...
  • 哈嘍,兄弟們! 最近有許多小伙伴都在吐槽打工好難。 每天都是執行許多重覆的任務 例如閱讀新聞、發郵件、查看天氣、打開書簽、清理文件夾等等, 使用自動化腳本,就無需手動一次又一次地完成這些任務, 非常方便啊有木有?! 而在某種程度上,Python 就是自動化的代名詞。 今天就來和大家一起學習一下, 用 ...
  • 作者:IT王小二 博客:https://itwxe.com 前面小二介紹過使用Typora+PicGo+LskyPro打造舒適寫作環境,那時候需要使用水印功能,但是小二在升級LskyPro2.x版本發現有很多不如人意的東西,遂棄用LskyPro使用MinIO結合代碼實現自己需要的圖床功能,也適合以後 ...
  • OpenAI Gym是一款用於研發和比較強化學習演算法的工具包,本文主要介紹Gym模擬環境的功能和工具包的使用方法,並詳細介紹其中的經典控制問題中的倒立擺(CartPole-v0/1)問題。最後針對倒立擺問題如何建立控制模型並採用爬山演算法優化進行了介紹,並給出了相應的完整python代碼示例和解釋。要... ...
  • python爬蟲瀏覽器偽裝 #導入urllib.request模塊 import urllib.request #設置請求頭 headers=("User-Agent","Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, l ...
  • 前端代碼搭建 主要利用的是bootstrap3中js插件里的模態框版塊 <li><a href="" data-toggle="modal" data-target=".bs-example-modal-lg">修改密碼</a></li> <div class="modal fade bs-exam ...