客户要求ASP.NET Core API返回特定格式,怎么办?(续2)

前言

前2次,我们都是假设客户需要返回不同的字符串格式。

但是,有可能客户要求的返回是非本文格式,比如文件流。

怎么办?

思路

前提,当然还是使用同一API接口,不影响现有使用方式。

虽然ASP.NET Core Web API默认使用SystemTextJsonOutputFormatter格式化响应,但是OutputFormatters集合里其实包含了StreamOutputFormatter

13f262f3c298d493c2dc27e2e3f65c3d.png

那么实现目标就转化为,怎么让Web API使用StreamOutputFormatter

DefaultOutputFormatterSelector

通过查看dotnet/aspnetcore源代码,我们找到了DefaultOutputFormatterSelector,它是选择IOutputFormatter以写入对当前请求的响应的默认实现:

219a21a26a76e84acf36d190bbe9f870.png

其中,选择IOutputFormatter具体实现是通过判断CanWriteResult方法,代码如下:

foreach (var formatter in formatters)
{formatterContext.ContentType = new StringSegment();formatterContext.ContentTypeIsServerDefined = false;if (formatter.CanWriteResult(formatterContext)){return formatter;}
}

StreamOutputFormatter是这样实现CanWriteResult方法的:

public bool CanWriteResult(OutputFormatterCanWriteContext context)
{if (context == null){throw new ArgumentNullException(nameof(context));}// Ignore the passed in content type, if the object is a Stream.if (context.Object is Stream){return true;}return false;
}

那么实现目标就转化为,怎么让Web API返回的是Stream

操作返回类型

微软官方文档ASP.NET Core Web API 中控制器操作的返回类型[1]提到,返回类型除了支持特定类型之外,还支持ActionResult<T>

ActionResult<T>可以返回从ActionResult派生的类型或返回特定类型:

c3b8014ea70c629bcbc209eec39259a7.png

那么实现目标就转化为,将返回类型设为ActionResult<T>,根据条件返回T,或者返回特定ActionResult派生类,例如FileResult

实现

具体实现代码如下,如果Accept Headertext/json则返回文件流:

[HttpGet]
public ActionResult<IEnumerable<WeatherForecast>> Get()
{var rng = new Random();var result = Enumerable.Range(1, 5).Select(index => new WeatherForecast{Date = DateTime.Now.AddDays(index),TemperatureC = rng.Next(-20, 55),Summary = Summaries[rng.Next(Summaries.Length)]}).ToArray();HttpContext.Request.Headers.TryGetValue("Accept", out var acceptValue);if (acceptValue.ToString() == "text/json"){using (var memory = new MemoryStream()){using (var writer = new StreamWriter(memory)){writer.Write(System.Text.Json.JsonSerializer.Serialize(result));writer.Flush();}return File(memory.ToArray(), "text/json", "WeatherForecast.json");} }return result;
}

结论

现在,只需要客户在每个API请求加上Accept Header即可满足需求。

如果你觉得这篇文章对你有所启发,请关注我的个人公众号”My IO“

参考资料

[1]

ASP.NET Core Web API 中控制器操作的返回类型: https://docs.microsoft.com/zh-cn/aspnet/core/web-api/action-return-types?view=aspnetcore-5.0

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/292738.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

第四章例题、心得及问题。

例题4-1&#xff1a; #include<stdio.h> #include<math.h> int main(void) {int denominator,flag;double item,pi;flag1;denominator1;item1.0;pi0;while(fabs(item)>0.0001){itemflag*1.0/denominator;pipiitem;flag-flag;denominatordenominator2;}pipi*4;pr…

springboot springcloud区别_SpringCloud微服务全家桶-第一篇!为什么要用微服务

从今天开始&#xff0c;学习SpringCloud微服务全家桶。一、引导1、什么是微服务&#xff1f;2、微服务之间是如何独立通讯的3、springCloud和Dubbo有哪些区别&#xff1f;4、什么是服务熔断&#xff1f;什么是服务降级5、微服务的优缺点分别是什么&#xff1f;6、微服务技术栈有…

[Todo] 乐观悲观锁,自旋互斥锁等等

乐观锁、悲观锁、要实践 http://chenzhou123520.iteye.com/blog/1860954 《mysql悲观锁总结和实践》 http://chenzhou123520.iteye.com/blog/1863407 《mysql乐观锁总结和实践》 http://outofmemory.cn/sql/optimistic-lock-and-pessimistic-lock 注意&#xff0c;以下的表里面…

Android之 ListView滑动时不加载图片

listview加载图片优化的功能&#xff0c; 在我们使用新浪微博的时候&#xff0c;细心的同学一定发现了&#xff0c;在滑动的过程中&#xff0c;图片是没有被加载的&#xff0c; 而是在滑动停止时&#xff0c;才加载图片了。 我们今天就做一个这样的效果吧。 我们先考虑两个问题…

C#之Lock

lock 关键字将语句块标记为临界区&#xff0c;方法是获取给定对象的互斥锁&#xff0c;执行语句&#xff0c;然后释放该锁。 class Program{static void Main(string[] args){Thread t new Thread(LockObject.MonitorIncrement);Thread t1new Thread(new ThreadStart(LockObje…

