zoukankan      html  css  js  c++  java
  • ASP.NET Core MVC中Controller的Action如何直接使用Response.Body的Stream流输出数据

    在ASP.NET Core MVC中,我们有时候需要在Controller的Action中直接输出数据到Response.Body这个Stream流中,例如如果我们要输出一个很大的文件到客户端浏览器让用户下载,那么在Controller的Action中用Response.Body这个Stream流,来逐步发送文件数据到客户端浏览器是最好的办法。

    但是我今天在ASP.NET Core MVC的Controller的Action中使用Response.Body输出数据到客户端浏览器的时候遇到了个问题,我们来看看下面这个Controller:

    using Microsoft.AspNetCore.Mvc;
    using System.IO;
    
    namespace AspNetCoreActionFilter.Controllers
    {
        public class HomeController : Controller
        {
            /// <summary>
            /// 显示一个网页供测试
            /// </summary>
            public IActionResult Index()
            {
                return View();
            }
    
            /// <summary>
            /// 调用此Action,采用Response.Body的Stream流发送字符串数据到客户端浏览器
            /// </summary>
            /// <returns>返回一个IActionResult对象</returns>
            public IActionResult WriteResponseWithReturn()
            {
                Response.ContentType = "text/html";
    
                using (StreamWriter sw = new StreamWriter(Response.Body))
                {
                    sw.Write("Write a string to response in WriteResponseWithReturn!");
                }
    
                return null;
            }
        }
    }

    可以看到这个HomeController非常简单就两个Action:

    • Index这个Action用于显示一个简单的网页做测试
    • WriteResponseWithReturn这个Action采用Response.Body的Stream流发送字符串数据到客户端浏览器,其返回类型为IActionResult,但是我们实际上返回的是一个null

    结果我在浏览器(IE浏览器)上输入Url地址"Home/WriteResponseWithReturn"返回的结果如下:

    可以看到页面报错了,但是返回的Http状态码是200,表示Http响应又是成功的。。。总之来说HomeController的WriteResponseWithReturn这个Action执行出问题了,我们输出到Response.Body的Stream流中的文字,没能正确发送到客户端浏览器。

    接着我修改了下HomeController的WriteResponseWithReturn这个Action,让其返回一个EmptyResult对象,如下所示:

    using Microsoft.AspNetCore.Mvc;
    using System.IO;
    
    namespace AspNetCoreActionFilter.Controllers
    {
        public class HomeController : Controller
        {
            /// <summary>
            /// 显示一个网页供测试
            /// </summary>
            public IActionResult Index()
            {
                return View();
            }
    
            /// <summary>
            /// 调用此Action,采用Response.Body的Stream流发送字符串数据到客户端浏览器
            /// </summary>
            /// <returns>返回一个IActionResult对象</returns>
            public IActionResult WriteResponseWithReturn()
            {
                Response.ContentType = "text/html";
    
                using (StreamWriter sw = new StreamWriter(Response.Body))
                {
                    sw.Write("Write a string to response in WriteResponseWithReturn!");
                }
    
                return new EmptyResult();
            }
        }
    }

    再尝试在浏览器上输入Url地址"Home/WriteResponseWithReturn",这次返回的结果如下:

    这次浏览器成功将我们输出到Response.Body的Stream流中的文字显示出来了,而且返回的Http状态码也是200

    接着我在HomeController中又定义了一个Action叫WriteResponseWithoutReturn,还是输出一段字符串数据到Response.Body的Stream流中,发送给客户端浏览器,但是WriteResponseWithoutReturn这个Action方法没有返回类型,返回类型为void,如下所示:

    using Microsoft.AspNetCore.Mvc;
    using System.IO;
    
    namespace AspNetCoreActionFilter.Controllers
    {
        public class HomeController : Controller
        {
            /// <summary>
            /// 显示一个网页供测试
            /// </summary>
            public IActionResult Index()
            {
                return View();
            }
    
            /// <summary>
            /// 调用此Action,采用Response.Body的Stream流发送字符串数据到客户端浏览器
            /// </summary>
            /// <returns>返回一个IActionResult对象</returns>
            public IActionResult WriteResponseWithReturn()
            {
                Response.ContentType = "text/html";
    
                using (StreamWriter sw = new StreamWriter(Response.Body))
                {
                    sw.Write("Write a string to response in WriteResponseWithReturn!");
                }
    
                return new EmptyResult();
            }
    
            /// <summary>
            /// 调用此Action,采用Response.Body的Stream流发送字符串数据到客户端浏览器
            /// </summary>
            public void WriteResponseWithoutReturn()
            {
                Response.ContentType = "text/html";
    
                using (StreamWriter sw = new StreamWriter(Response.Body))
                {
                    sw.Write("Write a string to response in WriteResponseWithoutReturn!");
                }
            }
        }
    }

    然后我在客户端浏览器上输入Url地址"Home/WriteResponseWithoutReturn"来访问我们新加的这个Action方法,这次返回的结果如下:

    可以看到如果Action返回的类型是void,那么输出到Response.Body的Stream流中的数据也可以成功发送到客户端浏览器。

    小结:

    所以当我们在ASP.NET Core MVC中Controller的Action中,要用Response.Body的Stream流输出数据到客户端时,有两种办法可以确保数据可以成功发送到客户端:

    • 如果基于某种原因必须要将Action方法的返回类型定义为非void类型(例如我们本例中的WriteResponseWithReturn方法返回的就是IActionResult类型),切记不要返回null,要返回一个EmptyResult对象才能保证Response.Body的Stream流数据能成功发送到客户端浏览器上。
    • 还有个办法就是将Action方法的返回类型定义为void(例如我们本例中的WriteResponseWithoutReturn方法),这样也可以安全地将Response.Body的Stream流数据发送到客户端浏览器上。
  • 相关阅读:
    js,h5页面判断客户端是ios还是安卓
    jQuery中没有innerHtml和innerText
    一个导航动画
    o'Reill的SVG精髓(第二版)学习笔记——第十二章
    o'Reill的SVG精髓(第二版)学习笔记——第十一章
    o'Reill的SVG精髓(第二版)学习笔记——第十章
    o'Reill的SVG精髓(第二版)学习笔记——第九章
    o'Reill的SVG精髓(第二版)学习笔记——第八章
    o'Reill的SVG精髓(第二版)学习笔记——第七章
    原生html、js手写 radio与checkbox 美化
  • 原文地址:https://www.cnblogs.com/OpenCoder/p/9835396.html
Copyright © 2011-2022 走看看