介紹
Energy應用下載文件時觸發(fā)的下載事件和使用
我們在頁面上下載文件時隅忿,可以對文件下載時的處理心剥,例如:保存路徑,下載取消背桐,開始优烧、暫停。
下面將用代碼和注釋链峭,和簡要的說明來演示
Go代碼示例
想要運行此示例畦娄,需要安裝好Go和Energy開發(fā)環(huán)境
- 主窗口初始化回調(diào)函數(shù)里設置事件
cef.BrowserWindow.SetBrowserInit(func(event *cef.BrowserEvent, browserWindow cef.IBrowserWindow){})
下載事件注冊
下載之前事件
- 在頁面中下載時觸發(fā)該函數(shù)OnBeforeDownload,例如點擊某下載鏈接
- OnBeforeDownload事件弊仪,可以設置保存路徑熙卡,顯示保存提示框和不顯示保存提示框
- Linux下由于上游原因,需要自定義保存提示框励饵,否則無法顯示驳癌。
- Windows和MacOSX保存提示框都正常
- 值得注意的是 cef.QueueSyncCall 函數(shù),其作用是將UI相關的操作移至到UI線程中執(zhí)行役听,該函數(shù)是異步的颓鲜。詳情參考源碼注釋
- 這里針對linux系統(tǒng)自定義了保存提示框
lcl.NewSaveDialog
event.SetOnBeforeDownload(func(sender lcl.IObject, browser *cef.ICefBrowser, beforeDownloadItem *cef.DownloadItem, suggestedName string, callback *cef.ICefBeforeDownloadCallback)
下載更新事件
- 下載更新事件OnDownloadUpdated,該函數(shù)實時更新下載項的進度
- 在該函數(shù)中可以對每個下載項操作典予,下載取消甜滨,開始、暫停, 恢復下載熙参。
- 下載項操作需要在函數(shù)執(zhí)行周期內(nèi)操作艳吠,不可在函數(shù)執(zhí)行周期之外。
- 示例中下載進度使用了事件機制孽椰,把下載信息發(fā)送給web端展示: [Go調(diào)用JS事件]
event.SetOnDownloadUpdated(func(sender lcl.IObject, browser *cef.ICefBrowser, downloadItem *cef.DownloadItem, callback *cef.ICefDownloadItemCallback)
package main
import (
"embed"
"fmt"
"github.com/energye/energy/v2/cef"
"github.com/energye/energy/v2/cef/ipc"
"github.com/energye/energy/v2/common"
"github.com/energye/energy/v2/pkgs/assetserve"
"github.com/energye/golcl/lcl"
)
//資源目錄昭娩,內(nèi)置到執(zhí)行程序中
//go:embed resources
var resources embed.FS
//這個示例使用了幾個事件來演示下載文件
//在cef.BrowserWindow.SetBrowserInit初始化函數(shù)中設置event.SetOnBeforeDownload,用于設置保存目錄
//并且設置event.SetOnDownloadUpdated獲取下載進度信息
func main() {
//全局初始化 每個應用都必須調(diào)用的
cef.GlobalInit(nil, &resources)
//創(chuàng)建應用
cefApp := cef.NewApplication()
//主窗口的配置
//指定一個URL地址黍匾,或本地html文件目錄
cef.BrowserWindow.Config.Url = "http://localhost:22022/download.html"
if common.IsLinux() && cefApp.IsUIGtk3() {
cef.BrowserWindow.Config.IconFS = "resources/icon.png"
} else {
cef.BrowserWindow.Config.IconFS = "resources/icon.ico"
}
//在主窗口初始化回調(diào)函數(shù)里設置瀏覽器事件
cef.BrowserWindow.SetBrowserInit(func(event *cef.BrowserEvent, browserWindow cef.IBrowserWindow) {
//下載更新事件
//1. 返回下載進度
//2. downloadItem 下載項
//3. callback 下載狀態(tài)的控制, 下載暫停栏渺,開始、取消
//4. 將下載進度通過事件機制發(fā)送到html中展示
event.SetOnDownloadUpdated(func(sender lcl.IObject, browser *cef.ICefBrowser, downloadItem *cef.ICefDownloadItem, callback *cef.ICefDownloadItemCallback) {
//傳遞數(shù)據(jù)參數(shù)到html中
//這些參數(shù)按下標順序?qū)絡s函數(shù)參數(shù)位置
//演示只傳遞了幾個參數(shù)
fmt.Println("DownloadUpdated frameId", browser.MainFrame().Identifier(), "BeforeDownload Id:", downloadItem.Id(), "originalUrl:", downloadItem.OriginalUrl(), "url:", downloadItem.Url())
fmt.Println("\t", downloadItem.State(), downloadItem.TotalBytes(), "/", downloadItem.ReceivedBytes(), "speed:", downloadItem.CurrentSpeed(), "fullPath", downloadItem.FullPath())
ipc.Emit("downloadUpdateDemo", downloadItem.Id(), downloadItem.FullPath(), downloadItem.ReceivedBytes(), downloadItem.TotalBytes())
})
})
//在主進程啟動成功之后執(zhí)行
//在這里啟動內(nèi)置http服務
//內(nèi)置http服務需要使用 go:embed resources 內(nèi)置資源到執(zhí)行程序中
cef.SetBrowserProcessStartAfterCallback(func(b bool) {
fmt.Println("主進程啟動 創(chuàng)建一個內(nèi)置http服務")
//通過內(nèi)置http服務加載資源
server := assetserve.NewAssetsHttpServer()
server.PORT = 22022 //服務端口號
server.AssetsFSName = "resources" //必須設置目錄名和資源文件夾同名
server.Assets = &resources
go server.StartHttpServer()
})
//運行應用
cef.Run(cefApp)
}
html代碼示例
html中寫了幾個下載鏈接
html中定義了事件監(jiān)聽锐涯,ipc.on磕诊,事件名downloadUpdateDemo
downloadUpdateDemo事件接收Go觸發(fā)的事件,Go發(fā)送的消息由此事件函數(shù)接收
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>下載文件示例</title>
<script>
console.log("下載文件示例")
//使用ipc.on監(jiān)聽事件
ipc.on("downloadUpdateDemo", function (id, suggestedFileName, receivedBytes, totalBytes) {
console.log(id, suggestedFileName, receivedBytes, totalBytes)
var downloadMessage = document.getElementById("downloadMessage")
downloadMessage.innerHTML = downloadMessage.innerHTML + ("id: " + id + " suggestedFileName: " + suggestedFileName + " receivedBytes: " + receivedBytes + " / totalBytes: " + totalBytes) + "<br>"
});
</script>
</head>
<body style="overflow: hidden;margin: 10px;padding: 10px;">
<h3>download demo:</h3><br>
<a >Windows 32 bits</a>
<br>
<a >Windows 64 bits</a>
<br>
<a >Linux x86 64
bits</a> <br>
<a >MacOSX x86 64
bits</a> <br>
<div id="downloadMessage">
</div>
</body>
</html>
運行效果圖 - download
image