asp.net core Webapi 3.1 上传文件的多种方法(附大文件上传) 以及swagger ui 上传文件

最新推荐文章于 2024-09-13 10:32:37 发布
最新推荐文章于 2024-09-13 10:32:37 发布
阅读量3.2k 收藏 13
点赞数 1
分类专栏： .net core 文章标签： c#
原文链接：https://www.cnblogs.com/Fengge518/p/13404119.html
版权
这篇教程详细介绍了如何在ASP.NET Core中实现文件上传，包括使用`IFormFile`接口处理文件，以及结合自定义JSON配置文件进行文件路径管理。同时，文章还展示了如何使用`UpLoadFileStreamHelper`辅助类进行文件写入操作，以及全局设置Kestrel服务器允许的最大请求体大小。
摘要由CSDN通过智能技术生成

ASP.NET CORE SWAGGER 教程二 - 简书

直接上干货了

1：WebApi后端代码2：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace ZRFCoreTestMongoDB.Controllers
{
    using Microsoft.AspNetCore.Authorization;
    using Microsoft.AspNetCore.Mvc.Filters;
    using Microsoft.AspNetCore.Mvc;
    using ZRFCoreTestMongoDB.Model;
    using ZRFCoreTestMongoDB.Commoms;


    using Microsoft.IdentityModel.Tokens;
    using System.Text;
    using System.Security.Claims;
    using System.IdentityModel.Tokens.Jwt;
    using Microsoft.AspNetCore.Http;
    using System.IO;
    using Microsoft.AspNetCore.Hosting;


    /// <summary>
    ///
    /// </summary>
    [ApiController]
    [Route("api/[Controller]")]
    public class MyJwtTestController : ControllerBase
    {
        private readonly JwtConfigModel _jsonmodel;
        private IWebHostEnvironment _evn;
        public MyJwtTestController(IWebHostEnvironment evn)
        {
            this._evn = evn;
            _jsonmodel = AppJsonHelper.InitJsonModel();
        }

        #region CoreApi文件上传

        [HttpPost, Route("UpFile")]
        public async Task<ApiResult> UpFile([FromForm]IFormCollection formcollection)
        {
            ApiResult result = new ApiResult();
            try
            {
                var files = formcollection.Files;//formcollection.Count > 0 这样的判断为错误的
                if (files != null && files.Any())
                {
                    var file = files[0];
                    string contentType = file.ContentType;
                    string fileOrginname = file.FileName;//新建文本文档.txt  原始的文件名称
                    string fileExtention = Path.GetExtension(fileOrginname);
                    string cdipath = Directory.GetCurrentDirectory();

                    string fileupName = Guid.NewGuid().ToString("d") + fileExtention;
                    string upfilePath = Path.Combine(cdipath + "/myupfiles/", fileupName);
                    if (!System.IO.File.Exists(upfilePath))
                    {
                        using var Stream = System.IO.File.Create(upfilePath);
                    }

                    #region MyRegion
                    //using (FileStream fileStream = new FileStream(upfilePath, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.ReadWrite))
                    //{
                    //    using (Stream stream = file.OpenReadStream()) //理论上这个方法高效些
                    //    {
                    //        await stream.CopyToAsync(fileStream);//ok
                    //        result.message = "上传成功！"; result.code = statuCode.success;
                    //    }
                    //}

                    //using (FileStream fileStream = new FileStream(upfilePath, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.ReadWrite))
                    //{
                    //    await file.CopyToAsync(fileStream);//ok
                    //    result.message = "上传成功！"; result.code = statuCode.success;
                    //}

                    #endregion

                    double count = await UpLoadFileStreamHelper.UploadWriteFileAsync(file.OpenReadStream(), upfilePath);
                    result.message = "上传成功！"; result.code = statuCode.success; result.data = $"上传的文件大小为:{count}MB";
                }
            }
            catch (Exception ex)
            {
                result.message = "上传异常,原因:" + ex.Message;
            }
            return result;

        }

        /// <summary>
        /// 文件上传 [FromForm]需要打上这个特性
        /// </summary>
        /// <param name="model">上传的字段固定为: file</param>
        /// <returns></returns>

        [HttpPost, Route("UpFile02")]
        public async Task<ApiResult> UpFileBymodel([FromForm]UpFileModel model)// 这里一定要加[FromForm]的特性，模型里面可以不用加
        {
            ApiResult result = new ApiResult();
            try
            {
                bool falg = await UpLoadFileStreamHelper.UploadWriteFileByModelAsync(model);
                result.code = falg ? statuCode.success : statuCode.fail;
                result.message = falg ? "上传成功" : "上传失败";
            }
            catch (Exception ex)
            {
                result.message = "上传异常,原因:" + ex.Message;
            }
            return result;
        }

        [HttpPost, Route("UpFile03")]
        public async Task<ApiResult> UpFile03(IFormFile file)// 这里一定要加[FromForm]的特性，模型里面可以不用加
        {
            ApiResult result = new ApiResult();
            try
            {
                bool flag = await UpLoadFileStreamHelper.UploadWriteFileAsync(file);
                result.code = flag ? statuCode.success : statuCode.fail;
                result.message = flag ? "上传成功" : "上传失败";
            }
            catch (Exception ex)
            {
                result.message = "上传异常,原因:" + ex.Message;
            }
            return result;
        }
        #endregion
    }
}

