ASP.NET Boilerplate 中实现文件上传进度反馈的解决方案

背景介绍

在ASP.NET Boilerplate框架中开发文件上传功能时，开发者经常会遇到需要实时反馈上传进度给前端的需求。传统的AJAX上传虽然可以实现进度监控，但在某些复杂场景下，开发者更倾向于使用Server-Sent Events(SSE)技术来实现更灵活的进度反馈机制。

问题分析

当尝试在ASP.NET Boilerplate中使用SSE技术返回上传进度时，会遇到一个常见的技术障碍：框架内置的AbpSecurityHeadersMiddleware会在响应已经开始后尝试设置安全相关的HTTP头信息，导致系统抛出"Headers are read-only, response has already started"异常。

技术原理

SSE技术要求服务器保持长连接并持续发送事件流数据。一旦响应开始，HTTP头就不能再被修改。而ASP.NET Boilerplate的安全中间件会在请求处理管道的后期阶段尝试添加安全相关的响应头，这与SSE的长连接特性产生了冲突。

解决方案

方案一：使用传统AJAX上传进度监控

对于大多数文件上传场景，使用XMLHttpRequest的progress事件已经足够满足需求：

$.ajax({
    url: '/FileUpload/UploadFile',
    type: 'POST',
    data: formData,
    processData: false,
    contentType: false,
    xhr: function() {
        var xhr = new window.XMLHttpRequest();
        xhr.upload.addEventListener('progress', function(evt) {
            if (evt.lengthComputable) {
                var percentComplete = (evt.loaded / evt.total) * 100;
                // 更新进度条
            }
        }, false);
        return xhr;
    }
});

对应的控制器代码更加简洁：

[DontWrapResult]
[HttpPost]
public async Task<IActionResult> UploadFile()
{
    var file = Request.Form.Files[0];
    var path = Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", "uploads");
    
    if (!Directory.Exists(path))
    {
        Directory.CreateDirectory(path);
    }
    
    await using var fileStream = new FileStream(Path.Combine(path, file.FileName), FileMode.Create);
    await file.CopyToAsync(fileStream);
    
    return Ok(file.FileName);
}

方案二：禁用特定路由的安全头

如果确实需要使用SSE技术，可以通过以下方式绕过安全头设置：

1. 创建一个自定义属性标记不需要安全头的Action
2. 在中间件中检查该属性并跳过安全头设置

方案三：调整中间件顺序

将安全中间件移到SSE处理之前，确保安全头在响应开始前设置完成。

最佳实践建议

1. 对于简单的上传进度需求，优先考虑使用AJAX的progress事件
2. 只有在需要复杂事件推送时才考虑SSE方案
3. 实现SSE时，注意处理好中间件的执行顺序
4. 考虑文件大小限制和超时设置，避免长连接占用过多服务器资源

总结

ASP.NET Boilerplate框架提供了强大的安全功能，但在处理特殊场景如SSE时需要特别注意中间件的执行顺序和响应头的设置时机。通过合理选择技术方案和适当的框架配置，可以既保证安全性又实现良好的用户体验。