系列目录

循序渐进学.Net Core Web Api开发系列目录

本系列涉及到的源码下载地址：https://github.com/seabluescn/Blog_WebApi

一、概述

本篇介绍通过.NET core WebApi实现文件上传。

二、Controller端代码

直接上代码：

    [Route("api/files")]

    [Produces("application/json")]

    public class FileController : Controller

    {

        private readonly IHostingEnvironment _hostingEnvironment;

        public FileController(IHostingEnvironment hostingEnvironment)

        {

            _hostingEnvironment = hostingEnvironment;

        }

        [HttpPost("iform")]

        public ResultObject UploadIForm(List<IFormFile> files)

        {

            List<String> filenames = new List<string>();  foreach (var file in files)

            {

                var fileName = file.FileName;

                Console.WriteLine(fileName);

                fileName = $"/UploadFile/{fileName}";

                filenames.Add(fileName);

                fileName = _hostingEnvironment.WebRootPath + fileName;

                using (FileStream fs = System.IO.File.Create(fileName))

                {

                    file.CopyTo(fs);

                    fs.Flush();

                }

            }

            return new ResultObject

            {

                state = "Success",

                resultObject = filenames

            };

        }

为了同时返回上传的文件名和操作状态，我们定义了一个ResultObject的类来返回信息。

    public class ResultObject

    {

        public String state { get; set; }

        public Object resultObject { get; set; }

    }

返回上传的文件名称列表的目的是因为后台可能会给文件重新命名，以避免冲突，新的文件名称需要让前台知道。

后台的files是通过传入的参数获得的，还有其他两种方法可以获取到文件，效果一样：

       [HttpPost]

        public ResultObject UploadAjax()

        {

            var files = Request.Form.Files;

            ...

         }

或：

       public ResultObject UploadForm(IFormCollection form)

        {

            var files = form.Files;

            ...

       }

除了获取到files的方式不同，其他操作完全一致。

三、前端代码

<!DOCTYPE html>

<html>

<head>

    <meta charset="utf-8" />

    <title></title>

    <script src="lib/jquery/dist/jquery.min.js"></script>

    <script src="lib/jquery-form/dist/jquery.form.min.js"></script>

    <script type="text/javascript">

        function AjaxFormDataUploadfile() {

            var fileUpload = $("#files").get();

            var files = fileUpload.files;

            var data = new FormData();       
            for (var i = ; i < files.length; i++) {

                data.append("files", files[i]);

            }

            $.ajax({

                type: "POST",

                url: "/api/files/iform",

                contentType: false,

                processData: false,

                data: data,

                success: function (message) {

                    alert("success");

                },

                error: function () {

                    alert("上传文件出现错误！");

                }

            });

        }  </script>

</head>

<body>

    <form id="myform" method="post" action="/api/files/iform" enctype="multipart/form-data">

         <input type="file" id="files" name="files" multiple /> <br /><br />

         <input id="formupload" type="button" value="Form Data Upload" onclick="AjaxFormDataUploadfile();" /><br /><br />

    </form>

</body>

</html>

两个注意点：

1、form要提供enctype="multipart/form-data" 属性

2、如果要上传多个文件，文件表单需要提供multiple属性

这里我们通过FormData对象的append操作来构建提交的数据，根据我上一篇博客提到的，这里提交数据还有其他两个办法：

        function formuploadfile() {

            $("#myform").ajaxSubmit();

        }

或者：

        function Ajaxuploadfile() {

            var formdata = new FormData(document.getElementById("myform"));

            $.ajax({

                type: "POST",

                url: "/api/files/iform",

                contentType: false,

                processData: false,

                data: formdata,

                success: function (result) {

                    alert("success");

                    $.each(result.resultObject, function (i, filename) {

                        alert(filename);

                    });

                },

                error: function () {

                    alert("上传文件出现错误！");

                }

            });

        }

具体选择哪种方式，要看前端的需求，个人认为 var formdata = new FormData(document.getElementById("myform")); 比较方便。

四、上传大文件

上传大文件和上传小文件代码是一样的，关键是上传大文件时间太长，需要前端提供进度报告，不然用户体验太差。

解决的方案是利用ajax的HXR对象。

<!DOCTYPE html>

<html>

<head>

    <meta charset="utf-8" />

    <title></title>

    <script src="lib/jquery/dist/jquery.min.js"></script>

    <script src="lib/jquery-form/dist/jquery.form.min.js"></script>

    <script type="text/javascript">

        function AjaxuploadfileWithprogress() {

            var formdata = new FormData(document.getElementById("myform"));          

            $.ajax({

                type: "POST",

                url: "/api/files/iform",

                contentType: false,

                processData: false,

                data: formdata,

                success: function (result) {

                    alert("success");

                    $.each(result.resultObject, function (i, filename) {

                        alert(filename);

                    });

                },

                error: function () {

                    alert("上传文件出现错误！");

                },

                xhr: function () {

                    var xhr = $.ajaxSettings.xhr();

                    if (onprogress && xhr.upload) {

                        xhr.upload.addEventListener("progress", onprogress, false);

                        return xhr;

                    }

                }

            });

        }

        function onprogress(evt)

        {

            var loaded = evt.loaded;                  //已经上传大小

            var tot = evt.total;                      //附件总大小

            var per = Math.floor( * loaded / tot); //百分比

            $("#son").html(per + "%");

            $("#son").css("width", per + "%");

        }

    </script>

    <style type="text/css">

        #parent {

            width: 550px;

            height: 10px;

            border: 2px solid #09F;

        }

        #son {

            width: ;

            height: %;

            background-color: #09F;

            text-align: center;

            line-height: 10px;

            font-size: 20px;

            font-weight: bold;

        }

    </style>

