类：WebRequest

类: WebRequest

拦截和修改请求在其生命周期的各个阶段的内容。

进程: 主进程
此类未从 'electron' 模块导出。它仅作为 Electron API 中其他方法的返回值可用。

通过使用 Session 的 webRequest 属性来访问 WebRequest 类的实例。

WebRequest 的方法接受一个可选的 filter 和一个 listener。当 API 的事件发生时，listener 将使用 listener(details) 调用。details 对象描述了请求。

⚠️ 只有最后一个附加的 listener 会被使用。将 null 作为 listener 传递将取消订阅该事件。

filter 对象有一个 urls 属性，它是一个 URL 模式的数组，用于过滤掉不匹配 URL 模式的请求。如果省略了 filter，则将匹配所有请求。

对于某些事件，listener 会传递一个 callback，当 listener 完成其工作时，应该使用 response 对象调用该 callback。

一个添加 User-Agent 请求头部的示例

const { session } = require('electron')

// Modify the user agent for all requests to the following urls.
const filter = {
  urls: ['https://*.github.com/*', '*://electron.github.io/*']
}

session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback) => {
  details.requestHeaders['User-Agent'] = 'MyAgent'
  callback({ requestHeaders: details.requestHeaders })
})

实例方法

WebRequest 实例上可用的方法如下

webRequest.onBeforeRequest([filter, ]listener)

• filter WebRequestFilter (可选)
• listener 函数 | null
  • details Object
    • id Integer
    • url string
    • method 字符串
    • webContentsId 整数 (可选)
    • webContents WebContents (可选)
    • frame WebFrameMain | null (可选) - 请求的框架。如果框架已导航或销毁，则可能为 null。
    • resourceType 字符串 - 可以是 mainFrame、subFrame、stylesheet、script、image、font、object、xhr、ping、cspReport、media、webSocket 或 other。
    • referrer 字符串
    • timestamp 双精度浮点数
    • uploadData UploadData[]
  • callback Function
    • response 对象
      • cancel 布尔值 (可选)
      • redirectURL 字符串 (可选) - 原始请求将被阻止发送或完成，而是重定向到给定的 URL。

当请求即将发生时，将使用 listener(details, callback) 调用 listener。

uploadData 是 UploadData 对象的数组。

必须使用 response 对象调用 callback。

一些有效的 urls 示例

'<all_urls>'
'http://foo:1234/'
'http://foo.com/'
'http://foo:1234/bar'
'*://*/*'
'*://example.com/*'
'*://example.com/foo/*'
'http://*.foo:1234/'
'file://foo:1234/bar'
'http://foo:*/'
'*://www.foo.com/'

webRequest.onBeforeSendHeaders([filter, ]listener)

• filter WebRequestFilter (可选)
• listener 函数 | null
  • details Object
    • id Integer
    • url string
    • method 字符串
    • webContentsId 整数 (可选)
    • webContents WebContents (可选)
    • frame WebFrameMain | null (可选) - 请求的框架。如果框架已导航或销毁，则可能为 null。
    • resourceType 字符串 - 可以是 mainFrame、subFrame、stylesheet、script、image、font、object、xhr、ping、cspReport、media、webSocket 或 other。
    • referrer 字符串
    • timestamp 双精度浮点数
    • uploadData UploadData[] (可选)
    • requestHeaders Record<string, string>
  • callback Function
    • beforeSendResponse 对象
      • cancel 布尔值 (可选)
      • requestHeaders Record<string, string | string[]> (可选) - 如果提供，请求将使用这些头部。

listener 将在发送 HTTP 请求之前调用，此时请求头部可用。这可能发生在与服务器建立 TCP 连接之后，但在发送任何 http 数据之前。

必须使用 response 对象调用 callback。

webRequest.onSendHeaders([filter, ]listener)

• filter WebRequestFilter (可选)
• listener 函数 | null
  • details Object
    • id Integer
    • url string
    • method 字符串
    • webContentsId 整数 (可选)
    • webContents WebContents (可选)
    • frame WebFrameMain | null (可选) - 请求的框架。如果框架已导航或销毁，则可能为 null。
    • resourceType 字符串 - 可以是 mainFrame、subFrame、stylesheet、script、image、font、object、xhr、ping、cspReport、media、webSocket 或 other。
    • referrer 字符串
    • timestamp 双精度浮点数
    • requestHeaders Record<string, string>

listener 将使用 listener(details) 调用，在请求即将发送到服务器时，之前 onBeforeSendHeaders 响应的修改在此 listener 被触发时可见。

webRequest.onHeadersReceived([filter, ]listener)

