net core WebApi——文件分片上传与跨域请求处理

  • 时间:
  • 浏览:0

@

前言

在事先 下发完一套简单的后台基础工程后,如果业务都要鼓捣了文件上传跟下载,下发事先 就迫不及待的想分享出来,希望有用到文件相关操作的亲戚亲戚大伙儿还都要得到些帮助。

刚开使

亲戚亲戚大伙儿依然用亲戚亲戚大伙儿的基础工程,事先 也提到事先 续如果有测试功能这类的东西,会突然不断的更新这套代码(如果搞炸了事先 那就…),代码下载地址在net core Webapi 总目录,首先亲戚亲戚大伙儿都要理一下文件分片上传的思路:

  • 后端
  1. 接收前端文件上传请求并避免回调
  2. 根据前端传递的钥匙判断,允许后刚开使接收文件流并保存到临时文件夹
  3. 前端最终上传完成后给予后端合并请求(也称作上传完成确认),后端合并文件后判断最终文件是否是正确给予回调。
  • 前端
  1. 读取文件相关信息(名称,扩展类型,大小等基本信息)
  2. 根据都要做片段划分以及文件的md5值(md5主要用于最终确认文件是否是缺损)
  3. 请求后端获取钥匙
  4. 拿到钥匙后,亲戚亲戚大伙儿根据划分的片段去循环上传文件,并根据每次回调判断是否是上传成功,如失败则重新上传
  5. 最终循环完成后,给予后端合并请求(上传完成确认)

ps:这里的钥匙可是我个文件名,当然让人来个token啊哪此的根据个人业务都要。

这里还是想分享下敲代码的经验,在亲戚亲戚大伙儿动手事先 ,最好把能考虑到的东西统统想好,思路理清也可是我打好提纲后,敲代码的强度会高如果错误率也会低,行云流水都有天马行空,而有了你的大脑中如果有了山水鸟兽。

OK,流程清楚事先 ,亲戚亲戚大伙儿刚开使动手敲代码吧。

首先,亲戚亲戚大伙儿新建另4个 控制器FileController,当然名字还都要随意取,根据亲戚亲戚大伙儿上述后端的思路,新建另4个 接口RequestUploadFileFileSaveFileMerge

    [Route("api/[controller]")]
    [ApiController]
    public class FileController : ControllerBase
    {
        /// <summary>
        /// 请求上传文件
        /// </summary>
        /// <param name="requestFile">请求上传参数实体</param>
        /// <returns></returns>
        [HttpPost, Route("RequestUpload")]
        public MessageEntity RequestUploadFile([FromBody]RequestFileUploadEntity requestFile)
        {

        }

        /// <summary>
        /// 文件上传
        /// </summary>
        /// <returns></returns>
        [HttpPost, Route("Upload")]
        public async Task<MessageEntity> FileSave()
        {
        }

        /// <summary>
        /// 文件合并
        /// </summary>
        /// <param name="fileInfo">文件参数信息[name]</param>
        /// <returns></returns>
        [HttpPost, Route("Merge")]
        public async Task<MessageEntity> FileMerge([FromBody]Dictionary<string, object> fileInfo)
        {

        }
    }

