IT轮子系列（五）——MVC API 文件上传，总有一款是你需要的

前言

在对外提供的接口时，也常常需要提供上传文件的。在这篇文章中会描述三种上传方式。

1、第一款，通过Base64字符上传——PostFromBase64Str

首先，定义上传数据模型。对于模型的定义，一般都会给定名称、文件类型、数据字段。如下代码所示：

   /// <summary>
     /// 文件模型
     /// </summary>
     public class FileModel
     {
         /// <summary>
         /// 文件名称
         /// </summary>
         public string FileName { get; set; }
         /// <summary>
         /// 文件类型，如jpg,doc
         /// </summary>
         [Required(ErrorMessage = "{0}不能为空")]
         public string FileType { get; set; }
         /// <summary>
         /// base64字符串
         /// </summary>
         [Required(ErrorMessage="{0}不能为空")]
         public string FileStr { get; set; }

     }

ps:这篇文章也是在介绍swagger使用中使用的解决方案。

其次，在API控制器中定义接收文件的方法

         /// <summary>
         /// 使用base64字符串上传文件（图片）
         /// </summary>
         /// <param name="model">文件模型</param>
         /// <returns>ResultInfo</returns>
         [HttpPost]
         [Swashbuckle.Swagger.Annotations.SwaggerResponse(HttpStatusCode.OK, Type = typeof(ResultInfo<string>))]
         public HttpResponseMessage PostFromBase64Str([FromBody]FileModel model)
         {
             ResultInfo<string> result = new ResultInfo<string>();
             try
             {
                 string folderPath = System.Web.HttpContext.Current.Server.MapPath(@"/Upload/ApiFile/");
                 //判断项目路径是否存在
                 if (!System.IO.Directory.Exists(folderPath))
                 {
                     System.IO.Directory.CreateDirectory(folderPath);
                 }
                 //生成GUID文件名
                 string fileName = System.Guid.NewGuid().ToString().Replace("-", "") + "." + model.FileType;

                 //读取字符串转为字节数组
                 byte[] strs = Convert.FromBase64String(model.FileStr);
                 //文件保存路径
                 string filePath = folderPath + fileName;
                 using (System.IO.FileStream fs = new System.IO.FileStream(filePath,FileMode.OpenOrCreate,FileAccess.Write))
                 {
                     //保存文件
                     fs.WriteAsync(strs, , strs.Length);
                 }
             }
             catch (Exception ex)
             {
                 result.Status = "FAIL";
                 result.Msg = ex.Message;
             }
             return toJson<string>(result);
         }

这里要注意的是，有些工具将文件转为BASE64是带格式说明的，如下图：

在实际项目中，这个数据格式要跟前端或者调用方协商好，数据是只传逗号后面部分还是传所有的；如果是所有的，在接收的时候就需要后台处理，把数据截取出来。否则会保存不成功。

好了，第一款，上传文件就这么简单。

第二款，从Form表单上传文件—— PostFromFormData

我们都知道，在form表单中，可以使用input type=file 控件上传文件。在API 中也可以使用这个知识点。

使用这种方法上传，需要了解一个类：System.Web.HttpContext .Current.Request 。今天，在敲代码的时候，发现深入理解并用好这个Request就可以解决大部分请求的问题。建议，设置个断点进去看看它都有那些内容。

