欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

.NET Core API之格式化輸出對象OutputFormatter

 更新時間:2022年04月23日 17:33:19   作者:暢飲無緒  
這篇文章介紹了.NET Core API之格式化輸出對象OutputFormatter,文中通過示例代碼介紹的非常詳細。對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下

相信大家在項目中都用過統(tǒng)一響應(yīng)參數(shù)模板。

先聲明一個響應(yīng)模板類:

public class ResponseDto
{
    public int code { get; set; }
    public string msg { get; set; }
    public object data { get; set; }
}

再定義返回成功和失敗的方法:

public IActionResult Success(object data)
{
	return ......
}
public IActionResult Fail(string msg)
{
	return ......
}

在接口返回時統(tǒng)一調(diào)用:

[HttpGet]
public IActionResult Get()
{
	var data = new WeatherForecast() { Date = DateTime.Now };
	return Success(data);
}

當(dāng)然了,這篇文章所講的OutputFormatter和上面的統(tǒng)一模板不沖突哈,存在共通之處,都是格式化響應(yīng)參數(shù)嘛,拿來做個引子。

OutputFormatter

OutputFormatter是所有格式化輸出的基類,有唯一的子類:TextOutputFormatter,同時TextOutputFormatter又有一大堆子類:

  • JsonOutputFormatter
  • NewtonsoftJsonOutputFormatter
  • StringOutputFormatter
  • SystemTextJsonOutputFormatter
  • XmlDataContractSerializerOutputFormatter
  • XmlSerializerOutputFormatter

如果不配置任何響應(yīng)參數(shù)輸出格式,asp.net core api響應(yīng)參數(shù)默認(rèn)的輸出格式就是json

猴:這個接口給我返回xml,我不要json

我:你是不是腦子有毛???好好的json不用用xml

得,前端大佬得要求還是得滿足不是,這時候有些同學(xué)是不是已經(jīng)去百度:.Net怎么將對象轉(zhuǎn)換成xml?

No No No,這時候就輪到OutputFormatter的孫子 XmlDataContractSerializerOutputFormatter 出場了。

只需要簡單給接口配置一個屬性就搞定啦。

[Produces("application/xml")]
[HttpGet]
public WeatherForecast Get()
{
	return new WeatherForecast() { Date = DateTime.Now };
}

我們來運行看一看:

wtf,怎么會406。

406:表示客戶端無法解析服務(wù)端返回的內(nèi)容。說白了就是后臺的返回結(jié)果前臺無法解析就報406錯誤。

哦,原來是忘了在Startup中配置我們的孫子XmlDataContractSerializerOutputFormatter。

services.AddControllers((c) =>
{
	c.OutputFormatters.Add(new XmlDataContractSerializerOutputFormatter());
});

注意:不只是沒有在Startup中會出現(xiàn)406哦,以下情況也會出現(xiàn):

  • contentType不存在
  • contentType與響應(yīng)參數(shù)不匹配

OutputFormatter擴展

上面介紹了內(nèi)置OutputFormatter的使用,那如果我們想自定義呢?當(dāng)然也是可以的。

下面我們就用自定義的OutputFormatter實現(xiàn)頂部響應(yīng)模板的效果:

public class ObjectOutputFormatter : TextOutputFormatter
{
	public ObjectOutputFormatter()
	{
		SupportedEncodings.Add(Encoding.UTF8);
		SupportedEncodings.Add(Encoding.Unicode);
		// 這就是我們自定義contentType的名稱
		SupportedMediaTypes.Add("text/object");
	}

	public override async Task WriteResponseBodyAsync(OutputFormatterWriteContext context, Encoding selectedEncoding)
	{
		if (context == null)
		{
			throw new ArgumentNullException(nameof(context));
		}
		if (selectedEncoding == null)
		{
			throw new ArgumentNullException(nameof(selectedEncoding));
		}
		string text = JsonConvert.SerializeObject(new ResponseDto()
		{
			msg = "成功,自定義的哦",
			code = 200,
			data = context.Object
		});
		var response = context.HttpContext.Response;
		await response.WriteAsync(text, selectedEncoding);
	}
}

[Produces("text/object")]
[HttpGet]
public WeatherForecast Get()
{
	return new WeatherForecast() { Date = DateTime.Now };
}

public void ConfigureServices(IServiceCollection services)
{
	services.AddControllers((c) =>
	{
		c.OutputFormatters.Add(new XmlDataContractSerializerOutputFormatter());
		// 我們自定義的輸出格式
		c.OutputFormatters.Add(new ObjectOutputFormatter());
	});
}

搞定,我們來看看效果:

ActionFilterAttribute

有些同學(xué)可能會想到過濾器,是的,上面的效果過濾器也能實現(xiàn):

