协议的注册和处理

优质

小牛编辑

134浏览

2023-12-01

注册自定义协议并拦截现有协议请求

进程: 主进程
实现类似 file:// 协议的小例子 :
1
const {app, protocol} = require('electron')
2
const path = require('path')
3
app.on('ready', () => {
4
protocol.registerFileProtocol('atom', (request, callback) => {
5
const url = request.url.substr(7)
6
callback({path: path.normalize(`${__dirname}/${url}`)})
7
}, (error) => {
8
if (error) console.error('无法注册协议')
9
})
10
})
Copied!

注意: 这个模块方法应用于 app 模块的 ready 事件之后

方法

`protocol.registerStandardSchemes(schemes[, options])`

用途:注册名为 schemes的标准协议

schemes String[] - 要注册为标准协议的自定义协议名.
options Object (可选)
- secure Boolean (可选) - 是否使用安全协议,默认为 false.

标准协议必须遵循RFC 3986调用通用URI语法。例如http和https是标准协议,而file不是。
注册标准协议后,在服务时可正确相关资源。否则行为类似file,但无法解析URL。例如,下文无法加载图像test.png,,因为非标准协议无法识别相对URL:
1
<body>
2
<img src='test.png'>
3
</body>
Copied!

注册为标准协议后,允许通过[系统文件API][file-system-api]访问文件。否则渲染器会抛出安全错误。
默认情况下,非标准协议禁用所有Web存储 API(localStorage,sessionStorage,webSQL,indexedDB,cookies)。
所以一般来说,如果你想注册一个自定义协议来代替http协议,你必须将它注册成标准协议:
1
const {app, protocol} = require('electron')
2
protocol.registerStandardSchemes(['atom'])
3
app.on('ready', () => {
4
protocol.registerHttpProtocol('atom', '...')
5
})
Copied!

注意: 以上方法必须在 app 模块的 ready 事件之前使用

`protocol.registerServiceWorkerSchemes(schemes)`

用途:注册名为 schemes的service workers自定义协议

schemes String[] - 要注册为service workers自定义协议的自定义协议名.

service worker是运行于浏览器后台的一种脚本,它可以无需Web页面或者用户交互就能提供额外的功能.通常用在离线开发上.
举个例子:比如断网了,你仍然可以使用本地缓存数据.

`protocol.registerFileProtocol(scheme, handler[, completion])`

用途:注册名为 schemes的将发送文件作为响应的自定义协议

scheme String
handler Function
- request Object
  - url String
  - referrer String
  - method String
  - uploadData UploadData[]
- callback Function
  - filePath String (可选)
completion Function (可选)
- error Error

当使用 scheme创建一个 request时, handler将被 handler(request,callback)调用。
当 scheme 被成功注册或者完成(错误)时失败, completion(error)会使用 completion(null)来调用 completion。
要处理 request, callback应该用文件的路径或一个具有 path属性的对象来调用,例如: callback(filePath) 或 callback({path:filePath})。
如果 callback为空或一个数字或存在error属性的对象, request 都将失败并显示为你指定的错误号,详见错误号列表
默认情况下, scheme类似于 http:,它的解析方式不同于如 file:之类的 通用URI语法( generic URI syntax )协议.所以你或许应该调用 protocol.registerStandardSchemes 来创建一个标准协议。

`protocol.registerBufferProtocol(scheme, handler[, completion])`

用途:注册名为 schemes的将发送 Buffer作为响应的自定义协议

scheme String
handler Function
- request Object
  - url String
  - referrer String
  - method String
  - uploadData UploadData[]
- callback Function
  - buffer (Buffer | MimeTypedBuffer) (可选)
completion Function (可选)
- error Error

用法类似 registerFileProtocol,除了 callback应该用具有 data， mimeType和 charset属性的 Buffer对象来调用.
1
const {protocol} = require('electron')
2
protocol.registerBufferProtocol('atom', (request, callback) => {
3
callback({mimeType: 'text/html', data: new Buffer('<h5>回调响应</h5>')})
4
}, (error) => {
5
if (error) console.error('无法注册协议')
6
})
Copied!

`protocol.registerStringProtocol(scheme, handler[, completion])`

用途:注册名为 schemes的将发送 String作为响应的自定义协议

scheme String
handler Function
- request Object
  - url String
  - referrer String
  - method String
  - uploadData UploadData[]
- callback Function
  - data String (可选)
completion Function (可选)
- error Error

用法类似 registerFileProtocol,除了 callback应该用 String 或一个 data， mimeType和 charset属性的对象来调用.

`protocol.registerHttpProtocol(scheme, handler[, completion])`

用途:注册名为 schemes的将发送 HTTP请求作为响应的自定义协议

scheme String
handler Function
- request Object
  - url String
  - referrer String
  - method String
  - uploadData UploadData[]
- callback Function
  - redirectRequest Object
    - url String
    - method String
    - session Object (可选)
    - uploadData Object (可选)
      - contentType String - 内容的MIME类型
      - data String -要发送的内容
completion Function (可选)
- error Error

注册一个 scheme 协议,用来发送 HTTP 请求作为响应.
用法类似 registerFileProtocol,除了 callback应该用具有 url, method, referrer, uploadData 和 session 属性的 redirectRequest对象来调用.
HTTP 请求默认使用当前 session .如果你想使用不同的session值,你应该设置 session 为 null.
对于POST 请求,必须提供 uploadData 对象.

`protocol.unregisterProtocol(scheme[, completion])`

用途:注销名为 scheme的自定义协议

scheme String
completion Function (可选)
- error Error

`protocol.isProtocolHandled(scheme, callback)`

用途:判断是否已有一个处理 scheme协议的程序( Boolean)

scheme String
callback Function
- error Error

`protocol.interceptFileProtocol(scheme, handler[, completion])`

用途:拦截 scheme协议并使用 handler(发送一个 文件作为响应)作为协议的新处理程序

scheme String
handler Function
- request Object
  - url String
  - referrer String
  - method String
  - uploadData UploadData[]
- callback Function
  - filePath String
completion Function (可选)
- error Error

`protocol.interceptStringProtocol(scheme, handler[, completion])`

用途:拦截 scheme协议并使用 handler(发送一个 String作为响应)作为协议的新处理程序

scheme String
handler Function
- request Object
  - url String
  - referrer String
  - method String
  - uploadData UploadData[]
- callback Function
  - data String (可选)
completion Function (可选)
- error Error

`protocol.interceptBufferProtocol(scheme, handler[, completion])`

用途:拦截 scheme协议并使用 handler(发送一个 Buffer作为响应)作为协议的新处理程序

scheme String
handler Function
- request Object
  - url String
  - referrer String
  - method String
  - uploadData UploadData[]
- callback Function
  - buffer Buffer (可选)
completion Function (可选)
- error Error

`protocol.interceptHttpProtocol(scheme, handler[, completion])`

用途:拦截 scheme协议并使用 handler(发送一个 HTTP请求作为响应)作为协议的新处理程序
scheme String
handler Function
request Object
url String
referrer String
method String
uploadData UploadData[]
callback Function
redirectRequest Object
url String
method String
session Object (可选)
uploadData Object (可选)
contentType String - 内容的MIME类型
data String -要发送的内容
completion Function (可选)
error Error

`protocol.uninterceptProtocol(scheme[, completion])`

用途:删除为scheme协议安装的拦截器并恢复其原始处理程序

scheme String
completion Function (可选)
- error Error

[file-system-api]: https://developer.mozilla.org/en-US/docs/Web/API/LocalFileSystem