如果直接群克隆的亲戚亲戚大伙儿,这里肯定是满眼红彤彤,这里主要用了另4个 类,另4个 请求实体RequestFileUploadEntity,另4个 回调实体MessageEntity,这另4个 亲戚亲戚大伙儿到Util工程创建(当然也还都要装进去 Entity工程,这里为哪此装进去 Util呢,如果我觉得装进去 这里公用比较好,毕竟还是有复用的价值的)。

    /// <summary>
    /// 文件请求上传实体
    /// </summary>
    public class RequestFileUploadEntity
    {
        private long _size = 0;
        private int _count = 0;
        private string _filedata = string.Empty;
        private string _fileext = string.Empty;
        private string _filename = string.Empty;

        /// <summary>
        /// 文件大小
        /// </summary>
        public long size { get => _size; set => _size = value; }
        /// <summary>
        /// 片段数量
        /// </summary>
        public int count { get => _count; set => _count = value; }
        /// <summary>
        /// 文件md5
        /// </summary>
        public string filedata { get => _filedata; set => _filedata = value; }
        /// <summary>
        /// 文件类型
        /// </summary>
        public string fileext { get => _fileext; set => _fileext = value; }
        /// <summary>
        /// 文件名
        /// </summary>
        public string filename { get => _filename; set => _filename = value; }
    }
    /// <summary>
    /// 返回实体
    /// </summary>
    public class MessageEntity
    {
        private int _Code = 0;
        private string _Msg = string.Empty;
        private object _Data = new object();

        /// <summary>
        /// 请况标识
        /// </summary>
        public int Code { get => _Code; set => _Code = value; }
        /// <summary>
        /// 返回消息
        /// </summary>
        public string Msg { get => _Msg; set => _Msg = value; }
        /// <summary>
        /// 返回数据
        /// </summary>
        public object Data { get => _Data; set => _Data = value; }
    }

创建完成写好事先 亲戚亲戚大伙儿在红的地方Alt+Enter,哪里爆红点哪里(so easy),好了,不扯犊子了,每个接口的依据如下。

RequestUploadFile

        public MessageEntity RequestUploadFile([FromBody]RequestFileUploadEntity requestFile)
        {
            LogUtil.Debug($"RequestUploadFile 接收参数:{JsonConvert.SerializeObject(requestFile)}");
            MessageEntity message = new MessageEntity();
            if (requestFile.size <= 0 || requestFile.count <= 0 || string.IsNullOrEmpty(requestFile.filedata))
            {
                message.Code = -1;
                message.Msg = "参数有误";
            }
            else
            {
                //这里都要记录文件相关信息,并返回文件guid名,后续请求带上此参数
                string guidName = Guid.NewGuid().ToString("N");

                //前期单台服务器还都要记录Cache,多台后需考虑redis或数据库
                CacheUtil.Set(guidName, requestFile, new TimeSpan(0, 10, 0), true);

                message.Code = 0;
                message.Msg = "";
                message.Data = new { filename = guidName };
            }
            return message;
        }

FileSave

        public async Task<MessageEntity> FileSave()
        {
            var files = Request.Form.Files;
            long size = files.Sum(f => f.Length);
            string fileName = Request.Form["filename"];

            int fileIndex = 0;
            int.TryParse(Request.Form["fileindex"], out fileIndex);
            LogUtil.Debug($"FileSave刚开使执行获取数据:{fileIndex}_{size}");
            MessageEntity message = new MessageEntity();
            if (size <= 0 || string.IsNullOrEmpty(fileName))
            {
                message.Code = -1;
                message.Msg = "文件上传失败";
                return message;
            }

            if (!CacheUtil.Exists(fileName))
            {
                message.Code = -1;
                message.Msg = "请重新请求上传文件";
                return message;
            }

            long fileSize = 0;
            string filePath = $".{AprilConfig.FilePath}{DateTime.Now.ToString("yyyy-MM-dd")}/{fileName}";
            string saveFileName = $"{fileName}_{fileIndex}";
            string dirPath = Path.Combine(filePath, saveFileName);
            if (!Directory.Exists(filePath))
            {
                Directory.CreateDirectory(filePath);
            }

            foreach (var file in files)
            {
                //如果有文件
                if (file.Length > 0)
                {
                    fileSize = 0;
                    fileSize = file.Length;

                    using (var stream = new FileStream(dirPath, FileMode.OpenOrCreate))
                    {
                        await file.CopyToAsync(stream);
                    }
                }
            }

            message.Code = 0;
            message.Msg = "";
            return message;
        }

