ASP.NET Core 8 Web API含IFormFile的响应转换失败及文件取回问题

问题根源 #

• 服务器返回的FileInformation包含IFormFile属性，该类型是ASP.NET Core专用于接收请求文件的抽象类，不支持JSON序列化，导致客户端反序列化时崩溃。
• 服务器端CopyToAsync未添加await，会导致文件未完全写入磁盘就返回响应，可能引发文件损坏。

服务器端改造方案 #

1. 创建可序列化的返回DTO

替换原有的FileInformation作为返回类型（或新增该DTO），用字节数组存储文件内容以支持序列化：

public class FileResponseDto
{
    public string Name { get; set; }
    public string Description { get; set; }
    public byte[] FileContent { get; set; }
}

// 保留原类用于接收上传数据
public class FileInformation
{
    public string Name { get; set; }
    public string Description { get; set; }
    public IFormFile File { get; set; }
}

2. 修改控制器方法

修复文件写入的异步问题，并返回可序列化的DTO（或直接返回文件流）：

[HttpPost("UploadFile")]
[Route("test")]
public async Task<FileResponseDto> CreateGame([FromForm] FileInformation fileInformation)
{
    // 保存上传文件到服务器
    try
    {
        string savePath = Path.Combine("wwwroot", fileInformation.Name);
        using (Stream fileStream = new FileStream(savePath, FileMode.Create))
        {
            await fileInformation.File.CopyToAsync(fileStream); // 必须添加await
        }
    }
    catch (Exception ex)
    {
        // 建议添加日志记录，不要吞掉异常
        throw;
    }

    // 读取要返回的目标文件（替换为实际文件路径）
    string targetFilePath = Path.Combine("wwwroot", "your-target-file.txt");
    byte[] fileContent = await System.IO.File.ReadAllBytesAsync(targetFilePath);

    // 返回可序列化的DTO
    return new FileResponseDto
    {
        Name = Path.GetFileName(targetFilePath),
        Description = "目标返回文件",
        FileContent = fileContent
    };
}

如果返回大文件，推荐直接返回文件流（更高效）：

[HttpPost("UploadFile")]
[Route("test")]
public async Task<IActionResult> CreateGame([FromForm] FileInformation fileInformation)
{
    // 保存上传文件逻辑...

    string targetFilePath = Path.Combine("wwwroot", "your-target-file.txt");
    var stream = new FileStream(targetFilePath, FileMode.Open);
    return File(stream, "application/octet-stream", Path.GetFileName(targetFilePath));
}

客户端改造方案 #

1. 创建对应DTO类

客户端无需IFormFile，使用与服务器一致的可序列化DTO：

public class FileResponseDto
{
    public string Name { get; set; }
    public string Description { get; set; }
    public byte[] FileContent { get; set; }
}

2. 修改请求与处理逻辑

修复文件ContentType设置，并处理返回的文件内容：

string filePath = @"TextFile1.txt";

using var form = new MultipartFormDataContent();
using var fileContent = new ByteArrayContent(await File.ReadAllBytesAsync(filePath));

// 设置正确的文件ContentType，比如文本文件用text/plain
fileContent.Headers.ContentType = MediaTypeHeaderValue.Parse("text/plain");

form.Add(fileContent, "File", Path.GetFileName(filePath));
form.Add(new StringContent("TextFile1.txt"), "Name");
form.Add(new StringContent("TextFile1.txt"), "Description");

var httpClient = new HttpClient()
{
    BaseAddress = new Uri("https://localhost:7009")
};

var response = await httpClient.PostAsync($"/api/UploadScore/test", form);
response.EnsureSuccessStatusCode(); // 确保请求成功

// 情况1：处理DTO响应
var responseContent = await response.Content.ReadAsStringAsync();
FileResponseDto f = JsonConvert.DeserializeObject<FileResponseDto>(responseContent);
// 保存返回的文件到本地
await File.WriteAllBytesAsync(Path.Combine(Environment.CurrentDirectory, f.Name), f.FileContent);

// 情况2：处理文件流响应（对应服务器返回FileStreamResult的场景）
using var stream = await response.Content.ReadAsStreamAsync();
using var fileStream = new FileStream("saved-target-file.txt", FileMode.Create);
await stream.CopyToAsync(fileStream);

额外注意事项 #

• 确保服务器wwwroot目录有写入权限，避免文件保存失败。
• 大文件场景优先使用文件流方式传输，避免内存占用过高。

内容的提问来源于stack exchange，提问作者infereno