public class ResultFilter : ActionFilterAttribute
{
    public override void OnResultExecuting(ResultExecutingContext context)
    {
        ResponseDto result = new ResponseDto();
        result.code = 200;
        result.msg = "成功,ResultFilter";
        var properties = context.Result.GetType().GetProperties(BindingFlags.Instance | BindingFlags.Public);
        result.data = properties.FirstOrDefault(c => c.Name == "Value").GetValue(context.Result);
        context.Result = new JsonResult(result);
        base.OnResultExecuting(context);
    }
}

[TypeFilter(typeof(ResultFilter))]
[HttpGet]
public WeatherForecast Get()
{
	return new WeatherForecast() { Date = DateTime.Now };
}

猴:有了過濾器為什么還搞個OutputFormatter呢?

我:不能因為過濾器可以實現(xiàn)同樣的功能就認(rèn)為OutputFormatter多余了,很顯然過濾器的操作對象是請求/響應(yīng)上下文,而OutputFormatter的操作對象則是響應(yīng)參數(shù)。再說了,ActionFilterAttribute過濾器只是眾多過濾器的一種。

猴:那過濾器和自定義OutputFormatter一起用會是什么效果呢?是不是像下面這樣?

我:不是,過濾器和自定義OutputFormatter同時使用,生效的只有過濾器,不信可以打斷點試一下哦。

[Produces("text/object")]
[TypeFilter(typeof(ResultFilter))]
[HttpGet]
public WeatherForecast Get()
{
	return new WeatherForecast() { Date = DateTime.Now };
}

到此這篇關(guān)于.NET Core API之格式化輸出對象OutputFormatter的文章就介紹到這了。希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。

相關(guān)文章

  • .Net項目中NLog的配置和使用實例詳解

    .Net項目中NLog的配置和使用實例詳解

    這篇文章主要給大家介紹了關(guān)于.Net項目中NLog的配置和使用的相關(guān)資料,文中通過示例代碼介紹的非常詳細,對大家學(xué)習(xí)或者使用.Net具有一定的參考學(xué)習(xí)價值,需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧
    2019-07-07
  • .NET?Core(.NET6)中g(shù)RPC使用實踐

    .NET?Core(.NET6)中g(shù)RPC使用實踐

    gRPC是高性能的遠程過程調(diào)用(RPC)框架,本文主要介紹了.NET?Core(.NET6)中g(shù)RPC使用,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2022-04-04
  • Asp.net 下載功能的解決方案

    Asp.net 下載功能的解決方案

    今天在網(wǎng)上找到一個比較好的asp.net下載方法的解決方案
    2009-11-11
  • .Net?Api?中使用Elasticsearch存儲文檔的方法

    .Net?Api?中使用Elasticsearch存儲文檔的方法

    Elasticsearch 是一個分布式、高擴展、高實時的搜索與數(shù)據(jù)分析引擎,在C# 的環(huán)境中,有一個Es的官方拓展包Nest,可以讓我們方便快捷的使用上Es數(shù)據(jù)庫,本文重點給大家介紹.Net?Api?中使用Elasticsearch存儲文檔的方法,感興趣的朋友一起看看吧
    2022-01-01
  • ASP.NET GridView中加入RadioButton不能單選的解決方案

    ASP.NET GridView中加入RadioButton不能單選的解決方案

    這篇文章主要介紹了ASP.NET GridView中加入RadioButton不能單選的解決方案,希望大家閱讀完本文有所收獲。
    2015-09-09
  • ASP.NET 提高首頁性能的十大做法

    ASP.NET 提高首頁性能的十大做法

    本文是我對ASP.NET頁面載入速度提高的一些做法,這些做法分為以下部分,希望對朋友們有所幫助。
    2010-05-05
  • GridView選擇性導(dǎo)出Excel解決方案

    GridView選擇性導(dǎo)出Excel解決方案

    這篇文章主要介紹了GridView選擇性導(dǎo)出Excel的解決方案,需要的朋友可以參考下
    2014-03-03
  • asp.net String.Empty NULL 不同之處

    asp.net String.Empty NULL 不同之處

    在asp.net(c#)中String.Empty、NULL、"" 3個語法經(jīng)常使用,作用是判斷字符串是否為空。
    2009-06-06
  • 深入Lumisoft.NET組件POP3郵件接收與刪除操作的使用詳解

    深入Lumisoft.NET組件POP3郵件接收與刪除操作的使用詳解

    本篇文章對Lumisoft.NET組件POP3郵件接收與刪除操作的使用進行了詳細的介紹。需要的朋友參考下
    2013-05-05
  • C#頁碼導(dǎo)航顯示及算法實現(xiàn)代碼

    C#頁碼導(dǎo)航顯示及算法實現(xiàn)代碼

    C#頁碼導(dǎo)航算法要求:頁數(shù)小于等于1時不顯示;頁數(shù)大于10時,自動縮短,需要的朋友可以了解下
    2012-12-12

最新評論