前言

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

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部门同事上传多个文件之所以没有成功,就是在拼接第二个文件流的时候,少了回车。

IT轮子系列(五)——MVC API 文件上传,总有一款是你需要的的更多相关文章

  1. Spring MVC实现文件上传

    基础准备: Spring MVC为文件上传提供了直接支持,这种支持来自于MultipartResolver.Spring使用Jakarta Commons FileUpload技术实现了一个Multi ...

  2. MVC之文件上传1

    MVC之文件上传 前言 这一节我们来讲讲在MVC中如何进行文件的上传,我们逐步深入,一起来看看. Upload File(一) 我们在默认创建的项目中的Home控制器下添加如下: public Act ...

  3. Asp.net mvc 大文件上传 断点续传

    Asp.net mvc 大文件上传 断点续传 进度条   概述 项目中需要一个上传200M-500M的文件大小的功能,需要断点续传.上传性能稳定.突破asp.net上传限制.一开始看到51CTO上的这 ...

  4. Spring MVC的文件上传

    1.文件上传 文件上传是项目开发中常用的功能.为了能上传文件,必须将表单的method设置为POST,并将enctype设置为multipart/form-data.只有在这种情况下,浏览器才会把用户 ...

  5. Spring MVC的文件上传和下载

    简介: Spring MVC为文件上传提供了直接的支持,这种支持使用即插即用的MultipartResolver实现的.Spring MVC 使用Apache Commons FileUpload技术 ...

  6. 整合MVC实现文件上传

    1.整合MVC实现文件上传整合MVC实现文件上传在实际的开发中在实现文件上传的同时肯定还有其他信息需要保存到数据库,文件上传完毕之后需要将提交的基本信息插入数据库,那么我们来实现这个操作.整个MVC实 ...

  7. 【Spring学习笔记-MVC-13】Spring MVC之文件上传

    作者:ssslinppp       1. 摘要 Spring MVC为文件上传提供了最直接的支持,这种支持是通过即插即用的MultipartResolve实现的.Spring使用Jakarta Co ...

  8. MVC图片上传、浏览、删除 ASP.NET MVC之文件上传【一】(八) ASP.NET MVC 图片上传到服务器

    MVC图片上传.浏览.删除   1.存储配置信息 在web.config中,添加配置信息节点 <appSettings> <add key="UploadPath" ...

  9. spring mvc ajaxfileupload文件上传返回json下载问题

    问题:使用spring mvc ajaxfileupload 文件上传在ie8下会提示json下载问题 解决方案如下: 服务器代码: @RequestMapping(value = "/ad ...

随机推荐

  1. 显示图像的SIFT flow描述子

    close all; % 模拟figure 5 im = zeros(401,401,3); im(:,:,:) = 0; im(2:200, 2:200, 2) = 255; im(202:400, ...

  2. 华为解锁BL

    华为手机要怎么查看手机是否需要解锁呢?相信许多机油都不懂自己入手的手机是否需要解锁.而华为手机自华为C8812之后的高通手机均需要先解锁才能够尽兴刷机或获取Root权限的.那么下面我给大家分享一下华为 ...

  3. HTTP请求方法

    HTTP请求方法 根据HTTP标准,HTTP请求可以使用多种请求方法. HTTP1.0定义了三种请求方法: GET, POST 和 HEAD方法. HTTP1.1新增了五种请求方法:OPTIONS, ...

  4. UNIX环境高级编程——System V 共享内存区

    共享内存区域是被多个进程共享的一部分物理内存.如果多个进程都把该内存区域映射到自己的虚拟地址空间,则这些进程就都可以直接访问该共享内存区域,从而可以通过该区域进行通信.共享内存是进程间共享数据的一种最 ...

  5. 分布式进阶(二)Ubuntu 14.04下安装Dockr图文教程(二)

    4.1 构建我们自己的映像 构建Docker映像有两种方法: •通过docker commit(提交)命令 •通过docker build(构建)命令以及Docker文件(Dockerfile) 目前 ...

  6. android 的android httpClient详解

    AndroidHttpClient结构: public final class AndroidHttpClient extends Object implements HttpClient 前言: 这 ...

  7. 解决bootstrap row span设置border换行的问题

    Hadoop方面的毕业设计告一段落了,趁这几天空闲时间认真学习一下之前常使用但是却没用好的Bootstrap. 本文记录Bootstrap框架使用栅格系统时,遇到row内的span设置border换行 ...

  8. mpi中程序在集群中的分发

    我们在开发mpi程序时,由于其是分布式程序,我们在单个节点上完成编码后,需要将代码拷贝到整个集群进行测试.集群之间的文件拷贝可以通过scp命令完成.但是scp命令是针对两个节点之间文件互传设计,为了将 ...

  9. Java实现附近地点搜索

    Java,Mysql-根据一个给定经纬度的点,进行附近500米地点查询–合理利用算法 最近做一个项目:需要查询一个站点(已知该站点经纬度)1km-10km范围内的其它站点.所以,我首先想到的是,对每条 ...

  10. Android拼图游戏的设计逻辑,从切图到交互动画,从关卡到倒计时,实例提高!

    Android拼图游戏的设计逻辑,从切图到交互动画,从关卡到倒计时,实例提高! 群英传的最后一章,我大致的看了一下这个例子,发现鸿洋大神也做过,就参考两个人的设计逻辑,感觉都差不多,就这样实现起来了 ...