細聊ASP.NET Core WebAPI格式化程式

来源:https://www.cnblogs.com/wucy/p/18025196/aspnetcore_webapi_formatter
-Advertisement-
Play Games

前言 我們在使用ASP.NET Core WebApi時它支持使用指定的輸入和輸出格式來交換數據。輸入數據靠模型綁定的機制處理,輸出數據則需要用格式化的方式進行處理。ASP.NET Core框架已經內置了處理JSON和XML的輸入和輸出方式,預設的情況我們提交JSON格式的內容,它可以自行進行模型綁 ...


前言

     我們在使用ASP.NET Core WebApi時它支持使用指定的輸入和輸出格式來交換數據。輸入數據靠模型綁定的機制處理,輸出數據則需要用格式化的方式進行處理。ASP.NET Core框架已經內置了處理JSONXML的輸入和輸出方式,預設的情況我們提交JSON格式的內容,它可以自行進行模型綁定,也可以把對象類型的返回值輸出成JSON格式,這都歸功於內置的JSON格式化程式。本篇文章我們將通過自定義一個YAML格式的轉換器開始,逐步瞭解它到底是如何工作的。以及通過自帶的JSON格式化輸入輸出源碼,加深對Formatter程式的瞭解。

自定義開始

要想先瞭解Formatter的工作原理,當然需要從自定義開始。因為一般自定義的時候我們一般會選用自己最簡單最擅長的方式去擴展,然後逐步完善加深理解。格式化器分為兩種,一種是用來處理輸入數據格式的InputFormatter,另一種是用來處理返回數據格式的OutputFormatter。本篇文章示例,我們從自定義YAML格式的轉換器開始。因為目前YAML格式確實比較流行,得益於它簡單明瞭的格式,目前也有很多中間件都是用YAML格式。這裡我們使用的是YamlDotNet這款組件,具體的引入信息如下所示

<PackageReference Include="YamlDotNet" Version="15.1.0" />

YamlInputFormatter

首先我們來看一下自定義請求數據的格式化也就是InputFormatter,它用來處理了請求數據的格式,也就是我們在Http請求體里的數據格式如何處理,手下我們需要定義個YamlInputFormatter類,繼承自TextInputFormatter抽象類

public class YamlInputFormatter : TextInputFormatter
{
    private readonly IDeserializer _deserializer;

    public YamlInputFormatter(DeserializerBuilder deserializerBuilder)
    {
        _deserializer = deserializerBuilder.Build();

        //添加與之綁定的MediaType,這裡其實綁定的提交的ContentType的值
        //如果請求ContentType:text/yaml或ContentType:text/yml才能命中該YamlInputFormatter
        SupportedMediaTypes.Add(MediaTypeHeaderValue.Parse("text/yaml"));
        SupportedMediaTypes.Add(MediaTypeHeaderValue.Parse("text/yml"));
        
        //添加編碼類型比如application/json;charset=UTF-8後面的這種charset
        SupportedEncodings.Add(Encoding.UTF8);
        SupportedEncodings.Add(Encoding.Unicode);
    }

    public override async Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context, Encoding encoding)
    {
        ArgumentNullException.ThrowIfNull(context);
        ArgumentNullException.ThrowIfNull(encoding);

        //獲取請求Body
        var readStream = context.HttpContext.Request.Body;
        
        object? model;
        try
        {
            TextReader textReader = new StreamReader(readStream);
            //獲取Action參數類型
            var type = context.ModelType;
            //把yaml字元串轉換成具體的對象
            model = _deserializer.Deserialize(textReader, type);
        }
        catch (YamlException ex) 
        {
            context.ModelState.TryAddModelError(context.ModelName, ex.Message);
            throw new InputFormatterException("反序列化輸入數據時出錯\n\n", ex.InnerException!);
        }

        if (model == null && !context.TreatEmptyInputAsDefaultValue)
        {
            return InputFormatterResult.NoValue();
        }
        else
        {
            return InputFormatterResult.Success(model);
        }
    }
}

這裡需要註意的是配置SupportedMediaTypes,也就是添加與YamlInputFormatter綁定的MediaType,也就是我們請求時設置的Content-Type的值,這個配置是必須要的,否則沒辦法判斷當前YamlInputFormatter與哪種Content-Type進行綁定。接下來定義完了之後如何把它接入程式使用它呢?也很簡單在MvcOptions中配置即可,如下所示

builder.Services.AddControllers(options => {
    options.InputFormatters.Add(new YamlInputFormatter(new DeserializerBuilder()));
});

