.Net MinimalApis響應返回值

来源:https://www.cnblogs.com/ruipeng/p/18088161
-Advertisement-
Play Games

前言 文本主要講 MinimalApis 中的使用自定義IResultModel和系統自帶IResult做響應返回值。 MinimalApis支持以下類型的返回值： string - 這包括 Task<string> 和 ValueTask<string> T（任何其他類型）- 這包括 Task<T ...


前言

文本主要講 MinimalApis 中的使用自定義IResultModel和系統自帶IResult做響應返回值。
MinimalApis支持以下類型的返回值：

  • string - 這包括 Task<string> 和 ValueTask<string>

  • T（任何其他類型）- 這包括 Task<T> 和 ValueTask<T>

  • 基於 IResult - 這包括 Task<IResult> 和 ValueTask<IResult>

    本文的完整源代碼在文末

string 返回值

行為 Content-Type
框架將字元串直接寫入響應。 text/plain

200 狀態代碼與 text/plain Content-Type 標頭和以下內容一起返回

Hello World

T（任何其他類型）返回值

我們上面說的自定義 IResultModel就是用這種模式處理的

行為 Content-Type
框架 JSON 序列化響應。 application/json

MinimalApis 框架 Json 序列化全局配置如下

    //通過調用 ConfigureHttpJsonOptions 來全局配置應用的選項
    builder.Services.ConfigureHttpJsonOptions(options =>
    {
        options.SerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;//忽略迴圈引用
        options.SerializerOptions.WriteIndented = true;
        options.SerializerOptions.IncludeFields = true;
        options.SerializerOptions.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull;
    });

返回 T


app.MapGet("/TestT", User () => new User() { Name = "Ruipeng", Email = "[email protected]", Age = 18 })
   .WithSummary("測試類")
   .Produces<User>();

返回值

{
  "name": "Ruipeng",
  "email": "[email protected]",
  "age": 18
}

200 狀態代碼與 application/json Content-Type 標頭和以下內容一起返回

這個 HttpCode狀態碼只能返回 200，且不支持多種返回形式，比較局限

統一響應格式代碼


public interface IResultModel
{
    /// <summary>
    ///     是否成功
    /// </summary>
    bool? IsSuccess { get; }

    /// <summary>
    ///     錯誤信息
    /// </summary>
    string? Message { get; }

    /// <summary>
    ///     業務碼，用於業務中自定義
    /// </summary>
    int? StatusCode { get; set; }

    /// <summary>
    ///     時間戳
    /// </summary>
    long? Timestamp { get; }
}

/// <summary>
///     返回結果模型泛型介面
/// </summary>
/// <typeparam name="T"></typeparam>
public interface IResultModel<out T> : IResultModel
{
    /// <summary>
    ///     返回數據
    /// </summary>

    T? Data { get; }
}

實現

public class ResultModel<T> : IResultModel<T>
{
    public ResultModel()
    {
        Timestamp = DateTimeOffset.Now.ToUnixTimeSeconds();
    }

    /// <summary>
    ///     處理是否成功
    /// </summary>
    public bool? IsSuccess { get; set; }

    /// <summary>
    ///     錯誤信息
    /// </summary>
    public string? Message { get; set; }

    /// <summary>
    ///     業務碼
    /// </summary>
    public int? StatusCode { get; set; }

    /// <summary>
    ///     時間戳
    /// </summary>
    public long? Timestamp { get; }

    /// <summary>
    ///     返回數據
    /// </summary>
    public T? Data { get; set; }


    /// <summary>
    ///     成功
    /// </summary>
    /// <param name="Data"></param>
    public ResultModel<T> Success(T? data = default)
    {
        this.IsSuccess = true;
        StatusCode = 200;
        Data = data;
        return this;
    }

    /// <summary>
    ///     失敗
    /// </summary>
    /// <param name="msg">說明</param>
    /// <param name="code"></param>
    public ResultModel<T> Failed(string? msg = "failed", int? code = 500)
    {
        IsSuccess = false;
        Message = msg;
        StatusCode = code;
        return this;
    }
}

/// <summary>
///     返回結果
/// </summary>
public static class ResultModel
{
    /// <summary>
    ///     數據已存在
    /// </summary>
    /// <returns></returns>
    public static IResultModel<string> HasExists => Failed("data already exists");

