Violentmonkey中GM.xmlHttpRequest的正确使用方式

在用户脚本开发中，GM.xmlHttpRequest是一个非常重要的API，它允许脚本向其他域发送HTTP请求。然而，不同用户脚本管理器对这个API的实现存在差异，这可能导致兼容性问题。

核心问题分析

Violentmonkey和Greasemonkey对GM.xmlHttpRequest的实现遵循传统回调模式，而Tampermonkey则采用了Promise风格的实现。这种差异导致在Tampermonkey中可以链式调用.then()方法，但在Violentmonkey中会抛出"is not a function"错误。

正确的使用方法

在Violentmonkey中，GM.xmlHttpRequest应该这样使用：

GM.xmlHttpRequest({
  method: "GET",
  url: "https://example.com/api",
  onload: function(response) {
    if (response.status >= 200 && response.status < 300) {
      console.log("请求成功", response.responseText);
    } else {
      console.error("请求失败", response.status);
    }
  },
  onerror: function(error) {
    console.error("请求出错", error);
  }
});

兼容性解决方案

如果需要编写跨管理器的用户脚本，可以采用以下兼容性方案：

function makeRequest(url) {
  if (typeof GM.xmlHttpRequest === 'function') {
    // Violentmonkey/Greasemonkey风格
    return new Promise((resolve, reject) => {
      GM.xmlHttpRequest({
        url: url,
        onload: resolve,
        onerror: reject
      });
    });
  } else if (typeof GM.xmlHttpRequest === 'object' && 
             typeof GM.xmlHttpRequest.then === 'function') {
    // Tampermonkey风格
    return GM.xmlHttpRequest({url: url});
  }
  throw new Error('不支持的GM.xmlHttpRequest实现');
}

最佳实践建议

1. 始终检查API的可用性和行为特征
2. 为不同管理器编写适配层
3. 在文档中明确说明兼容性要求
4. 使用try-catch处理可能的异常
5. 考虑使用现代fetch API的polyfill作为替代方案

总结

理解不同用户脚本管理器对GM.xmlHttpRequest的实现差异对于开发跨平台兼容的用户脚本至关重要。Violentmonkey坚持与Greasemonkey保持一致的实现方式，采用传统的回调模式而非Promise风格。开发者应当根据目标环境选择合适的实现方式，或者编写兼容层来统一不同管理器的行为差异。