PostFromFormData 方法代码如下：

         /// <summary>
         /// 使用form表单上传文件
         /// </summary>
         /// <returns>ResultInfo</returns>
         [HttpPost]
         [Swashbuckle.Swagger.Annotations.SwaggerResponse(HttpStatusCode.OK, Type = typeof(ResultInfo<string>))]
         public HttpResponseMessage PostFromFormData()
         {
             ResultInfo<string> result = new ResultInfo<string>();
             try
             {
                 var rq = System.Web.HttpContext.Current.Request;
                 //这里跟前端调用或调用方 协商好，请求的content 类型必须为multipart/form-data
                 if (!rq.ContentType.Contains("multipart"))
                 {
                     result.Status = "FAIL";
                     return toJson<string>(result);
                 }
                 //读取表单数据，若是有其他参数，可以约定好统一放到form中，如Token,timestamp
                 var form = rq.Form;
                 //获取上传的文件集合，可能上传了多个文件
                 var files = rq.Files;
                 var count = files.Count;//获取文件的数量
                 var fileExtention = "";//文件的扩展名
                 if (count > )
                 {
                     // 在遍历文件前，需验证form上传的参数
                     //在实际项目中，常常需要做一些基础参数的验证
                     //if (!form.AllKeys.Contains("Token")) //若form没有添加Token参数，直接返回
                     //{
                     //    result.Status = "FAIL";
                     //    return toJson<string>(result);
                     //}
                     //遍历所有的文件
                     for (int i = ; i < count; i++)
                     {
                         var file = files[i];
                         var fileName = file.FileName;
                         var fileType = file.ContentType;//文件类型
                         //
                         fileExtention = fileName.Split('.')[];
                         //读取文件的二进制流
                         var itemStream = file.InputStream;
                         var filePath = "";//存储返回路径  在实际项目中，数据库存储的是相对路径，方便更换服务器。
                         bool back = SaveFileFromStream(itemStream, fileExtention, out filePath);
                         if (!back)
                         {
                             result.Status = "FAIL";
                             result.Msg = "UploadFail";
                         }
                     }
                 }
                 else
                 {
                     //使用二进制上传文件
                     var stream = rq.InputStream;
                 }

             }
             catch (Exception ex)
             {
                 result.Status = "FAIL";
                 result.Msg = ex.Message;
             }
             return toJson<string>(result);
         }

其中，保存文件的私有方法如下：

这样，只要完成以上两个方法就可以通过form表单上传文件拉。

PS：因为要测试文件的上传，暂时不懂如何配置swagger,让它支持上传文件。在这里，推荐使用Postman（网上自行下载安装） 进行测试。如下图所示：

1、设定请求地址以及请求内容

2、设定请求的数据，如下图：

这样，当我们点击发送之后，就能看到返回OK的结果。同时，在我们网站的目录，会看到上传成功的文件，如下图：

第三款，使用二进制Binary上传文件

从上面的方法PostFromFormData中就可以看到，count>0的分支，就是使用二进制上传的文件。其中的原理跟form表单是一样的，都是通过Inputstream。

这里面要注意的是，因为使用binary上传的时候，没法定义form表单数据。因此，需要在请求headers中添加参数。如协商好的文件类型等。

代码如下：

运行项目，启动postman,进行测试：

1、配置请求头

2、修改body 为Binay

点击发送，同样可以看到OK返回。在文件夹目录下也可看到新上传的文件：

总结

以上，就是通过API上传文件的三款方式，希望可以帮助到大家。在测试的时候，只是上传了图片。其实，在form表单上传中并不只限于图片，比如也可上传doc,txt等。因为都是通过inputstream保存文件，同时，其上传大文件类型也是可以知道的，因此，form表单这种方式是通用的。

PS:上传文件，应该还涉及到大文件的断点续传，不过在实际项目还没有碰到过断点需求这样的需求，这里就不作描述了。

大家，GOOD NIGTH!

补记

最近，ios、android 同事在调用这个接口的时候，发现，只有一个文件的时候，调用是成功。多个文件，就只接收到一个文件。后来发现，是他们上传的格式有问题。因此，大家在提供这个接口给第三方调用的是，务必按以下的

文件格式上传：

.POST /api/FriendDiary/PostFile HTTP/1.1
Content-Type: multipart/form-data; boundary=--------------------------
Host: 120.24.246.194:
content-length: 

----------------------------
Content-Disposition: form-data; name="UserId"

----------------------------
Content-Disposition: form-data; name="Token"

----------------------------
Content-Disposition: form-data; name="Timestamp"

wwww
----------------------------
Content-Disposition: form-data; name="RecordId"

----------------------------
Content-Disposition: form-data; name=""; filename="............_20170915173117.png"
Content-Type: image/png

文件流
------------------------------

                                              .

各个参数间，都是由边界相隔的。同时，每个参数行后面都是一个回车。APP部门同事上传多个文件之所以没有成功，就是在拼接第二个文件流的时候，少了回车。