Userscripts项目中GM.xmlHttpRequest上传进度监控的实现分析

在Userscripts项目中，开发者ACTCD针对GM.xmlHttpRequest接口的upload属性实现进行了深入探讨。本文将全面解析这一功能的实现原理、技术背景以及与原生API的差异。

背景介绍

GM.xmlHttpRequest是用户脚本(Greasemonkey/Tampermonkey等)中常用的跨域请求接口，它基于XMLHttpRequest(XHR)进行了封装。其中upload属性用于监控数据上传进度，这在需要处理大文件上传或需要精确控制上传过程的场景中尤为重要。

技术实现差异

原始GM实现中，upload属性的回调函数接收的是与响应对象相同的Response Object参数。这种设计存在明显的不合理性，因为上传进度事件应该传递的是进度相关信息，而非响应数据。

Userscripts项目决定采用更符合标准的方式，参照原生XMLHttpRequestUpload API的实现。具体来说：

1. 上传进度回调将接收ProgressEvent对象，而非Response Object
2. ProgressEvent包含以下关键属性：
   • loaded：已传输的字节数
   • total：总共需要传输的字节数
   • lengthComputable：布尔值，表示总大小是否可知

技术选型考量

值得注意的是，虽然现代Web API提供了fetch方法，但它目前仍无法提供上传进度监控功能。这使得XHR及其封装在需要上传进度反馈的场景中仍具有不可替代的优势。

实现意义

这一改进使得：

• API行为更符合开发者预期
• 与标准Web API保持一致，降低学习成本
• 提供了更精确的上传进度监控能力
• 保持了与原始GM实现的兼容性，同时修正了不合理的设计

总结

Userscripts项目对GM.xmlHttpRequest上传监控的改进，体现了对API设计合理性和标准一致性的重视。这一变更虽然看似微小，但对于需要精细控制上传过程的用户脚本开发者来说，将提供更专业、更可靠的开发体验。