webRequest.filterResponseData()
使用此函数可创建一个 webRequest.StreamFilter 对象来处理请求。流过滤器将使 Web 扩展完全控制流，能够监视和修改响应。扩展有责任写入并关闭或断开流的连接，因为默认行为是保持请求打开而不响应。
通常，您会从 webRequest 事件侦听器调用此函数。
Firefox 对脚本请求使用优化的字节缓存。此优化字节缓存会覆盖正常的请求缓存。来自此缓存的数据并非扩展可用的格式。如果您的扩展需要过滤脚本，请在 webRequest.onBeforeRequest 中创建您的过滤器。这样做可以确保在尝试从缓存加载之前创建过滤器，从而避免使用优化缓存。
Permissions
要使用此 API，您必须拥有 "webRequest" 和 "webRequestBlocking" API 权限，并且对于事件侦听器，需要针对主机拥有 主机权限。此外
- 从 Firefox 95 开始，要使用此 API 拦截与加载 Service Worker 脚本相关的请求，还需要
"webRequestFilterResponse.serviceWorkerScript"权限。 - 从 Firefox 110 开始，Manifest V3 扩展还必须请求
"webRequestFilterResponse"权限才能使用此 API。
语法
js
let filter = browser.webRequest.filterResponseData(
requestId // string
)
参数
requestId-
string。要过滤的请求的 ID。您可以从传递到任何webRequest事件侦听器的details对象中获取此 ID。
返回值
一个 webRequest.StreamFilter 对象，您可以使用它来监视和修改响应。
示例
此示例显示了一个最小实现，它会传递流数据，并在流完成接收数据时关闭过滤器流。该代码将从 webRequest 事件侦听器调用，并且事件侦听器会提供 details。
js
let filter = browser.webRequest.filterResponseData(details.requestId);
filter.ondata = (event) => {
console.log(`filter.ondata received ${event.data.byteLength} bytes`);
filter.write(event.data);
};
filter.onstop = (event) => {
// The extension should always call filter.close() or filter.disconnect()
// after creating the StreamFilter, otherwise the response is kept alive forever.
// If processing of the response data is finished, use close. If any remaining
// response data should be processed by Firefox, use disconnect.
filter.close();
};
此示例取自 http-response 示例扩展，它在 webRequest.onBeforeRequest 中创建一个过滤器并使用它来修改响应的第一个块。
js
function listener(details) {
let filter = browser.webRequest.filterResponseData(details.requestId);
let decoder = new TextDecoder("utf-8");
let encoder = new TextEncoder();
filter.ondata = (event) => {
let str = decoder.decode(event.data, { stream: true });
// Just change any instance of Example in the HTTP response
// to WebExtension Example.
str = str.replaceAll("Example", "WebExtension Example");
filter.write(encoder.encode(str));
filter.disconnect();
};
return {};
}
browser.webRequest.onBeforeRequest.addListener(
listener,
{ urls: ["https://example.com/*"], types: ["main_frame"] },
["blocking"],
);
扩展程序示例
注意： 上面的示例仅适用于未分块或流式传输的小型请求。更高级的示例记录在 webRequest.StreamFilter.ondata 中。
浏览器兼容性
加载中…