DIV CSS 佈局教程網

讓 JavaScript 呼叫 C#:WebBrowser 與 window.external 的橋樑
編輯:關於JavaScript     

在桌面客戶端中嵌入網頁,已經是很常見的做法——新聞彈出視窗、活動頁面、內嵌說明文件都屬這類。而這類架構的核心問題是:網頁裡的 JavaScript 如何呼叫宿主程式的功能?

原理:window.external

.NET 的 WebBrowser 控制項使用的仍是 IE 內核。在 IE 中,window 物件有一個 external 屬性,它提供了一個外部介面,可以執行宿主程式碼。要透過它呼叫 C# 方法,有兩個必要條件:

  1. 宿主類別必須標記為 ComVisible,也就是對 COM 可見。
  2. 必須把該類別的執行個體指派給 WebBrowser 的 ObjectForScripting 屬性。

步驟一:準備 C# 宿主類別

在 Form 上放一個 WebBrowser 控制項,另外準備一個方法供 js 呼叫:

[System.Runtime.InteropServices.ComVisibleAttribute(true)]
public partial class Main : KSBiz.UI.KSForm
{
    public Main()
    {
        InitializeComponent();
    }

    // 其餘省略

    public void OpenForm(string s)
    {
        BasicInfo.CustomerList f = new StockManage.BasicInfo.CustomerList();
        f.Show();
        f.MdiParent = this;
        webBrowser1.Visible = false;
    }
}

ComVisibleAttribute(true) 讓整個類別對腳本可見。要注意這是一個安全性上的重大決定:一旦開放,載入的任何頁面都能呼叫這個類別上所有 public 方法。因此實務上應該只開放一個專用的、方法極少的代理類別,而非整個主視窗類別。

步驟二:撰寫 HTML 頁面

<body>
<h1>歡迎使用</h1>
<a href='#' onclick='window.external.OpenForm("test");'>客戶列表</a>
</body>

在網頁中,即可透過 window.external 呼叫 C# 的方法,如同呼叫本地物件一樣。

步驟三:設定 URL 與腳本宿主

在 Form 的 Load 事件中,為 WebBrowser 設定頁面路徑,並指定腳本執行的宿主物件:

private void Main_Load(object sender, EventArgs e)
{
    System.IO.FileInfo file = new System.IO.FileInfo("top.htm");
    // WebBrowser 控制項顯示的網頁路徑
    webBrowser1.Url = new Uri(file.FullName);
    // 將當前類別設定為可由腳本存取
    webBrowser1.ObjectForScripting = this;
}

設定完成,橋樑就搭好了。

反向溝通:C# 呼叫 JavaScript

實際專案中幾乎一定需要雙向溝通。C# 端可以呼叫:

webBrowser1.Document.InvokeScript("showMessage", new object[] { "從後端傳來的文字" });

或用 DocumentCompleted 事件確認頁面載入完成後再互動。這樣就構成完整的雙向通道:網頁負責呈現與互動,宿主負責系統功能。

安全與維護上的提醒

  • 不要用整個主視窗作為宿主。建立一個只包含必要方法的 MarshalByRefObject 或簡單代理類別,並在每個方法中驗證呼叫來源。
  • 所有參數都要驗證。來自網頁的字串可能包含路徑、指令或 SQL,必須視為不可信輸入處理。
  • 避免在頁面中載入外部內容。若頁面可顯示外部廣告或使用者生成內容,等於把宿主能力開放給第三方。
  • 考慮改用 WebView2。WebBrowser 是 IE 內核,已停止演進且存在大量相容性問題。若專案允許,改用 Edge WebView2 可獲得現代渲染能力,並透過 ICoreWebView2 的 AddHostObjectToScript 與 WebMessageReceived 建立更安全靈活的雙向通訊。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved