跳到主要内容

net

使用 Chromium 的原生网络库发起 HTTP/HTTPS 请求

进程:主进程, 工具进程

net 模块是一个用于发起 HTTP(S) 请求的客户端 API。 它类似于 Node.js 的 HTTPHTTPS 模块,但它使用 Chromium 的原生网络库而非 Node.js 实现,从而为 Web 代理提供更好的支持。 它还支持检查网络状态。

以下列出了您可能考虑使用 net 模块而非原生 Node.js 模块的部分原因(非详尽列表)

  • 自动管理系统代理配置,支持 WPAD 协议和代理 PAC 配置文件。
  • 自动隧道化 HTTPS 请求。
  • 支持使用基本、摘要、NTLM、Kerberos 或协商认证方案对代理进行认证。
  • 支持流量监控代理:用于访问控制和监控的类似 Fiddler 的代理。

API 组件 (包括类、方法、属性和事件名称) 与 Node.js 中使用的类似。

用法示例

const { app } = require('electron')
app.whenReady().then(() => {
const { net } = require('electron')
const request = net.request('https://github.com')
request.on('response', (response) => {
console.log(`STATUS: ${response.statusCode}`)
console.log(`HEADERS: ${JSON.stringify(response.headers)}`)
response.on('data', (chunk) => {
console.log(`BODY: ${chunk}`)
})
response.on('end', () => {
console.log('No more data in response.')
})
})
request.end()
})

net API 只能在应用程序触发 ready 事件后使用。 在 ready 事件之前尝试使用此模块将抛出错误。

方法

net 模块有以下方法

net.request(options)

返回 ClientRequest

使用提供的 options 创建一个 ClientRequest 实例,options 将直接转发给 ClientRequest 构造函数。 net.request 方法将根据 options 对象中指定的协议方案发起安全和不安全的 HTTP 请求。

net.fetch(input[, init])

返回 Promise<GlobalResponse> - 详见 Response

发送请求,类似于 fetch() 在渲染器中的工作方式,使用 Chrome 的网络堆栈。 这与 Node 的 fetch() 不同,后者使用 Node.js 的 HTTP 堆栈。

示例

async function example () {
const response = await net.fetch('https://my.app')
if (response.ok) {
const body = await response.json()
// ... use the result.
}
}

此方法将从默认会话发出请求。 要从另一个会话发送 fetch 请求,请使用 ses.fetch()

有关更多详细信息,请参阅 MDN fetch() 文档。

限制

  • net.fetch() 不支持 data:blob: 方案。
  • integrity 选项的值将被忽略。
  • 返回的 Response 对象的 .type.url 值不正确。

默认情况下,使用 net.fetch 发出的请求可以发送到自定义协议以及 file:,并且如果存在,将触发 webRequest 处理程序。 当在 RequestInit 中设置非标准的 bypassCustomProtocolHandlers 选项时,此请求将不会调用自定义协议处理程序。 这允许将拦截的请求转发到内置处理程序。 即使绕过自定义协议,webRequest 处理程序仍将触发。

protocol.handle('https', (req) => {
if (req.url === 'https://my-app.com') {
return new Response('<body>my app</body>')
} else {
return net.fetch(req, { bypassCustomProtocolHandlers: true })
}
})
注意

工具进程中,不支持自定义协议。

net.isOnline()

返回 boolean - 是否当前有互联网连接。

返回值为 false 是一个相当强的指示,表明用户将无法连接到远程站点。 然而,返回值为 true 并不确定;即使某个链接已建立,也不能确定与特定远程站点的特定连接尝试是否会成功。

net.resolveHost(host, [options])

  • host 字符串 - 要解析的主机名。
  • options Object (可选)
    • queryType 字符串 (可选) - 请求的 DNS 查询类型。 如果未指定,解析器将根据 IPv4/IPv6 设置选择 A 或 AAAA (或两者)。
      • A - 仅获取 A 记录
      • AAAA - 仅获取 AAAA 记录。
    • source 字符串 (可选) - 用于解析地址的来源。 默认允许解析器选择适当的来源。 仅影响大型外部源的使用 (例如,调用系统进行解析或使用 DNS)。 即使指定了来源,结果仍可能来自缓存,解析 "localhost" 或 IP 字面量等。 以下值之一
      • any (默认) - 解析器将选择适当的来源。 结果可能来自 DNS、多播 DNS、HOSTS 文件等。
      • system - 结果将仅从系统或操作系统中检索,例如通过 getaddrinfo() 系统调用
      • dns - 结果将仅来自 DNS 查询
      • mdns - 结果将仅来自多播 DNS 查询
      • localOnly - 不使用外部来源。 结果将仅来自快速本地源,无论源设置如何,这些源都可用,例如缓存、hosts 文件、IP 字面量解析等。
    • cacheUsage 字符串 (可选) - 指示可以使用哪些(如果有)DNS 缓存条目来提供响应。 以下值之一
      • allowed (默认) - 如果主机缓存未过期,结果可能来自主机缓存
      • staleAllowed - 结果可能来自主机缓存,即使已过期 (因到期或网络更改)
      • disallowed - 结果将不会来自主机缓存。
    • secureDnsPolicy 字符串 (可选) - 控制此请求的解析器的安全 DNS 行为。 以下值之一
      • allow (默认)
      • 禁用

返回 Promise<ResolvedHost> - 解析 host 的已解析 IP 地址。

此方法将从默认会话解析主机。 要从另一个会话解析主机,请使用 ses.resolveHost()

属性

net.online 只读

一个 boolean 属性。 是否当前有互联网连接。

返回值为 false 是一个相当强的指示,表明用户将无法连接到远程站点。 然而,返回值为 true 并不确定;即使某个链接已建立,也不能确定与特定远程站点的特定连接尝试是否会成功。