FileMerge

        public async Task<MessageEntity> FileMerge([FromBody]Dictionary<string, object> fileInfo)
        {
            MessageEntity message = new MessageEntity();
            string fileName = string.Empty;
            if (fileInfo.ContainsKey("name"))
            {
                fileName = fileInfo["name"].ToString();
            }
            if (string.IsNullOrEmpty(fileName))
            {
                message.Code = -1;
                message.Msg = "文件名能上能

为空";
                return message;
            }

            //最终上传完成后,请求合并返回合并消息
            try
            {
                RequestFileUploadEntity requestFile = CacheUtil.Get<RequestFileUploadEntity>(fileName);
                if (requestFile == null)
                {
                    message.Code = -1;
                    message.Msg = "合并失败";
                    return message;
                }
                string filePath = $".{AprilConfig.FilePath}{DateTime.Now.ToString("yyyy-MM-dd")}/{fileName}";
                string fileExt = requestFile.fileext;
                string fileMd5 = requestFile.filedata;
                int fileCount = requestFile.count;
                long fileSize = requestFile.size;

                LogUtil.Debug($"获取文件路径:{filePath}");
                LogUtil.Debug($"获取文件类型:{fileExt}");

                string savePath = filePath.Replace(fileName, "");
                string saveFileName = $"{fileName}{fileExt}";
                var files = Directory.GetFiles(filePath);
                string fileFinalName = Path.Combine(savePath, saveFileName);
                LogUtil.Debug($"获取文件最终路径:{fileFinalName}");
                FileStream fs = new FileStream(fileFinalName, FileMode.Create);
                LogUtil.Debug($"目录文件下文件总数:{files.Length}");

                LogUtil.Debug($"目录文件排序前:{string.Join(",", files.ToArray())}");
                LogUtil.Debug($"目录文件排序后:{string.Join(",", files.OrderBy(x => x.Length).ThenBy(x => x))}");
                byte[] finalBytes = new byte[fileSize];
                foreach (var part in files.OrderBy(x => x.Length).ThenBy(x => x))
                {
                    var bytes = System.IO.File.ReadAllBytes(part);

                    await fs.WriteAsync(bytes, 0, bytes.Length);
                    bytes = null;
                    System.IO.File.Delete(part);//删除分块
                }
                fs.Close();
                //这名地方会引发文件被占用异常
                fs = new FileStream(fileFinalName, FileMode.Open);
                string strMd5 = GetCryptoString(fs);
                LogUtil.Debug($"文件数据MD5:{strMd5}");
                LogUtil.Debug($"文件上传数据:{JsonConvert.SerializeObject(requestFile)}");
                fs.Close();
                Directory.Delete(filePath);
                //如果MD5与原MD5不匹配,提示重新上传
                if (strMd5 != requestFile.filedata)
                {
                    LogUtil.Debug($"上传文件md5:{requestFile.filedata},服务器保存文件md5:{strMd5}");
                    message.Code = -1;
                    message.Msg = "MD5值不匹配";
                    return message;
                }

                CacheUtil.Remove(fileInfo["name"].ToString());
                message.Code = 0;
                message.Msg = "";
            }
            catch (Exception ex)
            {
                LogUtil.Error($"合并文件失败,文件名称:{fileName},错误信息:{ex.Message}");
                message.Code = -1;
                message.Msg = "合并文件失败,请重新上传";
            }
            return message;
        }

这里说明下,在Merge的事先 ,主要校验md5值,用到了另4个 依据,我这里没有 装进去 Util(我觉得是如果懒),代码如下:

        /// <summary>
        /// 文件流加密
        /// </summary>
        /// <param name="fileStream"></param>
        /// <returns></returns>
        private string GetCryptoString(Stream fileStream)
        {
            MD5 md5 = new MD5CryptoServiceProvider();
            byte[] cryptBytes = md5.ComputeHash(fileStream);
            return GetCryptoString(cryptBytes);
        }

        private string GetCryptoString(byte[] cryptBytes)
        {
            //加密的二进制转为string类型返回
            StringBuilder sb = new StringBuilder();
            for (int i = 0; i < cryptBytes.Length; i++)
            {
                sb.Append(cryptBytes[i].ToString("x2"));
            }
            return sb.ToString();
        }

测试

依据写好了事先 ,亲戚亲戚大伙儿需不都要测试呢,那都有废话么,个人的代码不过一遍等着让测试人员搞你呢。