接下來我們定義一個簡單類型和Action來演示一下,類和代碼不具備任何實際意義,只是為了演示

[HttpPost("AddAddress")]
public Address AddAddress(Address address)
{
    return address;
}

public class Address
{
    public string City { get; set; }
    public string Country { get; set; }
    public string Phone { get; set; }
    public string ZipCode { get; set; }
    public List<string> Tags { get; set; }
}

我們用Postman測試一下,提交一個yaml類型的格式,效果如下所示
這裡需要註意的是我們需要在Postman中設置Content-Typetext/ymltext/yaml

YamlOutputFormatter

上面我們演示瞭如何定義InputFormatter它的作用是將請求的數據格式化成具體類型。無獨有偶,既然請求數據格式可以定義,那麼輸出的數據格式同樣可以定義,這裡就需要用到OutputFormatter。接下來我們定義一個YamlOutputFormatter繼承自TextOutputFormatter抽象類,代碼如下所示

public class YamlOutputFormatter : TextOutputFormatter
{
    private readonly ISerializer _serializer;

    public YamlOutputFormatter(SerializerBuilder serializerBuilder)
    {
        //添加與之綁定的MediaType,這裡其實綁定的提交的Accept的值
        //如果請求Accept:text/yaml或Accept:text/yml才能命中該YamlOutputFormatter
        SupportedMediaTypes.Add(MediaTypeHeaderValue.Parse("text/yaml"));
        SupportedMediaTypes.Add(MediaTypeHeaderValue.Parse("text/yml"));

        SupportedEncodings.Add(Encoding.UTF8);
        SupportedEncodings.Add(Encoding.Unicode);

        _serializer = serializerBuilder.Build();
    }

    public override bool CanWriteResult(OutputFormatterCanWriteContext context)
    {
        //什麼條件可以使用yaml結果輸出,至於為什麼要重寫CanWriteResult方法,我們在後面分析源碼的時候會解釋
        string accept = context.HttpContext.Request.Headers.Accept.ToString() ?? "";
        if (string.IsNullOrWhiteSpace(accept))
        {
            return false;
        }

        var parsedContentType = new MediaType(accept);
        for (var i = 0; i < SupportedMediaTypes.Count; i++)
        {
            var supportedMediaType = new MediaType(SupportedMediaTypes[i]);
            if (parsedContentType.IsSubsetOf(supportedMediaType))
            {
                return true;
            }
        }
        return false;
    }

    public override async Task WriteResponseBodyAsync(OutputFormatterWriteContext context, Encoding selectedEncoding)
    {
        ArgumentNullException.ThrowIfNull(context);
        ArgumentNullException.ThrowIfNull(selectedEncoding);

        try
        {
            var httpContext = context.HttpContext;
            //獲取輸出的對象,轉成成yaml字元串並輸出
            string respContent = _serializer.Serialize(context.Object);
            await httpContext.Response.WriteAsync(respContent);
        }
        catch (YamlException ex)
        {
            throw new InputFormatterException("序列化輸入數據時出錯\n\n", ex.InnerException!);
        }
    }
}

同樣的這裡我們也添加了SupportedMediaTypes的值,它的作用是我們請求時設置的Accept的值,這個配置也是必須要的,也就是請求的頭中為Accept:text/yamlAccept:text/yml才能命中該YamlOutputFormatter。配置的時候同樣也在MvcOptions中配置即可

builder.Services.AddControllers(options => {
    options.OutputFormatters.Add(new YamlOutputFormatter(new SerializerBuilder()));
});

接下來我們同樣還是使用上面的代碼進行演示,只是我們這裡更換一下重新設置一下相關Header即可,這次我們直接提交json類型的數據,它會輸出yaml格式,代碼什麼的完全不用變,結果如下所示
這裡需要註意的請求頭的設置發生了變化

小結

上面我們講解了控制請求數據格式的TextInputFormatter和控制輸出格式的TextOutputFormatter。其中InputFormatter負責給ModelBinding輸送類型對象,OutputFormatter負責給ObjectResult輸出值,這我們可以看到它們只能控制WebAPIController/Action的且返回ObjectResult的這種情況才生效,其它的比如MinimalApiGRPC是起不到效果的。通過上面的示例,有同學心裡可能會存在疑問,上面在AddControllers方法中註冊TextInputFormatterTextOutputFormatter的時候,沒辦法完成註入的服務,比如如果YamlInputFormatterYamlOutputFormatter構造實例的時候無法獲取DI容器中的實例。確實,如果使用上面的方式我們確實沒辦法完成這個需求,不過我們可以通過其它方法實現,那就是去擴展MvcOptions選項,實現如下所示

