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

  • 时间:
  • 浏览:2

@

前言

在很久挂接完一套简单的后台基础工程后,将会业务需用鼓捣了文件上传跟下载,挂接很久就迫不及待的想分享出来,希望有用到文件相关操作的我们我们我们都能不能 得到些帮助。

开始

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

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

ps:这里的钥匙可是个文件名,当然你都能不能 来个token啊哪几种的根据自己业务需用。

这里还是想分享下敲代码的经验,在我们我们我们动手很久,最好把能考虑到的东西一些想好,思路理清也可是打好提纲后,敲代码的速度会高有很久错误率也会低,行云流水都在天马行空,而有了你的大脑中将会有了山水鸟兽。

OK,流程清楚很久,我们我们我们开始动手敲代码吧。

首先,我们我们我们新建那我控制器FileController,当然名字都能不能 随意取,根据我们我们我们上述后端的思路,新建那我接口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)
        {

        }
    }

将会直接基因重组的我们我们我们,这里肯定是满眼红彤彤,这里主要用了那我类,那我请求实体RequestFileUploadEntity,那我回调实体MessageEntity,这那我我们我们我们到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值,用到了那我土辦法 ,我这里这样 装进去 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来加上那我跨域外理土辦法 ,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后边将会设置过,都能不能 根据自己业务需用调整。

打开文件看下与是是不是损坏,压缩包很容易看出来是是不是正常,假如有一天能打开基本上(当然将会会有问题)没问题。

解压出来将会正常那肯定可是没问题了吧(压缩你你你是什么玩意儿居然牛逼,节省了哪几个的存储空间,虽说硬盘白菜价)。

小结

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