跳到主要内容

设备访问

与基于 Chromium 的浏览器类似，Electron 通过 Web API 提供对设备硬件的访问。 在大多数情况下，这些 API 的工作方式与在浏览器中相同，但有一些差异需要考虑。 Electron 和浏览器之间的主要区别在于请求设备访问时会发生什么。 在浏览器中，用户会看到一个弹窗，他们可以在其中授予对单个设备的访问权限。 在 Electron 中，API 由开发者提供，开发者可以使用这些 API 自动选择设备，或提示用户通过开发者创建的界面选择设备。

Web Bluetooth API​

Web Bluetooth API 可用于与蓝牙设备通信。 为了在 Electron 中使用此 API，开发者需要处理与设备请求关联的 webContents 上的 select-bluetooth-device 事件。

此外，ses.setBluetoothPairingHandler(handler) 可用于处理 Windows 或 Linux 上蓝牙设备的配对，当需要额外的验证（如 PIN 码）时。

示例​

此示例演示了一个 Electron 应用程序，当单击 Test Bluetooth 按钮时，该应用程序会自动选择第一个可用的蓝牙设备。

docs/fiddles/features/web-bluetooth (35.0.1)在 Fiddle 中打开
const { app, BrowserWindow, ipcMain } = require('electron/main')
const path = require('node:path')

let bluetoothPinCallback
let selectBluetoothCallback

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js')
    }
  })

  mainWindow.webContents.on('select-bluetooth-device', (event, deviceList, callback) => {
    event.preventDefault()
    selectBluetoothCallback = callback
    const result = deviceList.find((device) => {
      return device.deviceName === 'test'
    })
    if (result) {
      callback(result.deviceId)
    } else {
      // The device wasn't found so we need to either wait longer (eg until the
      // device is turned on) or until the user cancels the request
    }
  })

  ipcMain.on('cancel-bluetooth-request', (event) => {
    selectBluetoothCallback('')
  })

  // Listen for a message from the renderer to get the response for the Bluetooth pairing.
  ipcMain.on('bluetooth-pairing-response', (event, response) => {
    bluetoothPinCallback(response)
  })

  mainWindow.webContents.session.setBluetoothPairingHandler((details, callback) => {
    bluetoothPinCallback = callback
    // Send a message to the renderer to prompt the user to confirm the pairing.
    mainWindow.webContents.send('bluetooth-pairing-request', details)
  })

  mainWindow.loadFile('index.html')
}

app.whenReady().then(() => {
  createWindow()

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit()
})

WebHID API​

WebHID API 可用于访问 HID 设备，例如键盘和游戏手柄。 Electron 提供了多个用于使用 WebHID API 的 API

  • Session 上的 select-hid-device 事件 可用于在调用 navigator.hid.requestDevice 时选择 HID 设备。 此外，Session 上的 hid-device-added 和 hid-device-removed 事件可用于处理在处理 select-hid-device 事件时插入或拔出设备。 注意： 这些事件仅在调用 select-hid-device 的回调之前触发。 它们不旨在用作通用的 hid 设备监听器。
  • ses.setDevicePermissionHandler(handler) 可用于为设备提供默认权限，而无需首先通过 navigator.hid.requestDevice 调用设备权限。 此外，Electron 的默认行为是在相应 WebContents 的生命周期内存储授予的设备权限。 如果需要长期存储，开发者可以存储授予的设备权限（例如，在处理 select-hid-device 事件时），然后使用 setDevicePermissionHandler 从该存储中读取。
  • ses.setPermissionCheckHandler(handler) 可用于禁用特定来源的 HID 访问。

阻止列表​

默认情况下，Electron 采用与 Chromium 使用的相同的 阻止列表。 如果您希望覆盖此行为，可以通过设置 disable-hid-blocklist 标志来完成。

app.commandLine.appendSwitch('disable-hid-blocklist')

示例​

此示例演示了一个 Electron 应用程序，该应用程序通过 ses.setDevicePermissionHandler(handler) 和 Session 上的 select-hid-device 事件 自动选择 HID 设备，当单击 Test WebHID 按钮时。

docs/fiddles/features/web-hid (35.0.1)在 Fiddle 中打开
const { app, BrowserWindow } = require('electron/main')

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600
  })

  mainWindow.webContents.session.on('select-hid-device', (event, details, callback) => {
    // Add events to handle devices being added or removed before the callback on
    // `select-hid-device` is called.
    mainWindow.webContents.session.on('hid-device-added', (event, device) => {
      console.log('hid-device-added FIRED WITH', device)
      // Optionally update details.deviceList
    })

    mainWindow.webContents.session.on('hid-device-removed', (event, device) => {
      console.log('hid-device-removed FIRED WITH', device)
      // Optionally update details.deviceList
    })

    event.preventDefault()
    if (details.deviceList && details.deviceList.length > 0) {
      callback(details.deviceList[0].deviceId)
    }
  })

  mainWindow.webContents.session.setPermissionCheckHandler((webContents, permission, requestingOrigin, details) => {
    if (permission === 'hid' && details.securityOrigin === 'file:///') {
      return true
    }
  })

  mainWindow.webContents.session.setDevicePermissionHandler((details) => {
    if (details.deviceType === 'hid' && details.origin === 'file://') {
      return true
    }
  })

  mainWindow.loadFile('index.html')
}