自定义的json配置文件

{

  "upfileInfo": {
    //上传存放文件的根目录
    "uploadFilePath": "/Myupfiles/"
  }
}

3：读取自定义的json文件

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace ZRFCoreTestMongoDB.Commoms
{
    using ZRFCoreTestMongoDB.Model;
    using Microsoft.Extensions.Configuration;
    public class AppJsonHelper
    {
        /// <summary>
        /// 固定的写法
        /// </summary>
        /// <returns></returns>
        public static JwtConfigModel InitJsonModel()
        {
            string key = "key_myjsonfilekey";
            JwtConfigModel cachemodel = SystemCacheHelper.GetByCache<JwtConfigModel>(key);
            if (cachemodel == null)
            {
                ConfigurationBuilder builder = new ConfigurationBuilder();
                var broot = builder.AddJsonFile("./configs/zrfjwt.json").Build();
                cachemodel = broot.GetSection("jwtconfig").Get<JwtConfigModel>();
                SystemCacheHelper.SetCacheByFile<JwtConfigModel>(key, cachemodel);
            }
            return cachemodel;
        }

        /// <summary>
        /// 获取到配置文件内容的实体
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="jsonName">jason 配置文件中内容节点</param>
        /// <param name="jsonFilePath">./configs/zrfjwt.json  json文件的路径需要始终赋值一下</param>
        /// <returns></returns>
        public static T GetJsonModelByFilePath<T>(string jsonName,string jsonFilePath)
        {
            if (!string.IsNullOrEmpty(jsonName))
            {
                ConfigurationBuilder builder = new ConfigurationBuilder();
                var broot = builder.AddJsonFile(jsonFilePath).Build();
                T model = broot.GetSection(jsonName).Get<T>();
                return model;
            }
            return default;
        }
    }
}