    /// <summary>
    ///     數據不存在
    /// </summary>
    public static IResultModel<string> NotExists => Failed("data doesn't exist");

    /// <summary>
    ///     成功
    /// </summary>
    /// <param name="data">返回數據</param>
    /// <returns></returns>
    public static IResultModel<T> Success<T>(T? data = default)
    {
        return new ResultModel<T>().Success(data);
    }

    /// <summary>
    ///     成功
    /// </summary>
    /// <param name="task">任務</param>
    /// <returns></returns>
    public static async Task<IResultModel<T>> SuccessAsync<T>(Task<T>? task = default)
    {
        return task is not null && task != default ? new ResultModel<T>().Success(await task) : new ResultModel<T>();
    }

    /// <summary>
    ///     成功
    /// </summary>
    /// <returns></returns>
    public static IResultModel<string> Success()
    {
        return Success<string>();
    }


    /// <summary>
    ///     失敗
    /// </summary>
    /// <param name="error">錯誤信息</param>
    /// <returns></returns>
    public static IResultModel<T> Failed<T>(string? error = null)
    {
        return new ResultModel<T>().Failed(error ?? "failed");
    }

    /// <summary>
    ///     失敗
    /// </summary>
    /// <returns></returns>
    public static IResultModel<string> Failed(string? error = null)
    {
        return Failed<string>(error);
    }

    /// <summary>
    ///     根據布爾值返回結果
    /// </summary>
    /// <param name="success"></param>
    /// <returns></returns>
    public static IResultModel<T> Result<T>(bool success)
    {
        return success ? Success<T>() : Failed<T>();
    }

    /// <summary>
    ///     根據布爾值返回結果
    /// </summary>
    /// <param name="success"></param>
    /// <returns></returns>
    public static async Task<IResultModel> Result(Task<bool> success)
    {
        return await success ? Success() : Failed();
    }

    /// <summary>
    ///     根據布爾值返回結果
    /// </summary>
    /// <param name="success"></param>
    /// <returns></returns>
    public static IResultModel<string> Result(bool success)
    {
        return success ? Success() : Failed();
    }

    /// <summary>
    /// 時間戳起始日期
    /// </summary>
    public static readonly DateTime TimestampStart = new(1970, 1, 1, 0, 0, 0, 0);


}

定義介面

app.MapGet("/TestResultModel", IResultModel (int age) =>
{
    List<User> users = [new User() { Name = "Ruipeng", Email = "[email protected]", Age = 18 }];
    return users.FirstOrDefault(_ => _.Age > age) is User user ? ResultModel.Success(user) : ResultModel.Failed();
})
   .WithSummary("測試自定義IResultModel")
   .Produces<IResultModel<User>>();

封裝了一個靜態類來簡化自定義類的創建，支持多個返回類型

返回值