再说个编码习惯,可是我个人的代码个人最起码常规的过一遍,可是我说跟大厂一样哪此KPI啊啥的影响,个人的东西最起码背熟手让人一看知道用心了就行,不说哪此测试全覆盖,可是我1+1=2这名基本的正常就OK。

tcp连接运行事先 ,我这里写了个简单的测试界面,运行事先 发现提示OPTIONS,果断跨域错误,还记得亲戚亲戚大伙儿事先 提到的跨域大问题,这里给出避免依据。

跨域

跨域,可是我我在这名区域,想跟原先区域联系的事先 ,亲戚亲戚大伙儿会碰到墙,这堵墙的目的可是我,禁止不同区域的人私下交流沟通,如果现在亲戚亲戚大伙儿可是我何必 这堵墙如果说要开好多个门语录为社 么做呢,net core有专门设置的地方,亲戚亲戚大伙儿回到Startup这里。

亲戚亲戚大伙儿来看新增的代码:

        public IServiceProvider ConfigureServices(IServiceCollection services)
        {
            //…事先

的代码忽略
            
            services.AddCors(options =>
            {
                options.AddPolicy("AllowAll", p =>
                {
                    p.AllowAnyOrigin()
                    .AllowAnyMethod()
                    .AllowAnyHeader()
                    .AllowCredentials();
                });
            });
            
            services.AddAspectCoreContainer();
            return services.BuildAspectInjectorProvider();

        }

AddCors来加在另4个 跨域避免依据,AddPolicy可是我加个巡逻官,看看符合规则的装进去 来,不符合的直接赶出去。

AllowAnyOrigin 允许所有的域名请求
AllowAnyMethod 允许所有的请求依据GET/POST/PUT/DELETE
AllowAnyHeader 允许所有的头部参数
AllowCredentials 允许携带Cookie

这里我使用的是允许所有,还都要根据自身业务都要来调整,比如只允许次责域名访问,次责请求依据,次责Header:

            //可是我示例,具体根据自身都要
            services.AddCors(options =>
            {
                options.AddPolicy("AllowSome", p =>
                 {
                     p.WithOrigins("https://www.baidu.com")
                     .WithMethods("GET", "POST")
                     .WithHeaders(HeaderNames.ContentType, "x-custom-header");
                 });
            });

写好事先 亲戚亲戚大伙儿在Configure中声明注册使用哪个巡逻官。

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            //…事先

的
            app.UseCors("AllowAll");  
            
            app.UseHttpsRedirection();
            app.UseMvc();      
        }

好了,设置好跨域事先 亲戚亲戚大伙儿再来执行下上传操作。

亲戚亲戚大伙儿就看这名提示事先 ,是都有能想起来哪此,亲戚亲戚大伙儿事先 做过顶端层谁能谁能告诉我还记得不,忘了的亲戚亲戚大伙儿还都要再看下net core Webapi基础工程搭建(七)——小试AOP及常规测试_Part 1。

在appsettings.json加在在接口白名单。

  "AllowUrl": "/api/Values,/api/File/RequestUpload,/api/File/Upload,/api/File/Merge"

设置好事先 ,亲戚亲戚大伙儿继续上传,这次突然否是还都要了(文件后缀这名忽略,测试使用,js可是我做了个简单的substring)。

亲戚亲戚大伙儿来查看上传文件记录的日志信息。



再来亲戚亲戚大伙儿看下文件存储的位置,这名位置亲戚亲戚大伙儿在appsettings顶端如果设置过,还都要根据个人业务都要调整。

打开文件看下是否是有损坏,压缩包很容易看出来是否是正常,如果要打开基本上(当然如果要有大问题)没大问题。

解压出来如果正常那肯定可是我没大问题了吧(压缩这名玩意儿我觉得 牛逼,节省了好多个的存储空间,虽说硬盘白菜价)。

小结

在下发文件上传这篇刚好捎带着把跨域也简单了过了一遍,下来都要再折腾的东西可是我大文件的分片下载,大致的思路与文件上传一致,毕竟都有另4个 大蛋糕,切成好好多个,你一块,剩下的都有我的。