• filter WebRequestFilter (可选)
• listener 函数 | null
  • details Object
    • id Integer
    • url string
    • method 字符串
    • webContentsId 整数 (可选)
    • webContents WebContents (可选)
    • frame WebFrameMain | null (可选) - 请求的框架。如果框架已导航或销毁，则可能为 null。
    • resourceType 字符串 - 可以是 mainFrame、subFrame、stylesheet、script、image、font、object、xhr、ping、cspReport、media、webSocket 或 other。
    • referrer 字符串
    • timestamp 双精度浮点数
    • statusLine 字符串
    • statusCode 整数
    • responseHeaders Record<string, string[]> (可选)
  • callback Function
    • headersReceivedResponse 对象
      • cancel 布尔值 (可选)
      • responseHeaders Record<string, string | string[]> (可选) - 如果提供，则假定服务器使用这些头部响应。
      • statusLine 字符串 (可选) - 如果要覆盖 responseHeaders 以更改头部状态，则应提供此项，否则将使用原始响应头部状态。

当请求的 HTTP 响应头部被接收时，将使用 listener(details, callback) 调用 listener。

必须使用 response 对象调用 callback。

webRequest.onResponseStarted([filter, ]listener)

• filter WebRequestFilter (可选)
• listener 函数 | null
  • details Object
    • id Integer
    • url string
    • method 字符串
    • webContentsId 整数 (可选)
    • webContents WebContents (可选)
    • frame WebFrameMain | null (可选) - 请求的框架。如果框架已导航或销毁，则可能为 null。
    • resourceType 字符串 - 可以是 mainFrame、subFrame、stylesheet、script、image、font、object、xhr、ping、cspReport、media、webSocket 或 other。
    • referrer 字符串
    • timestamp 双精度浮点数
    • responseHeaders Record<string, string[]> (可选)
    • fromCache 布尔值 - 指示响应是否从磁盘缓存中获取。
    • statusCode 整数
    • statusLine 字符串

当接收到响应主体的第一个字节时，将使用 listener(details) 调用 listener。对于 HTTP 请求，这意味着状态行和响应头部可用。

webRequest.onBeforeRedirect([filter, ]listener)

• filter WebRequestFilter (可选)
• listener 函数 | null
  • details Object
    • id Integer
    • url string
    • method 字符串
    • webContentsId 整数 (可选)
    • webContents WebContents (可选)
    • frame WebFrameMain | null (可选) - 请求的框架。如果框架已导航或销毁，则可能为 null。
    • resourceType 字符串 - 可以是 mainFrame、subFrame、stylesheet、script、image、font、object、xhr、ping、cspReport、media、webSocket 或 other。
    • referrer 字符串
    • timestamp 双精度浮点数
    • redirectURL 字符串
    • statusCode 整数
    • statusLine 字符串
    • ip 字符串 (可选) - 请求实际发送到的服务器 IP 地址。
    • fromCache 布尔值
    • responseHeaders Record<string, string[]> (可选)

当服务器发起的重定向即将发生时，将使用 listener(details) 调用 listener。

webRequest.onCompleted([filter, ]listener)

• filter WebRequestFilter (可选)
• listener 函数 | null
  • details Object
    • id Integer
    • url string
    • method 字符串
    • webContentsId 整数 (可选)
    • webContents WebContents (可选)
    • frame WebFrameMain | null (可选) - 请求的框架。如果框架已导航或销毁，则可能为 null。
    • resourceType 字符串 - 可以是 mainFrame、subFrame、stylesheet、script、image、font、object、xhr、ping、cspReport、media、webSocket 或 other。
    • referrer 字符串
    • timestamp 双精度浮点数
    • responseHeaders Record<string, string[]> (可选)
    • fromCache 布尔值
    • statusCode 整数
    • statusLine 字符串
    • error 字符串

当请求完成时，将使用 listener(details) 调用 listener。

webRequest.onErrorOccurred([filter, ]listener)

• filter WebRequestFilter (可选)
• listener 函数 | null
  • details Object
    • id Integer
    • url string
    • method 字符串
    • webContentsId 整数 (可选)
    • webContents WebContents (可选)
    • frame WebFrameMain | null (可选) - 请求的框架。如果框架已导航或销毁，则可能为 null。
    • resourceType 字符串 - 可以是 mainFrame、subFrame、stylesheet、script、image、font、object、xhr、ping、cspReport、media、webSocket 或 other。
    • referrer 字符串
    • timestamp 双精度浮点数
    • fromCache 布尔值
    • error 字符串 - 错误描述。

当发生错误时，将使用 listener(details) 调用 listener。