{
  "isSuccess": true,
  "statusCode": 200,
  "timestamp": 1711001093,
  "data": {
    "name": "Ruipeng",
    "email": "[email protected]",
    "age": 18
  }

自定義類的自動包裝實現

創建一個Attribute

[AttributeUsage(AttributeTargets.Method)]
public class EnableResponseWrapperAttribute : Attribute { }

創建中間件自動包裝

public class ResponseWrapperMiddleware(RequestDelegate next)
{
    public async Task InvokeAsync(HttpContext context)
    {

        if (context.GetEndpoint()?.Metadata.GetMetadata<EnableResponseWrapperAttribute>() is not null)
        {
            // 存儲原始響應體流
            var originalResponseBodyStream = context.Response.Body;
            try
            {
                // 創建記憶體流以捕獲響應
                using var memoryStream = new MemoryStream();
                context.Response.Body = memoryStream;

                // 調用管道中的下一個中間件
                await next(context);

                // 恢複原始響應體流並寫入格式化結果
                context.Response.Body = originalResponseBodyStream;

                // 重置記憶體流位置並讀取響應內容
                memoryStream.Seek(0, SeekOrigin.Begin);
                var readToEnd = await new StreamReader(memoryStream).ReadToEndAsync();
                var objResult = JsonSerializer.Deserialize<dynamic>(readToEnd);
                var result = new ResultModel<object>
                {
                    Data = objResult,
                    IsSuccess = true,
                    StatusCode = context.Response.StatusCode
                };
                await context.Response.WriteAsJsonAsync(result as object);

            }
            finally
            {
                // 確保在出現異常時恢複原始響應體流
                context.Response.Body = originalResponseBodyStream;
            }
        }
        else
        {
            await next(context);
        }
    }
}

應用中間件

app.UseMiddleware<ResponseWrapperMiddleware>();

創建測試介面

app.MapGet("/TestTestAutoWarpper", [EnableResponseWrapper] User () => new User() { Name = "Ruipeng", Email = "[email protected]", Age = 18 }).WithSummary("測試類")
   .Produces<User>();

返回值

{
  "isSuccess": true,
  "statusCode": 200,
  "timestamp": 1711005201,
  "data": {
    "name": "Ruipeng",
    "email": "[email protected]",
    "age": 18
  }
}

為了方便測試在MinimalApis 的介面上如果添加了EnableResponseWrapperAttribute則通過中間件自動包裝返回值

IResult 返回值

行為 Content-Type
框架調用 IResult.ExecuteAsync 由 IResult 實現決定

在dotNet7 之後多了一個TypedResults類來替代 Results。
IResult 介面定義一個表示 HTTP 終結點結果的協定。 靜態 Results 類和靜態 TypedResults 用於創建表示不同類型的響應的各種 IResult 對象。

返回 TypedResults（而不是 Results）有以下優點：

  • TypedResults 幫助程式返回強類型對象，這可以提高代碼可讀性、改進單元測試並減少運行時錯誤的可能性。
  • 實現類型會自動為 OpenAPI 提供響應類型元數據來描述終結點。
    實現在Microsoft.AspNetCore.Http.HttpResults
//Return IResult
app.MapGet("/IResult/TestResult", IResult () => Results.Ok(new User() { Name = "Ruipeng", Email = "[email protected]", Age = 18 }));

沒有調用擴展方法 Produces

app.MapGet("/IResult/TestTypedResult", IResult () => TypedResults.Ok(new User() { Name = "Ruipeng", Email = "[email protected]", Age = 18 }));

可以看到 TypedResults 預設就會添加路由終結點的元數據描述

返回多個 IResult 實現類型

app.MapGet("/IResult/ReturnMultipleTypes", Results<Ok<User>, NotFound> (int age) =>
{
    List<User> users = [new User() { Name = "Ruipeng", Email = "[email protected]", Age = 18 }];
    return users.FirstOrDefault(_ => _.Age > age) is User user ? TypedResults.Ok(user) : TypedResults.NotFound();
});

圖簡單可以直接用 IResult 返回類型 但是，由於 TypedResults 幫助程式自動包含終結點的元數據，因此可以改為返回 Results<Ok<User>, NotFound> 聯合類型

IResult 自定義響應

添加 Html 擴展


public static class ResultsExtensions
{
    public static IResult Html(this IResultExtensions resultExtensions, string html)
    {
        ArgumentNullException.ThrowIfNull(resultExtensions);

        return new HtmlResult(html);
    }
}


class HtmlResult(string html) : IResult
{
    private readonly string _html = html;

    public Task ExecuteAsync(HttpContext httpContext)
    {
        httpContext.Response.ContentType = MediaTypeNames.Text.Html;
        httpContext.Response.ContentLength = Encoding.UTF8.GetByteCount(_html);
        return httpContext.Response.WriteAsync(_html);
    }
}

app.MapGet("/IResult/Html", () => Results.Extensions.Html(@$"<!doctype html>
<html>
    <head><title>miniHTML</title></head>
    <body>
        <h1>Hello World</h1>
        <p>The time on the server is {DateTime.Now:O}</p>
    </body>
</html>"));

返回結果

<!DOCTYPE html>
<html>
  <head>
    <title>miniHTML</title>
  </head>
  <body>
    <h1>Hello World</h1>
    <p>The time on the server is 2024-03-21T17:31:36.2931959+08:00</p>
  </body>
</html>

自定義 Json 格式

上面寫了ConfigureHttpJsonOptions方法來配置全局請求的 Json 格式，下麵則是針對單個路由終結點請求，方便一些個性化介面的處理

var options = new JsonSerializerOptions(JsonSerializerDefaults.Web)
{ WriteIndented = true };

app.MapGet("/IResult/CustomJsonConfig", () =>
    TypedResults.Json(new User() { Name = "Ruipeng", Email = "[email protected]", Age = 18 }, options));

返回 ProblemDetail

app.MapGet("/IResult/ProblemDetail", () =>
{
    var problemDetail = new ProblemDetails()
    {
        Status = StatusCodes.Status500InternalServerError,
        Title = "內部錯誤"
    };
    return TypedResults.Problem(problemDetail);
});

返回值

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
  "title": "內部錯誤",
  "status": 500
}

在Microsoft.AspNetCore.Http.Results的擴展下，TypedResults 有非常多擴展的方法，比如處理文件，回調，流以及登錄認證等，大家可以根據需求使用.

最後

用那種方式還是取決於項目的實際情況，如果你的系統是業務碼和 httpStateCode要求分離的形式那建議用上面自定義統一響應的形式，要是沒這方面的需求那dotNet自帶的TypedResults使用起來就更合適。

官網文檔 如何在最小 API 應用中創建響應

以下是本文的完整 源代碼

希望本文對你有幫助！

本文來自博客園，作者：董瑞鵬，轉載請註明原文鏈接：https://www.cnblogs.com/ruipeng/p/18088161


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

-Advertisement-
Play Games
更多相關文章
  • LeetCode刷題記錄——day3
    1、https://leetcode.cn/problems/gas-station/submissions/514930619/?envType=study-plan-v2&envId=top-interview-150 對於這個問題可以這樣來考慮，將數據看作一個環，如果答案唯一，那麼就意味著從任 ...
  • Java三大特性：封裝、繼承、多態
    封裝 高內聚，低耦合 高內聚：類內部操作自己完成，不允許外部干涉。 低耦合：僅暴露少量的方法給外部使用。 封裝（數據的隱藏）通常應禁止直接訪問一個對象中數據的實際表達，而應該通過操作介面來訪問，這稱為信息的隱藏。 封裝的特點 1.提高程式的安全性，保護數據 2.隱藏代碼的實現細節 3.統一介面 4. ...
  • ClickHouse最大QPS到底咋估算？
    ClickHouse是用於分析的OLAP資料庫，因此典型的使用場景是處理相對較少的請求 — 從每小時幾個到每秒幾十甚至幾百個不等 — 但會影響到大量數據（幾GB/數百萬行）。 但是在其他情況下，它的表現如何？讓我們嘗試用大量小請求來測試ClickHouse如何處理。這將幫助我們更好地瞭解可能的使用場 ...
  • Java22重磅發佈！！！！捲不動了，真的捲不動了。。。。
    3月19日，Java22重磅發佈。Java22新增了12項增強功能，其中包括七個預覽特性和一個孵化器特性，這些功能都顯著到足以引起JDK增強提案（JEPs）的關註。它們涵蓋了Java語言、其API、性能以及JDK中包含的工具的改進。 ...
  • gRPC入門學習之旅（三）
    在當今數字化時代，構建高效、可靠的分散式系統是許多企業和開發團隊面臨的挑戰。微軟的 Orleans 框架為解決這些挑戰提供了一個強大而簡單的解決方案。本文將介紹 Orleans 的核心概念，並通過一個簡單的示例代碼來演示其用法。 什麼是 Orleans？ Orleans 是由微軟開發的一個開源分散式 ...
  • .NET Emit 入門教程：第三部分：構建模塊（Module）
    嗯，構建模塊，一行代碼的事情，愣是讓我寫成了一篇教程，太難了。在這個入門教程的第三部分中，我們學習瞭如何使用.NET Emit 構建模塊（Module）。通過創建和定義模塊，我們可以更好地組織和管理我們的代碼。在這個過程中，我們瞭解瞭如何使用 AssemblyBuilder 和 ModuleBuil... ...
  • 在 PostgreSQL 中，解決圖片二進位數據，由於bytea_output參數問題導致顯示不正常的問題。
    在 PostgreSQL 中，bytea_output 參數控制在查詢結果中 bytea 類型的顯示格式。預設情況下，bytea_output 的值為 hex，這意味著在查詢結果中，bytea 類型的數據以十六進位格式顯示。但是，如果你的應用程式期望以二進位格式獲取圖像數據，則將 bytea_out... ...
  • 前端優化 之 preload
    為了優化我們公司網站的性能，我最近引入了瀏覽器預載入技術（Preload）。 這項技術可以顯著減少級聯情況，提高資源載入的並行度，從而加速網站的載入速度。 Preload的原理 Preload的原理是在瀏覽器解析HTML文檔時，提前載入頁面所需的關鍵資源，如樣式表、腳本文件和字體等。 通過預載入這些 ...
一周排行
    -Advertisement-
    Play Games
  • 如何基於surging跨網關跨語言進行緩存降級
    基於.NET Framework 4.8 開發的深度學習模型部署測試平臺，提供了YOLO框架的主流系列模型，包括YOLOv8~v9，以及其系列下的Det、Seg、Pose、Obb、Cls等應用場景，同時支持圖像與視頻檢測。模型部署引擎使用的是OpenVINO™、TensorRT、ONNX runti... ...
  • 十年沉澱，重啟開發之路
    十年沉澱，重啟開發之路 十年前，我沉浸在開發的海洋中，每日與代碼為伍，與演算法共舞。那時的我，滿懷激情，對技術的追求近乎狂熱。然而，隨著歲月的流逝，生活的忙碌逐漸占據了我的大部分時間，讓我無暇顧及技術的沉澱與積累。 十年間，我經歷了職業生涯的起伏和變遷。從初出茅廬的菜鳥到逐漸嶄露頭角的開發者，我見證了 ...
  • C#.NET體系圖文概述—2024最全總結
    C# 是一種簡單、現代、面向對象和類型安全的編程語言。.NET 是由 Microsoft 創建的開發平臺，平臺包含了語言規範、工具、運行，支持開發各種應用，如Web、移動、桌面等。.NET框架有多個實現，如.NET Framework、.NET Core（及後續的.NET 5+版本），以及社區版本M... ...
  • 班級擂臺（光榮）榜 - 極簡教育小工具
    前言 本文介紹瞭如何使用三菱提供的MX Component插件實現對三菱PLC軟元件數據的讀寫，記錄了使用電腦模擬，模擬PLC，直至完成測試的詳細流程，並重點介紹了在這個過程中的易錯點，供參考。 用到的軟體： 1. PLC開發編程環境GX Works2，GX Works2下載鏈接 https:// ...
  • web server apache tomcat11-31-websocket
    前言 整理這個官方翻譯的系列，原因是網上大部分的 tomcat 版本比較舊，此版本為 v11 最新的版本。 開源項目 從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎，輕嗅薔薇。 系列文章 web server apache tomcat11-01-官方文檔入門介紹 web serv ...
  • day31-jQuery
    1、jQuery介紹 jQuery是什麼 jQuery是一個快速、簡潔的JavaScript框架，是繼Prototype之後又一個優秀的JavaScript代碼庫（或JavaScript框架）。jQuery設計的宗旨是“write Less，Do More”，即倡導寫更少的代碼，做更多的事情。它封裝 ...
  • aardio爬蟲) 實戰篇：逆向有道翻譯web介面
    前言 之前的文章把js引擎(aardio封裝庫) 微軟開源的js引擎(ChakraCore))寫好了，這篇文章整點js代碼來測一下bug。測試網站：https://fanyi.youdao.com/index.html#/ 逆向思路 逆向思路可以看有道翻譯js逆向（MD5加密，AES加密）附完整源碼 ...
  • 面試官：這就是你理解的Java多線程基礎？
    引言 現代的操作系統（Windows，Linux，Mac OS）等都可以同時打開多個軟體（任務），這些軟體在我們的感知上是同時運行的，例如我們可以一邊瀏覽網頁，一邊聽音樂。而CPU執行代碼同一時間只能執行一條，但即使我們的電腦是單核CPU也可以同時運行多個任務，如下圖所示，這是因為我們的 CPU 的 ...
  • Python文本統計與分析從基礎到進階
    掌握使用Python進行文本英文統計的基本方法，並瞭解如何進一步優化和擴展這些方法，以應對更複雜的文本分析任務。 ...
  • Redis多數據源，看這篇就夠了
    背景 Redis多數據源常見的場景： 分區數據處理：當數據量增長時，單個Redis實例可能無法處理所有的數據。通過使用多個Redis數據源，可以將數據分區存儲在不同的實例中，使得數據處理更加高效。 多租戶應用程式：對於多租戶應用程式，每個租戶可以擁有自己的Redis數據源，以確保數據隔離和安全性。 ...
所有分類