.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
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類