[ASP.NET Core SignalR + Vue3] 即時回報進度百分比教學

[ASP.NET Core SignalR + Vue3] 即時回報進度百分比教學 #CH2

SignalR 是 ASP.NET 實現網頁雙向溝通的一種方式,傳統的網頁是單向溝通,只能由客戶端主動發送訊息至伺服器端,而雙向溝通就可以由伺服器端主動發送訊息至客戶端,可以解決網頁即時同步的問題。

SignalR 應用的場景非常多,舉凡需要即時同步的需求都適合,例如遊戲、股價、聊天室、投票、拍賣、監控等等,如果學會此技能,將可在網頁上做出更豐富的變化。

此範例模擬場景是某一按鈕執行時間過長,使用者不知道何時結束,容易因為等待太久,懷疑是否當機,而直接關閉網頁離開。
如果可以即時告知使用者目前執行進度百分比的話,因為可預期何時結束,也知道系統正在執行沒有當機,讓使用者願意等待直到執行完畢。

範例環境是ASP.NET Core SignalR 搭配 Vue3 的使用方式,適合有使用 Vue3 前端的朋友使用。

建立專案

開啟 Visual Studio 在新增專案範本時選擇「ASP.NET Core Web 應用程式 (Model-View-Controller)」。

建立專案

輸入專案名稱、路徑。
架構選擇「.NET 6.0」版本,按下「建立」就會建立此專案。

架構選擇「.NET 6.0」版本,按下「建立」就會建立此專案

新增 SignalR 用戶端程式庫

SignalR 前端需要 JavaScript 的類別庫才能運作,而後端的 SignalR 已包含在 ASP.NET Core 共用架構中。
這裡要先下載最新版的 signalr.js 到我們的專案內。

在「方案總管」中,以滑鼠右鍵按一下專案,然後選取「加入 > 用戶端程式庫」。

新增 SignalR 用戶端程式庫

針對提供者選取「unpkg」
針對「程式庫」輸入「@microsoft/signalr@latest」
選取「選擇特定檔案」,展開「dist/browser」資料夾,然後選取「signalr.js」和「signalr.min.js」。
將「目標位置」設定為「wwwroot/js/signalr/」

新增 SignalR 用戶端程式庫

安裝之後,在你的專案目錄下就會找到這些檔案。

新增 SignalR 用戶端程式庫

加入 Vue3 類別庫

我們直接在 Layout 頁面引用 Vue3,開啟 \Views\Shared\_Layout.cshtml,在下方的 Script 引用增加語法:

<script src="https://unpkg.com/vue@next"></script>

加入 Vue3 類別庫

建立 SignalR Hub 類別

SignalR 的 Hub 類別可以處理網頁上用戶端與伺服器端之間的溝通橋樑。

在專案的目錄中新增目錄,名稱為「Hubs」。
然後在「Hubs」目錄下新增新類別,名稱為「ProgressHub」。

新增新類別,名稱為「ProgressHub」

然後在 ProgressHub 類別貼上以下程式碼:

方法 OnConnectedAsync() 是每一個用戶連線後,都會觸發的事件,每次連線會得到 Context.ConnectionId,我們就把 Context.ConnectionId 回傳到前端。

設定 SignalR

開啟 Program.cs 檔案,這裡要啟用 SignalR 服務,然後註冊 Hub 路由。
在 Program.cs 的 var app = builder.Build(); 語法之前,加入此語法:

//加入 SignalR
builder.Services.AddSignalR();

app.Run(); 語法之前,加入此語法:

//加入 Hub
app.MapHub<ProgressHub>("/progressHub");

設定 SignalR

SignalR 用戶端程式碼

接著就要編寫前端的程式碼,我們範例就直接寫在首頁上教學。
開啟 \Views\Home\Index.cshtml 檔案,可以清除原有全部程式碼,然後貼上以下語法:

這裡簡單製作一個按鈕,執行後會呼叫後端的 Action,同時傳送由 Hub 得到的 ConnectionId 到後端,讓後端知道該更新前端那一位使用者。

Controller 程式碼

接著開啟 \Controllers\HomeController.cs,在 Controller 要使用 SingalR 要先在建構子載入 Hub。
修改 HomeController 增加剛剛新增的 ProgressHub 類別:

修改 HomeController 增加剛剛新增的 ProgressHub 類別

圖片紅框處是會額外增加的程式碼。
我們從 HomeController 取得的 IHubContext<ProgressHub> 物件是為了與使用者 SingalR 前端做互動,取得這物件後,就可以在 Action 執行過程發送 WebSocket 訊息至前端了。

接著在 HomeController 下面增加一個 Action,語法:

這裡模擬 10 秒的動作,每 10% 就通知前端目前進度,實際專案可以自行計算百分比,然後每 1% 就更新一次,讓用戶覺得系統還在跑。

測試專案

做到這裡就可以按 F5 測試一下專案,開始執行後,就會顯示目前進度。

SignalR + Vue3 即時回報進度百分比教學

完成後,進度條就會跑到 100%。

SignalR + Vue3 即時回報進度百分比教學

你也可以試試看,學會 SignalR 就可以讓網頁互動性更豐富,這是一個簡單基本的 SignalR 教學,分享給你。

範例下載

付費後可下載此篇文章教學程式碼

推薦課程

相關學習文章

如果你在學習上有不懂的地方,可以參考專業諮詢或線上家教服務,我想辨法解決你的問題
如果文章內容有錯誤的地方,幫我在下方留言通知我一下,謝謝
喜歡我的文章,請幫我在上方綠色拍手圖示按 5 下,也歡迎按月贊助,鼓勵我繼續創作,謝謝

加入社團一起討論

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。

one × 5 =