Web API介面返回實現類集合的姿勢瞭解

来源:https://www.cnblogs.com/Dotnet9-com/archive/2023/03/19/17234396.html
-Advertisement-
Play Games

大家好,我是沙漠盡頭的狼。 一. 問題描述 如下圖,定義兩個子類Student和Employ,都繼承自抽象類PersonBase: public abstract class PersonBase { public string Name { get; set; } protected Person ...


大家好,我是沙漠盡頭的狼。

一. 問題描述

如下圖,定義兩個子類Student和Employ,都繼承自抽象類PersonBase:

public abstract class PersonBase
{
    public string Name { get; set; }

    protected PersonBase(string name)
    {
        Name = name;
    }
}

public class Student : PersonBase
{
    public string Number { get; set; }

    public Student(string name, string number) : base(name)
    {
        Number = number;
    }
}

public class Employ : PersonBase
{
    public string CompanyName { get; set; }

    public Employ(string name, string companyName) : base(name)
    {
        CompanyName = companyName;
    }
}

添加Web API介面返回基類集合:

[ApiController]
[Route("[controller]")]
public class TestController : ControllerBase
{
    [HttpGet(Name = "GetDetails")]
    public IEnumerable<PersonBase> Get()
    {
        return new List<PersonBase>()
        {
            new Student("學生A", "學生號01"),
            new Employ("職員01", "百度")
        };
    }
}

介面返回值:

[
  {
    "name": "學生A"
  },
  {
    "name": "職員01"
  }
]

發現問題了嗎?Student類和Employ類實例的擴展屬性(Student的Number屬性,Employ的Company屬性)都未被序列化展示,那麼怎麼序列化子類的所有屬性呢?

二、實現類的所有屬性序列化

參考微軟文檔《如何使用System.Text.Json序列化派生類的屬性》,有兩種實現方式站長覺得比較簡單。

2.1、.NET 7之前的實現方式

在 .NET 7 之前的版本中,System.Text.Json 不支持多態類型層次結構的序列化。 例如,如果介面的返回值類型為介面或抽象類集合,那麼即使運行時類型具有其他屬性,也只會序列化對介面或抽象類定義的屬性。

解決方案:將介面返回值由IEnumerable<PersonBase>改為object,介面實現的List<PersonBase>改為List<object>:

[HttpGet(Name = "GetDetails")]
public object Get()
{
    return new List<object>()
    {
        new Student("學生A", "學生號01"),
        new Employ("職員01", "百度")
    };
}

修改後,介面成功返回詳細JSON信息:

[
  {
    "number": "學生號01",
    "name": "學生A"
  },
  {
    "companyName": "百度",
    "name": "職員01"
  }
]

原理: 改為Object後,預設就是對實現類進行序列化了,改之前System.Text.Json只認識實現類的爸爸。

2.2、.NET 7及以後的實現方式

從 .NET 7 開始,System.Text.Json 支持使用特性標註的多態類型層次結構序列化和反序列化。

我們將介面恢復,在抽象類上添加特性,標明基類序列化時需要映射的子類類型:

[JsonDerivedType(typeof(Student))]
[JsonDerivedType(typeof(Employ))]
public abstract class PersonBase

問題解決,介面返回值同上。

文檔關於JsonDerivedTypeAttribute的描述:當放置在類型聲明中時,則指示應選擇指定的子類型進行多態序列化。 它還公開用於指定類型鑒別器的功能。

三、總結

上面兩種方式看.NET版本選擇,第二種方式需要您明確知道子類類型,詳細使用請看微軟文檔:如何使用System.Text.Json序列化派生類的屬性

如果您有更好的方式歡迎留言探討。

時間如流水,只能流去不流回。
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 瞭解過 Hex 六邊形架構、Onion 洋蔥架構、Clean 整潔架構的同學可以將本篇文章介紹的實踐方法與自身項目代碼架構對比並互通有無,共同改進。沒瞭解過上述架構的同學可以學習一種新的架構方法,並嘗試將其應用到業務項目中,降低項目維護成本,提高效率。 本文提及的架構主要指項目組織的“代碼架構”,註... ...
  • 在C++/Qt網路通訊模塊設計與實現(三)中提到了一個概念,即接受者所依附的線程;關註我微信公眾號的技術朋友留言對該概念還是不解,這節就單獨講述這個概念的理論與實際應用,這種應用無處不在,因為與Qt的信號槽、線程相關,大家需掌握。接下來從 Qt::ConnectionType,示例源碼,結果論證,歸 ...
  • 發現報錯:RuntimeError: NCCL error in: /pytorch/torch/lib/c10d/ProcessGroupNCCL.cpp:784, unhandled system error想在linux上跑跑mmclassification中的resnet網路,但是報錯,查閱... ...
  • Pandas庫專為數據分析而設計,它是使Python成為強大而高效的數據分析環境的重要因素。 一、Pandas數據結構 1、import pandas as pd import numpy as np import matplotlib.pyplot as plt 2、S1=pd.Series([‘ ...
  • 本文主要介紹 Tomcat Native Library 安裝及使用,文中所使用到的軟體版本:Centos 7.9.2009、Java 1.8.0_321、Tomcat 8.5.84、APR 1.7.0。 1、APR 1.1、APR 簡介 APR(Apache Portable Runtime) 是 ...
  • 操作系統 :CentOS 7.6.1810_x64 Python 版本 : 3.9.12 一、背景描述 使用python開發過程中,會遇到需要使用緩存加速應用的情況,比如下麵這些場景: 數據轉換加速 字元串時間轉換成int時間戳; 字元串時間轉換成datetime類型; ... 數據解析加速 byt ...
  • 上一節給大家從源碼級別分析了SNetClient網路客戶端的實現過程,詳見​C++/Qt網路通訊模塊設計與實現(二),並給大家留了一個疑問,即引入SNetClientRunning類是為瞭解決什麼問題? 我們從SNetClient的設計出發,即要求線上程里進行數據包的收發,連接,斷開處理等,這些處理 ...
  • 本文已經收錄到Github倉庫,該倉庫包含電腦基礎、Java基礎、多線程、JVM、資料庫、Redis、Spring、Mybatis、SpringMVC、SpringBoot、分散式、微服務、設計模式、架構、校招社招分享等核心知識點,歡迎star~ Github地址:https://github.c ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...