app.whenReady().then(() => {
  createWindow()

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit()
})

Web Serial API​

Web Serial API 可用于访问通过串口、USB 或蓝牙连接的串行设备。 为了在 Electron 中使用此 API，开发者需要处理与串行端口请求关联的 Session 上的 select-serial-port 事件。

还有几个用于使用 Web Serial API 的其他 API

  • Session 上的 serial-port-added 和 serial-port-removed 事件可用于处理在处理 select-serial-port 事件时插入或拔出设备。 注意： 这些事件仅在调用 select-serial-port 的回调之前触发。 它们不旨在用作通用的串行端口监听器。
  • ses.setDevicePermissionHandler(handler) 可用于为设备提供默认权限，而无需首先通过 navigator.serial.requestPort 调用设备权限。 此外，Electron 的默认行为是在相应 WebContents 的生命周期内存储授予的设备权限。 如果需要长期存储，开发者可以存储授予的设备权限（例如，在处理 select-serial-port 事件时），然后使用 setDevicePermissionHandler 从该存储中读取。
  • ses.setPermissionCheckHandler(handler) 可用于禁用特定来源的串行访问。

示例​

此示例演示了一个 Electron 应用程序，该应用程序通过 ses.setDevicePermissionHandler(handler) 自动选择串行设备，并演示了在单击 Test Web Serial 按钮时，通过 Session 上的 select-serial-port 事件 选择第一个可用的 Arduino Uno 串行设备（如果已连接）。

docs/fiddles/features/web-serial (35.0.1)在 Fiddle 中打开
const { app, BrowserWindow } = require('electron/main')

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600
  })

  mainWindow.webContents.session.on('select-serial-port', (event, portList, webContents, callback) => {
    // Add listeners to handle ports being added or removed before the callback for `select-serial-port`
    // is called.
    mainWindow.webContents.session.on('serial-port-added', (event, port) => {
      console.log('serial-port-added FIRED WITH', port)
      // Optionally update portList to add the new port
    })

    mainWindow.webContents.session.on('serial-port-removed', (event, port) => {
      console.log('serial-port-removed FIRED WITH', port)
      // Optionally update portList to remove the port
    })

    event.preventDefault()
    if (portList && portList.length > 0) {
      callback(portList[0].portId)
    } else {
      // eslint-disable-next-line n/no-callback-literal
      callback('') // Could not find any matching devices
    }
  })

  mainWindow.webContents.session.setPermissionCheckHandler((webContents, permission, requestingOrigin, details) => {
    if (permission === 'serial' && details.securityOrigin === 'file:///') {
      return true
    }

    return false
  })

  mainWindow.webContents.session.setDevicePermissionHandler((details) => {
    if (details.deviceType === 'serial' && details.origin === 'file://') {
      return true
    }

    return false
  })

  mainWindow.loadFile('index.html')

  mainWindow.webContents.openDevTools()
}

app.whenReady().then(() => {
  createWindow()

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit()
})

WebUSB API​

WebUSB API 可用于访问 USB 设备。 Electron 提供了多个用于使用 WebUSB API 的 API

示例​

此示例演示了一个 Electron 应用程序，该应用程序通过 ses.setDevicePermissionHandler(handler) 和 Session 上的 select-usb-device 事件 自动选择 USB 设备（如果已连接），当单击 Test WebUSB 按钮时。

docs/fiddles/features/web-usb (35.0.1)在 Fiddle 中打开
const { app, BrowserWindow } = require('electron/main')

function createWindow () {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600
  })

  let grantedDeviceThroughPermHandler

  mainWindow.webContents.session.on('select-usb-device', (event, details, callback) => {
    // Add events to handle devices being added or removed before the callback on
    // `select-usb-device` is called.
    mainWindow.webContents.session.on('usb-device-added', (event, device) => {
      console.log('usb-device-added FIRED WITH', device)
      // Optionally update details.deviceList
    })

    mainWindow.webContents.session.on('usb-device-removed', (event, device) => {
      console.log('usb-device-removed FIRED WITH', device)
      // Optionally update details.deviceList
    })

    event.preventDefault()
    if (details.deviceList && details.deviceList.length > 0) {
      const deviceToReturn = details.deviceList.find((device) => {
        return !grantedDeviceThroughPermHandler || (device.deviceId !== grantedDeviceThroughPermHandler.deviceId)
      })
      if (deviceToReturn) {
        callback(deviceToReturn.deviceId)
      } else {
        callback()
      }
    }
  })

  mainWindow.webContents.session.setPermissionCheckHandler((webContents, permission, requestingOrigin, details) => {
    if (permission === 'usb' && details.securityOrigin === 'file:///') {
      return true
    }
  })

  mainWindow.webContents.session.setDevicePermissionHandler((details) => {
    if (details.deviceType === 'usb' && details.origin === 'file://') {
      if (!grantedDeviceThroughPermHandler) {
        grantedDeviceThroughPermHandler = details.device
        return true
      } else {
        return false
      }
    }
  })

  mainWindow.webContents.session.setUSBProtectedClassesHandler((details) => {
    return details.protectedClasses.filter((usbClass) => {
      // Exclude classes except for audio classes
      return usbClass.indexOf('audio') === -1
    })
  })

  mainWindow.loadFile('index.html')
}

app.whenReady().then(() => {
  createWindow()

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow()
  })
})

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit()
})