.NET 9 中 IFormFile 的详细使用讲解

news2024/11/17 20:57:10

在.NET应用程序中，处理文件上传是一个常见的需求。.NET 9 提供了 IFormFile 接口，它可以帮助我们轻松地处理来自客户端的文件上传。以下是 IFormFile 的详细使用讲解。

IFormFile 接口简介

IFormFile 是一个表示上传文件的接口，它提供了以下属性和方法：
ContentType: 获取上传文件的MIME类型。
ContentDisposition: 获取与文件关联的Content-Disposition数据。
Headers: 获取与文件关联的HTTP头。
Length: 获取上传文件的大小（以字节为单位）。
Name: 获取上传文件的名称。
FileName: 获取上传文件的完整文件名。
CopyToAsync(Stream): 将文件内容异步复制到指定的流中。

在控制器中使用 IFormFile

以下是如何在ASP.NET Core MVC控制器中使用 IFormFile 的步骤。

1. 创建控制器

首先，创建一个控制器，例如 FileUploadController。

using Microsoft.AspNetCore.Mvc;
[ApiController]
[Route("api/[controller]")]
public class FileUploadController : ControllerBase
{
    // ...
}

2. 接收文件上传

在控制器中添加一个方法来接收上传的文件。

[HttpPost("upload")]
public async Task<IActionResult> UploadFile(IFormFile file)
{
    if (file == null || file.Length == 0)
    {
        return BadRequest("No file uploaded.");
    }
    // 处理文件
    var filePath = Path.Combine(Directory.GetCurrentDirectory(), "UploadedFiles", file.FileName);
    using (var stream = new FileStream(filePath, FileMode.Create))
    {
        await file.CopyToAsync(stream);
    }
    return Ok(new { fileName = file.FileName, size = file.Length });
}

3. 处理多个文件上传

如果你需要接收多个文件，可以修改方法以接受 IFormFile 数组。

[HttpPost("upload-multiple")]
public async Task<IActionResult> UploadMultipleFiles(IList<IFormFile> files)
{
    long size = files.Sum(f => f.Length);
    foreach (var file in files)
    {
        var filePath = Path.Combine(Directory.GetCurrentDirectory(), "UploadedFiles", file.FileName);
        using (var stream = new FileStream(filePath, FileMode.Create))
        {
            await file.CopyToAsync(stream);
        }
    }
    return Ok(new { count = files.Count, size });
}

4. 配置请求大小限制

默认情况下，ASP.NET Core 限制了请求的大小。如果你需要上传大文件，你可能需要配置这个限制。在 Startup.cs 或 Program.cs 中配置以下内容：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    // 配置文件上传大小限制
    services.Configure<FormOptions>(options =>
    {
        options.MultipartBodyLengthLimit = 1024 * 1024 * 500; // 500MB
    });
}