系列目录

循序渐进学.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. 关于 Java 中的 Null

    什么是Java中的Null? null在Java中是一个非常重要的概念,它最初是为了表示缺少某些东西,例如缺少用户.资源或任何东西而发明出来的.但是这也为Java程序员带来了很多麻烦,比如最常见的空指 ...

  2. axios 参数拼接

    // 加载列表 getData () { this.$http .get("platform-framework/stucgbb/selectCHBBInit?type="+thi ...

  3. Linux命令（五）免密码远程登录和配置别名

    1. ssh-keygen 2. ssh-copy-id -p port user@remote .ssh中建立并编辑config文件 原来需要 ssh -p ubuntu@xxx.xxx.xxx 现 ...

  4. html5 canvas画布上合成

    source-over 默认.在目标图像上显示源图像. source-atop 在目标图像顶部显示源图像.源图像位于目标图像之外的部分是不可见的. source-in 在目标图像中显示源图像.只有目标 ...

  5. expect 交互 telnet 交互

    telnet 交互 #!/bin/bash Ip="10.0.1.53" a="\{\'method\'\:\'doLogin\'\,\'params\'\:\{\'uN ...

  6. TensorFlow 从零到helloWorld

    目录 1.git安装与使用 1.1 git安装 1.2 修改git bash默认路径 1.3 git常用操作 2.环境搭建   2.1 tensorflow安装   2.2 CUDA安装   2.3 ...

  7. Redis配置文件介绍

    Redis在源码包中存放了一个Redis配置实例文件,文件中对各个配置点进行了简单的介绍,我也通过这个文件来对Redis的一些配置进行一些简单介绍. 一.UNITS(单位)[了解] 1.Redis服务 ...

  8. Valid Parentheses & Longest Valid Parentheses

    Valid Parentheses Given a string containing just the characters '(', ')', '{', '}', '[' and ']', det ...

  9. MySQL管理工具MySQL Utilities — 介绍与安装(1)

    MySQL Utilities介绍 MySQL Utilities 提供一组命令行工具用于维护和管理 MySQL 服务器,包括: 管理工具 (克隆.复制.比较.差异.导出.导入) 复制工具 (安装.配 ...

  10. IE WebBrowser内核设置

    public class IEVersion { /// <summary> /// IE WebBrowser内核设置 /// </summary> public stati ...