</head>

<body>

    <form id="myform" method="post" action="/api/files/iform" enctype="multipart/form-data">

        <div>

            <div>

                <br />

                <p>表单多个上传文件:</p><br />

                <input type="file" id="files" name="files" multiple /> <br /><br />

                <input id="formuploadprogress" type="button" value="Ajax Upload Progress" onclick="AjaxuploadfileWithprogress();" /><br /><br />

                <div id="parent">

                    <div id="son"></div>

                </div>

            </div>

        </div>

    </form>

</body>

</html>

此时，可以看到上传进度条了，可以选择一个大文件测试一下。或者把浏览器的传输速度调低也可以进行调试。

五、为Swagger提供文件上传调试功能支持

目前swagger是不支持List<IFormFile>类型的，为了方便调试，我们为swagger提供该类型的支撑。

新增类：

public class SwaggerFileUploadListFilter : IOperationFilter

    {

        public void Apply(Operation operation, OperationFilterContext context)

        {

            if (!context.ApiDescription.HttpMethod.Equals("POST", StringComparison.OrdinalIgnoreCase) &&

                !context.ApiDescription.HttpMethod.Equals("PUT", StringComparison.OrdinalIgnoreCase))

            {

                return;

            }

            var fileParameters = context.ApiDescription.ActionDescriptor.Parameters.Where(n => n.ParameterType == typeof(List<IFormFile>)).ToList();

            if (fileParameters.Count < )

            {

                return;

            }

            operation.Consumes.Add("multipart/form-data");

            foreach (var fileParameter in fileParameters)

            {

                var parameter = operation.Parameters.Single(n => n.Name == fileParameter.Name);

                operation.Parameters.Remove(parameter);               

                NonBodyParameter p = new NonBodyParameter

                {

                    Name = parameter.Name,

                    In = "formData",

                    Description = parameter.Description,

                    Required = parameter.Required,

                    Type = "file"

                };   

                operation.Parameters.Add(p);

            }

        }

    }

在Startup类的ConfigureServices方法里注册该过滤器：

       public void ConfigureServices(IServiceCollection services)

        {

            services.AddMvc();

            services.AddCors();                      

            services.AddSwaggerGen(option =>

            {

                option.SwaggerDoc("v1", new Info

                {

                    Version = "v1",

                    Title = "SaleService接口文档",

                    Description = "RESTful API for SaleService.",

                    TermsOfService = "None",

                    Contact = new Contact { Name = "seabluescn", Email = "seabluescn@163.com", Url = "" }

                });

               

                option.OperationFilter<SwaggerFileUploadListFilter>();

                //Set the comments path for the swagger json and ui.

                var basePath = PlatformServices.Default.Application.ApplicationBasePath;

                var xmlPath = Path.Combine(basePath, "SaleService.xml");

                option.IncludeXmlComments(xmlPath);

            });

        }

此时可以通过swagger选择文件了

但有个缺点是只能上传一个文件，如何实现可以选择多个文件还不会搞。