4：上传文件的测试帮助类

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace ZRFCoreTestMongoDB.Commoms
{
    using Microsoft.AspNetCore.Http;
    using Microsoft.AspNetCore.Mvc;
    using System.IO;
    using ZRFCoreTestMongoDB.Model;
    public class UpLoadFileStreamHelper
    {
        const int WRITE_FILE_SIZE = 1024 * 1024 * 2;
        /// <summary>
        /// 同步上传的方法WriteFile(Stream stream, string path)
        /// </summary>
        /// <param name="stream">文件流</param>
        /// <param name="path">物理路径</param>
        /// <returns></returns>
        public static double UploadWriteFile(Stream stream, string path)
        {
            try
            {
                double writeCount = 0;
                using (FileStream fileStream = new FileStream(path, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.ReadWrite, WRITE_FILE_SIZE))
                {
                    Byte[] by = new byte[WRITE_FILE_SIZE];
                    int readCount = 0;
                    while ((readCount = stream.Read(by, 0, by.Length)) > 0)
                    {
                        fileStream.Write(by, 0, readCount);
                        writeCount += readCount;
                    }
                    return Math.Round((writeCount * 1.0 / (1024 * 1024)), 2);
                }
            }
            catch (Exception ex)
            {

                throw new Exception("发生异常：" + ex.Message);
            }
        }
        /// <summary>
        /// WriteFileAsync(Stream stream, string path)
        /// </summary>
        /// <param name="stream">文件流</param>
        /// <param name="path">物理路径</param>
        /// <returns></returns>
        public static async Task<double> UploadWriteFileAsync(Stream stream, string path)
        {
            try
            {
                double writeCount = 0;
                using (FileStream fileStream = new FileStream(path, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.ReadWrite, WRITE_FILE_SIZE))
                {
                    Byte[] by = new byte[WRITE_FILE_SIZE];

                    int readCount = 0;
                    while ((readCount = await stream.ReadAsync(by, 0, by.Length)) > 0)
                    {
                        await fileStream.WriteAsync(by, 0, readCount);
                        writeCount += readCount;
                    }
                }
                return Math.Round((writeCount * 1.0 / (1024 * 1024)), 2);
            }
            catch (Exception ex)
            {

                throw new Exception("发生异常：" + ex.Message);
            }
        }

        /// <summary>
        /// 上传文件，需要自定义上传的路径
        /// </summary>
        /// <param name="file">文件接口对象</param>
        /// <param name="path">需要自定义上传的路径</param>
        /// <returns></returns>
        public static async Task<bool> UploadWriteFileAsync(IFormFile file, string path)
        {
            try
            {
                using (FileStream fileStream = new FileStream(path, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.ReadWrite, WRITE_FILE_SIZE))
                {
                    await file.CopyToAsync(fileStream);
                    return true;
                }
            }
            catch (Exception ex)
            {
                throw new Exception("发生异常：" + ex.Message);
            }
        }

        /// <summary>
        /// 上传文件，配置信息从自定义的json文件中拿取
        /// </summary>
        /// <param name="file"></param>
        /// <returns></returns>
        public static async Task<bool> UploadWriteFileAsync(IFormFile file)
        {
            try
            {
                if (file != null && file.Length > 0)
                {
                    string contentType = file.ContentType;
                    string fileOrginname = file.FileName;//新建文本文档.txt  原始的文件名称
                    string fileExtention = Path.GetExtension(fileOrginname);//判断文件的格式是否正确
                    string cdipath = Directory.GetCurrentDirectory();

                    // 可以进一步写入到系统自带的配置文件中
                    UpFIleModelByJson model = AppJsonHelper.GetJsonModelByFilePath<UpFIleModelByJson>("upfileInfo", "./configs/upfile.json");

                    string fileupName = Guid.NewGuid().ToString("d") + fileExtention;
                    string upfilePath = Path.Combine(cdipath + model.uploadFilePath , fileupName);//"/myupfiles/" 可以写入到配置文件中
                    if (!System.IO.File.Exists(upfilePath))
                    {
                        using var Stream = System.IO.File.Create(upfilePath);
                    }
                    using (FileStream fileStream = new FileStream(upfilePath, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.ReadWrite, WRITE_FILE_SIZE))
                    {
                        await file.CopyToAsync(fileStream);
                        return true;
                    }
                }
                return false;
            }
            catch (Exception ex)
            {
                throw new Exception("发生异常：" + ex.Message);
            }
        }


        public static async Task<bool> UploadWriteFileByModelAsync(UpFileModel model)
        {
            try
            {
                var files = model.file.Files;// formcollection.Files;//formcollection.Count > 0 这样的判断为错误的
                if (files != null && files.Any())
                {
                    var file = files[0];
                    string contentType = file.ContentType;
                    string fileOrginname = file.FileName;//新建文本文档.txt  原始的文件名称
                    string fileExtention = Path.GetExtension(fileOrginname);//判断文件的格式是否正确
                    string cdipath = Directory.GetCurrentDirectory();
                    string fileupName = Guid.NewGuid().ToString("d") + fileExtention;
                    string upfilePath = Path.Combine(cdipath + "/myupfiles/", fileupName);//可以写入到配置文件中
                    if (!System.IO.File.Exists(upfilePath))
                    {
                        using var Stream = System.IO.File.Create(upfilePath);
                    }
                    using (FileStream fileStream = new FileStream(upfilePath, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.ReadWrite))
                    {
                        using (Stream stream = file.OpenReadStream()) //理论上这个方法高效些
                        {
                            await stream.CopyToAsync(fileStream);
                            return true;
                        }
                    }
                }
            }
            catch (Exception ex)
            {
                throw new Exception("发生异常：" + ex.Message);
            }
            return false;
        }

        /*
         webapi 端的代码

        [HttpPost, Route("UpFile02")]
        public async Task<ApiResult> UpFileBymodel([FromForm]UpFileModel model)// 这里一定要加[FromForm]的特性，模型里面可以不用加
        {
            ApiResult result = new ApiResult();
            try
            {
                bool falg = await UpLoadFileStreamHelper.UploadFileByModel(model);
                result.code = falg ? statuCode.success : statuCode.fail;
                result.message = falg ? "上传成功" : "上传失败";
            }
            catch (Exception ex)
            {
                result.message = "上传异常,原因:" + ex.Message;
            }
            return result;
        }
         */
    }

    public class UpFileModel
    {
        public IFormCollection file { get; set; }
    }
}