public class YamlMvcOptionsSetup : IConfigureOptions<MvcOptions>
{
    private readonly ILoggerFactory _loggerFactory;

    public YamlMvcOptionsSetup(ILoggerFactory loggerFactory)
    {
        _loggerFactory = loggerFactory;
    }

    public void Configure(MvcOptions options)
    {
        var yamlInputLogger = _loggerFactory.CreateLogger<YamlInputFormatter>();
        options.InputFormatters.Add(new YamlInputFormatter(new DeserializerBuilder()));

        var yamlOutputLogger = _loggerFactory.CreateLogger<YamlOutputFormatter>();
        options.OutputFormatters.Add(new YamlOutputFormatter(new SerializerBuilder()));
    }
}

我們定義了YamlMvcOptionsSetup去擴展MvcOptions選項,然後我們將YamlMvcOptionsSetup註冊到容器即可

builder.Services.TryAddEnumerable(ServiceDescriptor.Transient<IConfigureOptions<MvcOptions>, YamlMvcOptionsSetup>());

探究工作方式

上面我們演示瞭如何自定義InputFormatterOutputFormatter,也講解了InputFormatter負責給ModelBinding輸送類型對象,OutputFormatter負責給ObjectResult輸出值。接下來我們就通過閱讀其中的源碼來看一下InputFormatterOutputFormatter是如何工作來影響模型綁定ObjectResult的結果。

需要註意的是!我們展示的源碼是刪減過的,只關註我們需要關註的地方,因為源碼中涉及的內容太多,不方便觀看,所以只保留我們關註的地方,還望諒解。

TextInputFormatter如何工作