循序渐进学.Net Core Web Api开发系列【5】：文件上传的更多相关文章

  1. 循序渐进学.Net Core Web Api开发系列【0】：序言与目录

    一.序言 我大约在2003年时候开始接触到.NET,最初在.NET framework 1.1版本下写过代码,曾经做过WinForm和ASP.NET开发.大约在2010年的时候转型JAVA环境,这么多 ...

  2. 循序渐进学.Net Core Web Api开发系列【16】：应用安全续-加密与解密

    系列目录 循序渐进学.Net Core Web Api开发系列目录 本系列涉及到的源码下载地址:https://github.com/seabluescn/Blog_WebApi 一.概述 应用安全除 ...

  3. 循序渐进学.Net Core Web Api开发系列【15】：应用安全

    系列目录 循序渐进学.Net Core Web Api开发系列目录 本系列涉及到的源码下载地址:https://github.com/seabluescn/Blog_WebApi 一.概述 本篇介绍W ...

  4. 循序渐进学.Net Core Web Api开发系列【14】：异常处理

    系列目录 循序渐进学.Net Core Web Api开发系列目录 本系列涉及到的源码下载地址:https://github.com/seabluescn/Blog_WebApi 一.概述 本篇介绍异 ...

  5. 循序渐进学.Net Core Web Api开发系列【13】：中间件（Middleware）

    系列目录 循序渐进学.Net Core Web Api开发系列目录 本系列涉及到的源码下载地址:https://github.com/seabluescn/Blog_WebApi 一.概述 本篇介绍如 ...

  6. 循序渐进学.Net Core Web Api开发系列【12】：缓存

    系列目录 循序渐进学.Net Core Web Api开发系列目录 本系列涉及到的源码下载地址:https://github.com/seabluescn/Blog_WebApi 一.概述 本篇介绍如 ...

  7. 循序渐进学.Net Core Web Api开发系列【11】：依赖注入

    系列目录 循序渐进学.Net Core Web Api开发系列目录 本系列涉及到的源码下载地址:https://github.com/seabluescn/Blog_WebApi 一.概述 本篇介绍如 ...

  8. 循序渐进学.Net Core Web Api开发系列【10】：使用日志

    系列目录 循序渐进学.Net Core Web Api开发系列目录 本系列涉及到的源码下载地址:https://github.com/seabluescn/Blog_WebApi 一.本篇概述 本篇介 ...

  9. 循序渐进学.Net Core Web Api开发系列【9】：常用的数据库操作

    系列目录 循序渐进学.Net Core Web Api开发系列目录 本系列涉及到的源码下载地址:https://github.com/seabluescn/Blog_WebApi 一.概述 本篇描述一 ...

  10. 循序渐进学.Net Core Web Api开发系列【8】：访问数据库(基本功能)

    系列目录 循序渐进学.Net Core Web Api开发系列目录 本系列涉及到的源码下载地址:https://github.com/seabluescn/Blog_WebApi 一.概述 本篇讨论如 ...

随机推荐

  1. 假装会python--爬取贴吧正文

    贴吧的老历史想存下来,强行python爬取一波 队友太强,躺好别动,偶尔做点副业 假装会python 基本流程: 1.爬取页面,获取页面的html源码 2.分析源码 通过正则表达式 匹配到想要的内容 ...

  2. [转]Robotium环境搭建中的Errors running builder 'Android Resource Manag

    转自:http://blog.sina.com.cn/s/blog_68f262210102v75t.html 最近学习了Robotium测试框架,当然学习任何一个框架或是语言之前,第一步就是搭建环境 ...

  3. SSO系统的实现

    当一个网站系统比较大型的时候,我们通常采用面向服务的编程,采用分布式的编程.各个子系统共同来实现一个大的系统,这时候登录注册功能的实现也面临着一些问题. 一.WHAT? SSO是什么? sso是单点登 ...

  4. Javascript中的垃圾回收机制

    Javascript 中的内存管理 译自MDN,Memory Management 简介 在底层语言中,比如C,有专门的内存管理机制,比如malloc() 和 free().而Javascript是有 ...

  5. 20155215 2016-2017-2 《Java程序设计》第7周学习总结

    20155215 2016-2017-2 <Java程序设计>第7周学习总结 教材学习内容总结 第十二章 lambda语法:Lambda去重复,回忆DRY原则,Lambda表达式可读性更好 ...

  6. [BZOJ 2299][HAOI 2011]向量 题解（裴蜀定理）

    [BZOJ 2299][HAOI 2011]向量 Description 给你一对数a,b,你可以任意使用(a,b), (a,-b), (-a,b), (-a,-b), (b,a), (b,-a), ...

  7. 04 uni-app框架学习：禁用顶部原生导航栏

    1.在pages.json中配置 比如要首页禁用 就在首页这个选项里 加上这几句代码 2.效果如下

  8. MySQL删除数据后磁盘空间的释放情况【转】

    OPTIMIZE TABLE 当您的库中删除了大量的数据后,您可能会发现数据文件尺寸并没有减小.这是因为删除操作后在数据文件中留下碎片所致.OPTIMIZE TABLE 是指对表进行优化.如果已经删除 ...

  9. mysql-5.7.13-winx64 免安装版配置方法

    1.下载MySQL Community Server 5.7.13 解压MySQL压缩包 2.修改 my-default.ini skip-grant-tables 作用是安装好MySQL后 免密码登 ...

  10. oracle列转行

    unpivot()函数需要Oracle版本大于等于11g --创建表 create table Fruit(id int,name varchar(20), Q1 int, Q2 int, Q3 in ...