5：全局大文件上传的使用：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

namespace CoreTestMongoDB
{
    public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                    webBuilder.ConfigureKestrel(c => c.Limits.MaxRequestBodySize = 1024 * 1024 * 300); // 全局的大小300M
                }).UseServiceProviderFactory(new Autofac.Extensions.DependencyInjection.AutofacServiceProviderFactory());
    }
}

6：最后上传成功的效果截图

 7：测试的不同效果截图

qq_18932003
关注
专栏目录
记录一次ASP.NET 3.1 Webapi中使用JWT认证过程
APPLEHU09的博客
07-05 1374
框架：asp.net 3.1IDE：VS2019一、创建一个.NET CORE 3.1的webapi项目，这里创建过程就不赘述了，使用VS2019一步步创建即可；二、创建完后需要NuGet Package手动添加Microsoft.AspNetCore.Authentication.JwtBearer库。三、为方便接口测试，我们先加入swagger接口帮助文档（1）手动添加Swashbuckle.AspNetCore.SwaggerGen；Swashbuckle.AspNetCore.SwaggerUI；U
## 简单使用.NET Core Webapi 加MVC 的配置
weixin_48002669的博客
10-29 863
简单使用.NET Core Webapi 加MVC 的配置 .NET Core 基本配置加Swagger #region 添加Swagger services.AddSwaggerGen(options => { options.IncludeXmlComments($"{AppDomain.CurrentDomain.BaseDirectory}/HrManagementSystem.WebApi
.NET webapi实现文件上传功能
01-06
ASP.NET 在WEBAPI中开发文件上传功能。以及MVC中如何调用
(转)WebApi 上传文件
weixin_34332905的博客
11-13 301
本文转载自：http://www.cnblogs.com/zj1111184556/p/3494502.html public class FileUploadController : ApiController { public async Task&lt;HttpResponseMessage&gt; Post() { ...
ASP.NET怎么实现WEB端上传超大文件
最新发布
weixin_52041354的博客
09-13 1488
前端：vue2,vue3,vue-cli,html,jquery后端：asp.net,.net core数据库：SQL Server,MySQL,Oracle,达梦,人大金仓,国产数据库功能：大文件上传下载，断点续传，文件夹上传下载，加密传输，加密存储，云对象存储该说不说，最近这块挻火的，今天早上又有网友加我微信，实际上我的微信号之前就已经在网上公开了，但是很多网友还是说找不到，这个就真没办法了。
ASP.NET Web Api Self Host大文件上传功能
weixin_30607029的博客
01-29 356
　　今天同事在使用ASP.NET WebApi开发一个文件上传功能时发现WebApi无法实现大文件上传功能，于是向我求助。 　　当我知道这个问题的时候第一反应是WebApi不可能不支持，于是就开始查看他的代码： View Code 1 var config = new HttpSelfHostConfiguration("http://localhost:8080"); ...
.Net Core WebApi文件上传
weixin_59180442的博客
03-15 2204
security>里面的数字就是大小，都是用字节来表示的。配置多大就用多大，比如我这个二十一亿大概就是2G，大家可以自行换算。
调用WebApi接口上传文件
06-25
.NetMvc调用WebApi接口进行上传文件
HerokuContainer：Heroku中的Dockerized ASP.NET Core 3 Web API应用程序
02-06
在此博客文章中，我们将创建一个容器化的ASP.NET Core 3.1 Web API项目，并使用Gi​​tHub Actions建立CI / CD管道。 在GitHub工作流程中，我们将构建和测试Web API项目，并将最终的docker映像部署到Heroku。 本文...
AspNetCore-DDD：具有DDD，CQRS和事件源的完整ASP.NET Core 3.1 LTS应用程序
02-04
ASP.NET WebApi核心 ASP.NET身份核心 实体框架核心3.1 .NET Core本机DI 自动贴图 FluentValidator 中介 招摇UI 微软SQL 单位 起订量 流利的断言 波莉 改装 设计模式 域驱动设计 域事件 域通知 CQRS 活动采购 ...
给asp.net core API增加目录浏览Swagger/OpenAPI
学无止境! 无休无止!
03-26 769
官网介绍 使用 Web API 时，了解其各种方法对开发人员来说可能是一项挑战。Swagger也称为OpenAPI，解决了为 Web API 生成有用文档和帮助页的问题。它具有诸如交互式文档、客户端 SDK 生成和 API 可发现性等优点。 https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/web-api-help-pages-...
Webapi 文件上传
10-31
支持文件上传，可以根据配置文件上传各种类型文件，文件大小
Asp.Net WebApi 上传文件方法（原生js上传和JQ ajax上传）
06-12
Asp.Net WebApi 上传文件方法： 实现功能： 1.原生js调用api上传 2.jq ajax调用api上传 上传文件
ASP.NET Web API 接收文件上传
05-24
ASP.NET Web API File Upload and Multipart MIME
ASP.NET WebAPi（selfhost）实现文件同步或异步上传
10-21
主要介绍了ASP.NET WebAPi（selfhost）实现文件同步或异步上传,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
Asp.Net Core WebApi 和Asp.Net WebApi上传文件
mihaw的博客
06-10 1403
1. public class UpLoadController : ControllerBase 2. { 3. private readonly IHostingEnvironment _hostingEnvironment; 4.   5. public UpLoadController(IHostingEnvironment hostingEnvironment) 6. { 7. _hostingEnvi
WebApi 文件上传
起风了
08-20 1209
[Route("UploadFile")] [HttpPost] public async Task<IHttpActionResult> UploadFile() { try { int result = 0; bool success = true; string error = ""...
Webapi之文件上传
Song_Lynn的博客
03-21 3488
Webapi之文件上传 范例说明： 前端：vue.js + element-ui + axios 后端：c# webapi 先上传存储起来，然后再读取文件 仅尝试过在本地调试，未验证服务器 前端部分 使用element-ui的上传组件 // html 直接调用api &amp;lt;el-upload class=&quot;upload-demo&quot; ref...
ASP.NET Core基础之图片文件(二)-WebApi图片文件上传到文件夹
物联网大联盟
01-03 3273
在WebApi项目中如何上传图片到指定文件夹中？赶快来学习吧...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值