上面我們看到了YamlInputFormatter是繼承了TextInputFormatter抽象類,並重寫了ReadRequestBodyAsync方法。接下來我們就從TextInputFormatterReadRequestBodyAsync方法來入手,我們來看一下源碼定義[點擊查看TextInputFormatter源碼

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

-Advertisement-
Play Games
更多相關文章
  • 流程式控制制工具 三大流程 編程語言中有三大流程,分別是: 順序流程:代碼的執行順序從上到下,從左往右 分支流程:(又稱選擇流程)根據不同的情況執行不同的代碼 迴圈流程:程式重覆的執行某段代碼 當需要設計分支流程與迴圈流程時,就需要用到流程式控制制工具了。 分支流程式控制制工具 if 語句 if 語句用於有條件 ...
  • 使用 mysqldump ; MySQL 自帶的邏輯備份工具。 mysqldump [選項] 資料庫名 [表名] > 腳本名 mysqldump [選項] --資料庫名 [選項 表名] > 腳本名 mysqldump [選項] --all-databases [選項] > 腳本名 備份 mysqld ...
  • 0 背景 重運營的應用。對於App里的頂導航、我的頁面、彈窗等,需要根據模式、版本、平臺、語言、渠道等不同的維度進行運營管理。隨著業務快速發展,版本快速迭代,如何: 保持運營資源能夠被高效、穩定和靈活地配置 高效穩定的為新的運營需求提供支持 通過打造一個穩定、靈活、高效的運營配置平臺來解決前面遇到的 ...
  • 數組 88. 合併兩個有序數組 經典 逆向雙指針 void merge(vector<int> &nums1, int m, vector<int> &nums2, int n) { for (int i = m - 1, j = n - 1, k = m + n - 1; ~j; k--) { n ...
  • TableGo是基於資料庫的自動化生成工具,低代碼編程技術的實現,全能代碼生成器,能零代碼自動生成項目框架和業務表的前後端基礎代碼、還能生成JavaBean、生成前後端代碼、生成資料庫文檔、生成API文檔,並且還能自動化部署項目,能查出資料庫數據生成各種代碼和文檔等,更重要的是可以根據每個項目的不同... ...
  • Ehcache 是一個開源的、基於標準的緩存工具,它能提升性能、減輕資料庫負載並簡化可擴展性。由於其穩健性、經得起考驗的特點以及與其他流行框架的集成,Ehcache 成為最廣泛使用的基於 Java 的緩存工具。Ehcache 從進程內緩存一直擴展到混合的進程內/進程外部署,可以處理 TB 的數據。 ...
  • 首先,咱們先聊聊,什麼是OOM? 小伙伴們,有沒有遇到過程式突然崩潰,然後拋出一個OutOfMemoryError的異常?這就是我們俗稱的OOM,也就是記憶體溢出。簡單來說,就是你的Java應用想要的記憶體超過了JVM願意給的極限,就會拋出這個錯誤。 那麼為什麼會出現OOM呢?一般都是由這些問題引起: ...
  • 今天來聊聊Java中跟數值處理相關的兩個類型Integer和BigDecimal。 說起這兩個類型,我們肯定都不陌生,但是其中有些容易踩到的坑需要註意避讓。 Integer 整型我們應該每天都會用到,但是每種語言還是有自己的特性。從敬姐剛從.NET轉過來的時候踩過的一個坑說起:話說在.NET世界中, ...
一周排行
    -Advertisement-
    Play Games
  • PasteSpider是什麼? 一款使用.net編寫的開源的Linux容器部署助手,支持一鍵發佈,平滑升級,自動伸縮, Key-Value配置,項目網關,環境隔離,運行報表,差量升級,私有倉庫,集群部署,版本管理等! 30分鐘上手,讓開發也可以很容易的學會在linux上部署你得項目! [從需求角度介 ...
  • SQLSugar是什麼 **1. 輕量級ORM框架,專為.NET CORE開發人員設計,它提供了簡單、高效的方式來處理資料庫操作,使開發人員能夠更輕鬆地與資料庫進行交互 2. 簡化資料庫操作和數據訪問,允許開發人員在C#代碼中直接操作資料庫,而不需要編寫複雜的SQL語句 3. 支持多種資料庫,包括但 ...
  • 在C#中,經常會有一些耗時較長的CPU密集型運算,因為如果直接在UI線程執行這樣的運算就會出現UI不響應的問題。解決這類問題的主要途徑是使用多線程,啟動一個後臺線程,把運算操作放在這個後臺線程中完成。但是原生介面的線程操作有一些難度,如果要更進一步的去完成線程間的通訊就會難上加難。 因此,.NET類 ...
  • 一:背景 1. 講故事 前些天有位朋友在微信上丟了一個崩潰的dump給我,讓我幫忙看下為什麼出現了崩潰,在 Windows 的事件查看器上顯示的是經典的 訪問違例 ,即 c0000005 錯誤碼,不管怎麼說有dump就可以上windbg開幹了。 二:WinDbg 分析 1. 程式為誰崩潰了 在 Wi ...
  • CSharpe中的IO+NPOI+序列化 文件文件夾操作 學習一下常見的文件、文件夾的操作。 什麼是IO流? I:就是input O:就是output,故稱:輸入輸出流 將數據讀入記憶體或者記憶體輸出的過程。 常見的IO流操作,一般說的是[記憶體]與[磁碟]之間的輸入輸出。 作用 持久化數據,保證數據不再 ...
  • C#.NET與JAVA互通之MD5哈希V2024 配套視頻: 要點: 1.計算MD5時,SDK自帶的計算哈希(ComputeHash)方法,輸入輸出參數都是byte數組。就涉及到字元串轉byte數組轉換時,編碼選擇的問題。 2.輸入參數,字元串轉byte數組時,編碼雙方要統一,一般為:UTF-8。 ...
  • CodeWF.EventBus,一款靈活的事件匯流排庫,實現模塊間解耦通信。支持多種.NET項目類型,如WPF、WinForms、ASP.NET Core等。採用簡潔設計,輕鬆實現事件的發佈與訂閱。通過有序的消息處理,確保事件得到妥善處理。簡化您的代碼,提升系統可維護性。 ...
  • 一、基本的.NET框架概念 .NET框架是一個由微軟開發的軟體開發平臺,它提供了一個運行時環境(CLR - Common Language Runtime)和一套豐富的類庫(FCL - Framework Class Library)。CLR負責管理代碼的執行,而FCL則提供了大量預先編寫好的代碼, ...
  • 本章將和大家分享在ASP.NET Core中如何使用高級客戶端NEST來操作我們的Elasticsearch。 NEST是一個高級別的Elasticsearch .NET客戶端,它仍然非常接近原始Elasticsearch API的映射。所有的請求和響應都是通過類型來暴露的,這使得它非常適合快速上手 ...
  • 參考delphi的代碼更改為C# Delphi 檢測密碼強度 規則(仿 google) 仿 google 評分規則 一、密碼長度: 5 分: 小於等於 4 個字元 10 分: 5 到 7 字元 25 分: 大於等於 8 個字元 二、字母: 0 分: 沒有字母 10 分: 全都是小(大)寫字母 20 ...