记一次 .NET 某消防物联网 后台服务 内存泄漏分析

一&#xff1a;背景 1. 讲故事去年十月份有位朋友从微信找到我&#xff0c;说他的程序内存要炸掉了。。。截图如下&#xff1a;时间有点久&#xff0c;图片都被清理了&#xff0c;不过有点讽刺的是&#xff0c;自己的程序本身就是做监控的&#xff0c;结果自己出了问题&#xf…

高性能网站建设的最佳实践(二)

原文译自雅虎开发者社区&#xff0c;转载译文请标明出处。关注我的sina微博&#xff0c;共同进步&#xff01;为了让网页响应速度更快Exceptional Performance团队列出了一系列的最佳实践&#xff0c;包括35个最佳实践条目&#xff0c;分成7种类型类。避免重定向标签&#xff1…

python带通配符的字符串匹配_Bash技巧:实例介绍数个参数扩展表达式以处理字符串变量...

Linux 的 bash shell 提供了多种形式的参数扩展表达式&#xff0c;可以获取变量自身的值&#xff0c;或者对变量值进行特定处理得到一个新的值&#xff0c;等等。本篇文章对字符串变量值相关的参数扩展表达式进行汇总说明。假设在 bash 中定义了 filepathexample/subdir/testfi…

幸福手机,给爸妈的高端大气上档次的手机

打造高端老人手机——幸福手机 江苏智联天地科技有限公司历经2年&#xff0c;手机研发投入超过4000万&#xff0c;打造中国第一品牌的高端老人手机&#xff0c;手机将于2014年12月正式对外发布&#xff0c;是国内第一款高端老人手机——幸福手机&#xff08;ThimFone&#xff0…

Fisher–Yates shuffle 算法

简单来说 Fisher–Yates shuffle 算法是一个用来将一个有限集合生成一个随机排列的算法(数组随机排序)。这个算法生成的随机排列是等概率的。同时这个算法非常高效。 Fisher–Yates shuffle 的原始版本,最初描述在 1938 年的 Ronald Fisher(上图) 和 Frank Yates 写的书中…

MASA Framework - EventBus设计

概述利用发布订阅模式来解耦不同架构层级&#xff0c;亦可用于解决隔离业务之间的交互优点&#xff1a;松耦合横切关注点可测试性事件驱动发布订阅模式发布者通过调度中心将消息发送给订阅者。调度中心解决发布与订阅者之间的关系&#xff0c;保证消息可以送达订阅者手中。发布…

Qt经验积累:常见的驱动打包处理方法

Qt对于常见的驱动打包,如数据库,图片等常用的插件驱动.如果处理不好,程序运行不起来,不能加载驱动,处理方法如下:在主程序中加入以下两句话:QString strLibPath(QDir::toNativeSeparators(QApplication::applicationDirPath())QDir::separator()"plugins"); a.addLib…

wireshark-win64-3.4.0安装_这9类轴承的安装方法,你可都知道?有哪些需要注意的呢?...

轴承是当代机械设备中一种重要零部件。随着时间的推移&#xff0c;轴承会发生磨损&#xff0c;合理的安装和使用可以让机械设备减少不必要的安全隐患。前面文章讲了如何拆卸轴承&#xff0c;今天就给大家讲讲各类轴承应该如何安装&#xff01;一、轴承安装前的准备工作轴承的安…

linux之which命令

我们经常在linux要查找某个文件&#xff0c;但不知道放在哪里了&#xff0c;可以使用下面的一些命令来搜索&#xff1a; which 查看可执行文件的位置。 whereis 查看文件的位置。 locate 配合数据库查看文件位置。 find 实际搜寻硬盘查询文…

slidingmenu能否实现菜单页在内容页上方,而不是把内容页挤到一边去????...

问题描述。。。。。。。。。。。。。。。。。。。。。。。。。。。。 解决方案1这样的话 你自己写不就好了 左边菜单view显示出来加一个动画 设置view的透明度 还用什么slidingmenu啊 解决方案2这个效果不是用的slidingmenu吧&#xff0c;自己实现一个 解决方案3对啊&#xff0…

史上最牛数学简史

全世界只有3.14 % 的人关注了爆炸吧知识“中国现代数学之父”华罗庚曾说过宇宙之大&#xff0c;粒子之微火箭之速&#xff0c;化工之巧地球之变&#xff0c;生物之谜日用之繁&#xff0c;无处不用数学回首往昔数学始终伴随我们左右纵横交错的几何、繁琐复杂的运算难以求解的方程…

log4net日志插件的使用

1、安装log4net2、引用3、配置&#xff08;web.config文件&#xff09;<configSections><section name"log4net" type"log4net.Config.Log4NetConfigurationSectionHandler, log4net"/></configSections><log4net><!--信息日志…

源代码提交SOP(Git版)

一、原则1、在维护公共基类、工具类和二方库等可能影响到其他团队成员的代码之前&#xff0c;必须同其他团队成员讨论&#xff0c;达成共识后方可进行维护。2、严格遵守源码签入规范&#xff0c;有助于发现代码漏洞&#xff0c;降低代码合并风险&#xff0c;降低远程仓库代码的…