Electron 页面渲染是在 Chromium 浏览器内核中进行的,按理来说应该与常规浏览器一样存在跨域请求的问题,可实际上真的是这样吗。下面一起来看看。
本地文件不受跨域限制
在 Electron 中,应用使用的是本地文件协议(file://),而不是 HTTP 协议。因此,常规浏览器中适用的跨域资源共享(CORS)策略并不完全适用于 Electron。我们可以创建一个简单的 HTML 文件进行对比:
<!DOCTYPE html>
<html lang="en">
<head></head>
<body>
<script>
fetch('https://vekun.com')
.then((resp) => resp.text())
.then((res) => {
console.log('请求结果', res)
})
</script>
</body>
</html>
当使用常规浏览器打开时,毫无疑问会提示跨域请求失败。
然而,当使用 Electron 加载该页面时,在主线程代码中使用loadFile
方法加载本地文件:
app.whenReady().then(() => {
win = new BrowserWindow()
win.loadFile(path.resolve(__dirname, 'index.html'))
})
可以看到请求成功并获得结果。
网络资源受跨域限制
上面是通过loadFile
加载本地文件,接下来我们尝试启动一个服务,然后通过loadURL
加载页面。我们启动一个在 8080 端口的服务器,并在主线程中将渲染代码修改为:
win.loadURL('http://localhost:8080')
相信很多人都能猜到结果,这次同样会出现跨域访问失败的情况。
那么,在这种情况下,我们应该如何解决跨域问题呢?下面提供三种处理方式。
使用webPreferences
禁用 Web 安全策略
使用 Electron 的webPreferences
配置项设置webSecurity
为false
,即禁用 Web 安全策略。这样可以允许跨域请求,但会对系统安全性产生风险。
const win = new BrowserWindow({
webPreferences: {
webSecurity: false,
},
})
win.loadURL('http://localhost:8080')
使用session
模块拦截和修改请求:
使用 Electron 的session
模块,创建一个新的session
来进行跨域请求。通过session
对象的webRequest
事件来拦截和修改请求,并设置返回请求的 CORS(跨域资源共享)头。
const filter = {
urls: ['https://vekun.com/']
}
session.defaultSession.webRequest.onHeadersReceived(filter, (details, callback) => {
details.responseHeaders!['Access-Control-Allow-Origin'] = ['*']
callback({
cancel: false,
responseHeaders: details.responseHeaders
})
})
win.loadURL('http://localhost:8080')
在主进程中使用net
模块发送 HTTP 请求
在主进程中使用 Electron 的net
模块发送 HTTP 请求,该模块不受跨域限制。可以在主进程中通过 IPC 与渲染进程通信,将结果传递给渲染进程。
ipcMain.handle('fetch', (_event, ...args) => {
return net.fetch(...args).then((resp) => resp.text())
})
然后在预加载脚本给 Window 对象添加方法。
contextBridge.exposeInMainWorld('api', {
fetch: (url: string, data: any = {}) => ipcRenderer.invoke('fetch', url, data),
})
然后在页面中就可以通过window.api.fetch
方法进行请求,案例中对请求结果处理逻辑比较简单,你可以按需要添加自己的逻辑。
上面三种处理跨域的问题都比较简单,也不用交给后端开发去处理。当然,还有一种方法可以通过创建代理服务器的方式,不过对于本地文件不受跨域限制情况下使用代理服务器意义不大。