.NET Core Web API 中的图像上传

Posted 2023-03-08

【中文标题】.NET Core Web API 中的图像上传

【英文标题】：Image upload in .NET Core Web API

【发布时间】：2020-01-14 06:57:03

【问题描述】：

我正在使用 .Net Core 开发 Web API，我需要允许客户端上传文件列表（主要是图像）并将它们保存到服务器。

我正在使用 ASP.NET Core 3.0

这是我的启动文件 启动.cs：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.AspNetCore.Http;


namespace ImageUplaodDemo

    public class Startup
    
        public Startup(IConfiguration configuration)
        
            Configuration = configuration;
        

        public IConfiguration Configuration  get; 

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        
            services.AddControllers();
        

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        
            if (env.IsDevelopment())
            
                app.UseDeveloperExceptionPage();
            
            else
            
                // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
                app.UseHsts();
            

            app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            
                endpoints.MapControllers();
            );
        
    

这是我的 ImageController 文件 ImageController.cs：

using System;
using System.IO;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace ImageUploadDemo.Controllers

    [Route("api/[controller]")]
    public class ImageController : ControllerBase
    
        public static IHostingEnvironment _environment;
        public ImageController(IHostingEnvironment environment)
        
            _environment = environment;
        
        public class FIleUploadAPI
        
            public IFormFile files  get; set; 
        
        [HttpPost]
        public async Task<string> Post(FIleUploadAPI files)
        
            if (files.files.Length > 0)
            
                try
                
                    if (!Directory.Exists(_environment.WebRootPath + "\\uploads\\"))
                    
                        Directory.CreateDirectory(_environment.WebRootPath + "\\uploads\\");
                    
                    using (FileStream filestream = System.IO.File.Create(_environment.WebRootPath + "\\uploads\\" + files.files.FileName))
                    
                        files.files.CopyTo(filestream);
                        filestream.Flush();
                        return "\\uploads\\" + files.files.FileName;
                    
                
                catch (Exception ex)
                
                    return ex.ToString();
                
            
            else
            
                return "Unsuccessful";
            
        
    

我正在尝试通过 POST 操作使用 POSTMAN 上传图像。 我使用 Body 标签下的表单数据将 REQUEST 分配给 POST 和我，并将 KEY 分配为文件以从桌面上传文件。但我收到以下错误。

我已经尝试了所有可能的方法，但遇到了同样的错误......

通过代码检查一次，需要对代码进行任何修改或对邮递员进行任何修改......

    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.13",
    "title": "Unsupported Media Type",
    "status": 415,
    "detail": null,
    "instance": null,
    "extensions": 
        "traceId": "|2c45b532-43521b159e7b734f."
    

【参考方案1】：

[HttpPost("UploadFile")]
 public async Task<string> UploadFile([FromForm] IFormFile file)
    
        string fName = file.FileName;
        string path = Path.Combine(hostingEnvironment.ContentRootPath, "Images/" + file.FileName);
        using (var stream = new FileStream(path, FileMode.Create))
        
            await file.CopyToAsync(stream);
        
        return file.FileName; 
    

您可以在控制器类中使用它。不需要创建 FileUploadAPi 类。

【讨论】：

那里的“hostingEnvironment”是什么。它在当前上下文中不存在。

私有 IHostingEnvironment 托管环境；

如果有多个动作/控制器需要上传图像，则需要创建一个单独的上传类，以减少代码重复。

官方文档警告不要使用用户提供的文件名，因为攻击者可能会提供恶意文件名。您可以使用string untrustedFileName = Path.GetFileName(pathName); 从文件名中删除路径，string myEncodedString = HttpUtility.HtmlEncode(myString); 对其进行 HTML 编码。并使用var filePath = Path.GetTempFileName(); 获取临时文件名和目录。来源：docs.microsoft.com

【参考方案2】：

删除这些行：

app.Run(async (context) =>

    await context.Response.WriteAsync("Controller didn't find anything!");
);

您正在使每个请求短路，只是返回“控制器没有找到任何东西！”接着就，随即。甚至没有任何东西进入管道。

【讨论】：

是的..它解决了这个问题......但是在邮递员中，当我尝试上传 jpef 文件时，它返回的 json 数据显示如下......并且图像没有上传到 wwwroot /上传。 "type": "tools.ietf.org/html/rfc7231#section-6.5.13", "title": "不支持的媒体类型", "status": 415, "detail": null, "instance": null, "extensions": "traceId": "| 91d2286c-4581ab206339b789。” 表示payload的格式不被方法或目标资源支持。

【参考方案3】：

你有没有尝试过官方文档？

https://docs.microsoft.com/en-us/aspnet/core/mvc/models/file-uploads?view=aspnetcore-2.2

还有这个 https://docs.microsoft.com/en-us/aspnet/core/tutorials/first-web-api?view=aspnetcore-2.2&tabs=visual-studio

我会尝试使用官方资源来学习此类主题，而不是随机的博客。

您是否调试过控制器？您的视图模型中的 IFormFile 是否已经映射？

应该自动找到控制器并响应：

http(s)://localhost:DEVPORT/api/Image

您可以添加一个返回字符串“Hello World”的索引端点，当您尝试连接浏览器时，您应该会看到一个 Json Response ..

不知道你为什么这样做：

app.Run(async (context) =>
            
                await context.Response.WriteAsync("Controller didn't find anything!");
            );

您是否在发布请求中发送了正确的正文？

【讨论】：

是的...我已在 post 请求中发送了正确的正文。我在 Postman 中收到了一个 json 响应 "type": "tools.ietf.org/html/rfc7231#section-6.5.13", "title": "Unsupported Media Type", "status": 415, "detail": null, "instance": null, "extensions" ：“traceId”：“|91d2286c-4581ab206339b789。” 这表明有效载荷的格式不被方法或目标资源支持。如何纠正这个...以便将图像上传到服务器？

您是否尝试设置邮递员发送编码为表单数据的文件？ ***.com/questions/46895523/…

是的....我已经做到了...邮递员被设置在正文标签下作为表单数据，我从桌面上传了 jpeg 图像文件...但是在点击发送后它显示 415 错误.显示不支持该格式。

我不是邮递员专家，但您是否尝试过使用 IFormFile 作为参数而不是您的 Model 并且您添加了 [FromForm] ？也许这值得一读：***.com/questions/44538772/…

控制器中不需要使用[FromForm]获取表单数据。框架自动将表单数据转换为模型。