protocol
注册自定义协议并拦截现有协议请求。
进程:主进程
一个实现与 file://
协议具有相同效果的协议的示例
const { app, protocol, net } = require('electron')
const path = require('node:path')
const url = require('node:url')
app.whenReady().then(() => {
protocol.handle('atom', (request) => {
const filePath = request.url.slice('atom://'.length)
return net.fetch(url.pathToFileURL(path.join(__dirname, filePath)).toString())
})
})
注意: 除非另有说明,所有方法只能在 app
模块的 ready
事件发出后使用。
将 protocol
与自定义 partition
或 session
结合使用
协议注册到特定的 Electron session
对象。如果您未指定会话,则您的 protocol
将应用于 Electron 使用的默认会话。但是,如果您在 browserWindow
的 webPreferences
上定义了 partition
或 session
,那么该窗口将使用不同的会话,并且如果您只使用 electron.protocol.XXX
,则您的自定义协议将不起作用。
为了让您的自定义协议与自定义会话结合使用,您需要将其显式注册到该会话。
const { app, BrowserWindow, net, protocol, session } = require('electron')
const path = require('node:path')
const url = require('url')
app.whenReady().then(() => {
const partition = 'persist:example'
const ses = session.fromPartition(partition)
ses.protocol.handle('atom', (request) => {
const filePath = request.url.slice('atom://'.length)
return net.fetch(url.pathToFileURL(path.resolve(__dirname, filePath)).toString())
})
const mainWindow = new BrowserWindow({ webPreferences: { partition } })
})
方法
protocol
模块具有以下方法
protocol.registerSchemesAsPrivileged(customSchemes)
customSchemes
CustomScheme[]
注意: 此方法只能在 app
模块的 ready
事件发出之前使用,并且只能调用一次。
将 scheme
注册为标准、安全,绕过资源的内容安全策略,允许注册 ServiceWorker,支持 fetch API、流式视频/音频和 V8 代码缓存。使用 true
值指定特权以启用该功能。
一个注册绕过内容安全策略的特权方案的示例
const { protocol } = require('electron')
protocol.registerSchemesAsPrivileged([
{ scheme: 'foo', privileges: { bypassCSP: true } }
])
标准方案符合 RFC 3986 所谓的 通用 URI 语法。例如 http
和 https
是标准方案,而 file
不是。
将方案注册为标准方案允许在提供服务时正确解析相对和绝对资源。否则,该方案的行为将类似于 file
协议,但无法解析相对 URL。
例如,当您加载具有自定义协议的以下页面而未将其注册为标准方案时,将不会加载图像,因为非标准方案无法识别相对 URL
<body>
<img src='test.png'>
</body>
将方案注册为标准方案将允许通过 FileSystem API 访问文件。否则,渲染器将为该方案引发安全错误。
默认情况下,对于非标准方案,禁用 Web 存储 API(localStorage、sessionStorage、webSQL、indexedDB、cookies)。因此,一般来说,如果您想注册一个自定义协议来替换 http
协议,您必须将其注册为标准方案。
使用流的协议(http 和流协议)应设置 stream: true
。 <video>
和 <audio>
HTML 元素默认期望协议缓冲其响应。 stream
标志配置这些元素以正确期望流式响应。
protocol.handle(scheme, handler)
scheme
字符串 - 要处理的方案,例如https
或my-app
。这是 URL 中:
之前的位。handler
函数<GlobalResponse | Promise<GlobalResponse>>request
GlobalRequest
为 scheme
注册协议处理程序。对具有此方案的 URL 发出的请求将委托给此处理程序以确定应发送什么响应。
可以返回 Response
或 Promise<Response>
。
示例
const { app, net, protocol } = require('electron')
const path = require('node:path')
const { pathToFileURL } = require('url')
protocol.registerSchemesAsPrivileged([
{
scheme: 'app',
privileges: {
standard: true,
secure: true,
supportFetchAPI: true
}
}
])
app.whenReady().then(() => {
protocol.handle('app', (req) => {
const { host, pathname } = new URL(req.url)
if (host === 'bundle') {
if (pathname === '/') {
return new Response('<h1>hello, world</h1>', {
headers: { 'content-type': 'text/html' }
})
}
// NB, this checks for paths that escape the bundle, e.g.
// app://bundle/../../secret_file.txt
const pathToServe = path.resolve(__dirname, pathname)
const relativePath = path.relative(__dirname, pathToServe)
const isSafe = relativePath && !relativePath.startsWith('..') && !path.isAbsolute(relativePath)
if (!isSafe) {
return new Response('bad', {
status: 400,
headers: { 'content-type': 'text/html' }
})
}
return net.fetch(pathToFileURL(pathToServe).toString())
} else if (host === 'api') {
return net.fetch('https://api.my-server.com/' + pathname, {
method: req.method,
headers: req.headers,
body: req.body
})
}
})
})
有关更多详细信息,请参阅 MDN 文档中的 Request
和 Response
。
protocol.unhandle(scheme)
scheme
字符串 - 要删除处理程序的方案。
删除使用 protocol.handle
注册的协议处理程序。
protocol.isProtocolHandled(scheme)
scheme
字符串
返回 boolean
- 是否已处理 scheme
。
protocol.registerFileProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
(string | ProtocolResponse)
返回 boolean
- 协议是否成功注册
注册 scheme
的协议,该协议将发送文件作为响应。将使用 request
和 callback
调用 handler
,其中 request
是针对 scheme
的传入请求。
要处理 request
,应使用文件的路径或具有 path
属性的对象调用 callback
,例如 callback(filePath)
或 callback({ path: filePath })
。 filePath
必须是绝对路径。
默认情况下,scheme
被视为 http:
,它的解析方式与遵循 “通用 URI 语法” 的协议(如 file:
)不同。
protocol.registerBufferProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
(Buffer | ProtocolResponse)
返回 boolean
- 协议是否成功注册
注册 scheme
的协议,该协议将发送 Buffer
作为响应。
用法与 registerFileProtocol
相同,只是应使用 Buffer
对象或具有 data
属性的对象调用 callback
。
示例
protocol.registerBufferProtocol('atom', (request, callback) => {
callback({ mimeType: 'text/html', data: Buffer.from('<h5>Response</h5>') })
})
protocol.registerStringProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
(string | ProtocolResponse)
返回 boolean
- 协议是否成功注册
注册 scheme
的协议,该协议将发送 string
作为响应。
用法与 registerFileProtocol
相同,只是应使用 string
或具有 data
属性的对象调用 callback
。
protocol.registerHttpProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
ProtocolResponse
返回 boolean
- 协议是否成功注册
注册一个 scheme
协议,该协议将发送一个 HTTP 请求作为响应。
用法与 registerFileProtocol
相同,不同之处在于 callback
应该使用具有 url
属性的对象调用。
protocol.registerStreamProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
(ReadableStream | ProtocolResponse)
返回 boolean
- 协议是否成功注册
注册一个 scheme
协议,该协议将发送一个流作为响应。
用法与 registerFileProtocol
相同,不同之处在于 callback
应该使用 ReadableStream
对象或具有 data
属性的对象调用。
示例
const { protocol } = require('electron')
const { PassThrough } = require('stream')
function createStream (text) {
const rv = new PassThrough() // PassThrough is also a Readable stream
rv.push(text)
rv.push(null)
return rv
}
protocol.registerStreamProtocol('atom', (request, callback) => {
callback({
statusCode: 200,
headers: {
'content-type': 'text/html'
},
data: createStream('<h5>Response</h5>')
})
})
可以传递任何实现了可读流 API(发出 data
/end
/error
事件)的对象。例如,以下是如何返回文件的方式
protocol.registerStreamProtocol('atom', (request, callback) => {
callback(fs.createReadStream('index.html'))
})
protocol.unregisterProtocol(scheme)
已弃用
scheme
字符串
返回 boolean
- 表示是否成功取消注册该协议
取消注册 scheme
的自定义协议。
protocol.isProtocolRegistered(scheme)
已弃用
scheme
字符串
返回 boolean
- 表示 scheme
是否已注册。
protocol.interceptFileProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
(string | ProtocolResponse)
返回 boolean
- 表示是否成功拦截该协议
拦截 scheme
协议,并使用 handler
作为该协议的新处理程序,该处理程序发送一个文件作为响应。
protocol.interceptStringProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
(string | ProtocolResponse)
返回 boolean
- 表示是否成功拦截该协议
拦截 scheme
协议,并使用 handler
作为该协议的新处理程序,该处理程序发送一个 string
作为响应。
protocol.interceptBufferProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
(Buffer | ProtocolResponse)
返回 boolean
- 表示是否成功拦截该协议
拦截 scheme
协议,并使用 handler
作为该协议的新处理程序,该处理程序发送一个 Buffer
作为响应。
protocol.interceptHttpProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
ProtocolResponse
返回 boolean
- 表示是否成功拦截该协议
拦截 scheme
协议,并使用 handler
作为该协议的新处理程序,该处理程序发送一个新的 HTTP 请求作为响应。
protocol.interceptStreamProtocol(scheme, handler)
已弃用
scheme
字符串handler
函数request
ProtocolRequestcallback
函数response
(ReadableStream | ProtocolResponse)
返回 boolean
- 表示是否成功拦截该协议
与 protocol.registerStreamProtocol
相同,不同之处在于它会替换现有的协议处理程序。
protocol.uninterceptProtocol(scheme)
已弃用
scheme
字符串
返回 boolean
- 表示是否成功取消拦截该协议
删除为 scheme
安装的拦截器,并恢复其原始处理程序。
protocol.isProtocolIntercepted(scheme)
已弃用
scheme
字符串
返回 boolean
- 表示 scheme
是否已被拦截。