CEF3開發者系列之外篇——IE中JS與C++交互

　　　使用IE內核開發客戶端產品，系統和前端頁面之間的交互，通常給開發和維護帶來很大的便利性。但操作系統和前端之間的交互卻是比較復雜的。具體來說就是腳本語言和編譯語言的交互。在IE內核中html和css雖然不兼容,但是IE編程接口是完全一樣的,這得益於微軟的COM組件的結構化設計和實現。所以與IE交互,必須得先說一下COM，COM全稱組件對象模型（Component Object Model）。

       COM的基本思想很簡單,所有的組件模塊都提供一個最根本的接口, IUnkown,它有三個方法,AddRef和Release實現了引用計數,QueryInterface實現了根據接口id查詢另外的接口,所有的接口都從IUnkown派生。基於IE內核做開發,有一個接口是最關鍵的,IDispatch（欲知詳情移步IDispatch接口 - GetIDsOfNames和Invoke）。 IDispatch接口是COM自動化的核心。其實，IDispatch這個接口本身也很簡單，只有4個方法：最關鍵的兩個方法Invoke和 GetIDsOfNames。腳本語言和編譯型語言之間進行通信是通過IDispatch接口來行的。下面看一下這個關鍵的方法的原型:

IDispatch:public IUnkown
{
    //...
    HRESULT Invoke( DISPID dispIdMember,REFIID riid, LCID lcid,WORD wFlags,DISPPARAMS FAR* pDispParams,VARIANT FAR* pVarResult, EXCEPINFO FAR* pExcepInfo, unsigned int FAR* puArgErr );  
    //...
}

 

         這個方法每個參數的意義msdn上有詳細的闡述,就我的理解而看,它作為一個組件, 向外提供了一個萬能接口,據此可以實現兩個很有用的功能:

         1. 獲取和設置組件的屬性變量. 對應wFlags的DISPATCH_PROPERTYGET和DISPATCH_PROPERTYPUT

         2.以任意參數調用任意一個被支持的方法. 對應wFlags的DISPATCH_METHOD

         用面向對象的觀點來看,有了這兩個功能,任意一個實現該接口的組件就抽象成同一個接口實現的萬能對象,可以通過指定的字符串名字獲取設置屬性和調用方 法。如果有過腳本編程經驗開發人員一定會發現,腳本恰恰就是如此。c++書寫代碼的時候也是通過名字訪問對象,但編譯好后變成二進制代碼后就沒有名字的概念了,只有偏移和地址。而腳本里頭書寫代碼的時候是通過名字,解釋執行的時候也是通過名字。腳本和native語言的最大區別是腳本對象的所有屬性和方法 是動態的,在執行的時候還可以修改。看到這里,很容易聯想到實現了IDispatch的組件對象具有了腳本的特性,c++對象被腳本化了！這就意味着你可 以把原來用 c++寫的類的所有屬性和方法都通過Invoke來執行,在腳本里頭可以直接訪問！相當於給腳本增加了native的擴展。IDispatch接口很重要 的一個功能就是如此,微軟通常所說的雙接口就是這個意思。了解了這些,接下來要和JS腳本交互就比較容易了。

 

既然是IE內核里的JS與C++互相調用，我們先來簡單的了解下IE內核編程需要的幾個常用接口。說多了不好理解，先來看圖。

  
 

IWebBrowser2， IHTMLWindow2，IHTMLDocument2 這三個常用接口都是從IDispatch 派生的。IWebBrowser2接口里主要提供瀏覽器常規功能如打開URL、前進、后退等功能。IHTMLWindow2主要是提供接口操作瀏覽器中打 開的window對象，IHTMLDocument2獲取文檔相關信息，以及審查和修改HTML元素和文檔中文本，包括獲取JS對象。

IHTMLWindow2 對應於一個window的視圖,IHTMLDocument2是IHTMLWindow2渲染文檔,對應着dom樹結構。在js中有兩個全局對象 window和document,分別對應着IHTMlWindow2和 IHTMLDocument2。

想要詳細了解這些，參看如下資料：

IWebBrowser2 interface https://msdn.microsoft.com/en-us/library/aa752127%28VS.85%29.aspx

IHTMLWindow2 interface  https://msdn.microsoft.com/zh-cn/library/aa741505

IHTMLDocument2 interface  https://msdn.microsoft.com/zh-cn/library/aa752574

要完成c++和js交互,可以分解成兩個任務,一是c++調用js代碼;二是js調用c++代碼,這其實也所有腳本和natvie交互的兩個基本任務。本文主要根據自己的理解從設計開發的角度去闡述為什么要這么做。

C++調用JS

每段js執行代碼都有它自己的執行環境,在IE里面可以看做是IHTMLWindow2。

根 據上邊所講，我們用先獲取全局對象document，從document變成的IDispatch接口中得到 IHTMLDocument2，IHTMLDocument2接口的get_Script方法獲取到了HTML文檔中JS代碼的IDispatch接口， 我們用IDispatch接口，把HTML文檔中的JS代碼當作一個COM對象，對他進行操作。

CComPtr<IDispatch> GetScript()
{

	CComPtr<IWebBrowser2> spWebBrowser;

	HRESULT hResult = QueryControl(IID_IWebBrowser2, (void**)&spWebBrowser);

	if (SUCCEEDED(hResult))

	{

		CComPtr<IDispatch> spDocDisp;
		hResult = spWebBrowser->get_Document(&spDocDisp);
		if (SUCCEEDED(hResult))
		{

			CComPtr<IHTMLDocument2> spDocDisp2;
			hResult = spDocDisp->QueryInterface(IID_IHTMLDocument2, (void**)&spDocDisp2);
			if (SUCCEEDED(hResult))
			{
				CComPtr<IDispatch> spScript;
				hResult = spDocDisp2->get_Script(&spScript);
				if (SUCCEEDED(hResult))
				{
				return spScript;
				}
			}
		}
	}
}

 

 

有兩種方案可以執行JS,一種是直接調用IHTMLWindow2的execScript方法.

      HRESULT execScript( BSTR code,    BSTR language, VARIANT *pvarRet);

      代碼示例：

wstring strJavaScript;

CComVariant pvarRet;

CComBSTR bstrJavaScript(strJavaScript.c_str());

CComBSTR bstrScriptType(_T("javascript"));

CComQIPtr<IHTMLWindow2> spWindow2(spScriptDisp);

spWindow2->execScript(bstrJavaScript, bstrScriptType, &pvarRet);

 

      要看懂這段代碼不難，我們先來了解下CComQIPtr，用IDispatch接口調用COM對象的各種方法、設置與獲取COM對象的屬性、讓COM對象 回調我們，都是用IDispatch的Invoke方法來實現。一個Invoke就要實現那么多功能，用起來當然很麻煩。不過好在ATL智能指針類中的 CComDispatchDriver(即CComQIPtr<IDispatch>)封裝了IDispatch接口，使用起來非常方便！先拿到IHTMLWindow2接口的智能指針,直接把js代碼環境IDispatch指針的賦值給它。不過注意這里是BSTR的字符串,可以用 SysAllocString來分配。

 

      第二種方案同樣是使用IHTMLDocument的get_Script()方法。它能得到一個IDispatch指針,這個IDispatch就是IHTMLDocument里的JS。按照前面介紹的IDispatch的使用,你通過它就可以調用任意js函數了。例如要執行一個 js中的函數 function。

CComPtr<IHTMLDocument2> spDocDisp2;
spDocDisp2->get_Script(&spScript);
OLECHAR *  Names= L"function" ;
DISPID dispID=0;

//先獲取接受調度標示符DISPID，需要調用GetIDsOfNames來獲取
spScript->GetIDsOfNames(IID_NULL,&Names,1,LOCALE_SYSTEM_DEFAULT, &dispID);

//通過Invoke（援引）方法調用JS方法
spScript->Invoke(dispID,,IID_NULL ,LOCALE_SYSTEM_DEFAULT,DISPATCH_METHOD,NULL,NULL,NULL,NULL);

 

       這里function是js里面的一個全局函數。這里可以看到 Invoke並沒有直接把字符串名字拿過來用,而是通過另一個方法GetDispofNames做了一個映射，獲取接受調度標示符DISPID。通過 IHTMLDocument得到的script接口對應着該頁面的JS全局環境,從中可以通過多次invoke得到任意一個全局變量，函數，從而能夠得到對象的成員變量或成員方法。

         第二種方案就是通過Invoke調用來實現在c++中存取js變量和調用函數。這和第一種方案的區別很明顯,一個是在用c++寫js代碼,有點類似自己在解析執行js了，而前者更簡單，再復雜的js調用序列,一個字符串全部搞定。

          要做到c++和腳本交互有一個基本的問題要做好,就是腳本中的數據類型和c++中的數據類型如何對應起來。眾所周知,js中有很多類型,Boolean, Number, String, Object, Array , Function等。寫到這里,插一句,基本所有的語言里頭都有字符串和數字這兩種基本的數據類型(c/c++中僅為以\0結尾的字符數組),面向對象的 語言中還會有Object這樣的復合數據類型。在Invoke調用參數中, VARAINT就代表了c中的基本數據類型,js中的數字會轉換成VT_I4或者VT_R4或VT_R8。字符串會轉換成VT_BSTR類型的 bstr(這是微軟com標准里使用的字符串類型),其他所有的復合類型包括對象數組函數在c中都對應着VT_DISPATCh的一個IDispatch 指針。有了IDispatch指針,你就可以按照前面的方法任意存取對象的屬性,也可以發起函數調用並獲得返回值。了解了這些,就可以進行c與js的交互 了,它們都通過IDispatch的invoke調用來完成。CComDispatchDriver對GetIDsOfNames和Invoke進一步進 行了封裝，只需更少的參數即方便可調用。

Invoke0    //調用0個參數的方法

Invoke1    //調用1個參數的方法

Invoke2    //調用2個參數的方法

InvokeN    //調用多個參數的方法

 

 說了這么多，估計有些人看得雲里霧里的。下邊直接給出例子：

我們動手寫一個HTML，其中包含這樣一段JS代碼:

 

<script type="text/javascript">  

    function Add(value1, value2) {  

        return value1 + value2;  

    }  

</script>  

 

然后我們用WebBrowser加載這個HTML后，在VC中這樣來調用這個函數名為Add的JS函數:

 

//別忘了#include <MsHTML.h>  

//m_WebBrowser是一個WebBrowser的Activex控件對象。  
CComQIPtr<IHTMLDocument2> spDoc = m_WebBrowser.get_Document();  
CComDispatchDriver spScript;  
spDoc->get_Script(&spScript);  
  
CComVariant var1 = 10, var2 = 20, varRet;  

spScript.Invoke2(L"Add", &var1, &var2, &varRet);  

 

spScript.Invoke2的作用是調用JS函數中名為Add的函數，傳入兩個參數，用varRet接收返回值。Invoke2調用成功后，varRet得到了返回值30。

 

但這樣的話一次只能接受一個返回值。如果要一次接受多個返回值的話，怎么辦呢？

我們可以讓JS返回一個JS中的Array數組或Object對象。

當 JS函數return一個Array或一個Object對象時，VC這邊的 varRet將接受到一個代表該對象的IDispatch接口。我們仍然用CComDispatchDriver來管理這個IDispatch。 CComDispatchDriver有四個方法：

GetProperty

GetPropertyByName

PutProperty

PutPropertyByName

來從這個Array或Object對象中取出我們要的數據。

實踐是檢驗真理的唯一標准，讓我們再來寫一個JS函數:

 

<script type="text/javascript">  

    function Add(value1, value2) {  

        var array = new Array();  

        array[0] = value1;  

        array[1] = value2;  

        array[2] = value1 + value2;  

        return array;  
    }  

</script> 

 

然后在VC中這樣寫：

CComQIPtr<IHTMLDocument2> spDoc = m_WebBrowser.get_Document();  
CComDispatchDriver spScript;  

spDoc->get_Script(&spScript);  
CComVariant var1 = 10, var2 = 20, varRet;  
spScript.Invoke2(L"Add", &var1, &var2, &varRet);  
      
CComDispatchDriver spArray = varRet.pdispVal;  

//獲取數組中元素個數，這個length在JS中是Array對象的屬性
CComVariant varArrayLen;  

spArray.GetPropertyByName(L"length", &varArrayLen);  
//獲取數組中第0,1,2個元素的值：  

CComVariant varValue[3];  

spArray.GetPropertyByName(L"0", &varValue[0]);  
spArray.GetPropertyByName(L"1", &varValue[1]);  
spArray.GetPropertyByName(L"2", &varValue[2]);  

 

 

可以看到，10,20,30，這三個JS函數返回的值已經躺在我們的varValue[3]里了。

當然，如果不知道JS返回的Array對象里面有幾個元素，我們可以在VC這邊獲取它的length屬性，然后在一個循環中取出數組中的每個值。

 

如果我們的JS函數返回一個包含有多個屬性值的Object對象，VC這邊該如何接收呢？

讓我們再來寫一個JS函數:

<script type="text/javascript">  

    function Add(value1, value2) {  

        var data = new Object();  

        data.result = value1 + value2;  

        data.str = "Hello,World!";  

        return data;  

    }  

</script>  

 

然后在VC中我們這樣接收：

    CComQIPtr<IHTMLDocument2> spDoc = m_WebBrowser.get_Document();  
    CComDispatchDriver spScript;  

    spDoc->get_Script(&spScript);  
    CComVariant var1 = 10, var2 = 20, varRet;  
    spScript.Invoke2(L"Add", &var1, &var2, &varRet);  
    CComDispatchDriver spData = varRet.pdispVal;  

    CComVariant varValue1, varValue2;  

    spData.GetPropertyByName(L"result", &varValue1);  
    spData.GetPropertyByName(L"str", &varValue2);  

 

我 們從JS返回的Object對象里取出了它的兩個屬性，result和str，分別是一個整形數據和一個字符串。這里JS代碼是我們自己寫的，在VC這邊 當然事先知道這個JS函數返回的對象有result和str這兩個屬性。如果JS代碼不是我們寫的，或者它的屬性是事先不能確定的，該怎么辦呢？答案是使用IDispatchEx接口來枚舉這個對象的相關信息(方法名、屬性名)。

C++調用JS的實例演示到此為止。

 

js調用c++代碼

       按照前面所說的IDispatch的用途,就可以推斷出如何做到這一點了,自定義一個c++類,實現一個IDispatch的接口,把它的指針通過某次 js調用作為返回值返回給js,那么js代碼中就持有該對象了,就可以像使用普通js對象一樣的使用它。問題是,一開始js啥都沒有,怎么直接調到c++ 里頭從而返回c++對象呢?IE已經考慮好了這個問題,它對於每個IWebbrowser2實例(頂層)有一個內置的IDispatch對象,該對象可以 在創建瀏覽器控件實例之后在c++中自己制定,而在js中則使用window.external來訪問。也就是說每個js環境都已經內置了一個全局對象 external,並且它對應的c++中的IDispatch可以由程序員自己指定。下面談一下如何來設置這個對象實例。

     在windows中要自己host一個active控件,如果用sdk自己寫。其中有一個接口叫IDocHostUIHandler ,它有一個方法GetExternalDisp用以向宿主查詢一個IDispatch對象,就直接對應着js中的external腳本對象。 IDocHostUIHandler 還有一個有用的方法ShowContextMenu,當要show菜單的時候這個方法會被回調,應用程序就可以自定義菜單了。MFC也可以很方便的 host一個IE控件,但它的類庫太龐大了,幸虧微軟又出了ATL,提供了一個輕量級的方法讓你可以達到同樣的效果。下面直接貼代碼片段.

      

class CWebBrowser : public CAxHostWindow

{

	private:

	CComPtr<IWebBrowser2> m_pWebBrowser; //保存創建出來的瀏覽器控件實例

	BEGIN_MSG_MAP(CWebBrowser)

	MESSAGE_HANDLER(WM_CREATE,OnCreate)

	CHAIN_MSG_MAP(CAxHostWindow)

	END_MSG_MAP()

 
	LRESULT OnCreate(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& /*bHandled*/)
	{
		// Create WebBrowser object
		LPOLESTR pName=NULL;

		StringFromCLSID(CLSID_WebBrowser,&pName);

		CComPtr<IDispatch>disp;
		CComPtr<IUnknown> p;

		_InternalQueryInterface(IID_IDispatch,(void**)&disp);

		// 創建 WebBrowser
		CreateControlEx(pName,m_hWnd,NULL,&p,DIID_DWebBrowserEvents2,disp);  
		CoTaskMemFree(pName);

		// 查詢IWebBrowser2 接口，用於控制
		HRESULT hRet = QueryControl(IID_IWebBrowser2, (void**)&this->m_pWebBrowser); 

		return m_pWebBrowser?S_OK:-1;

	}
}

 

         CWebBrowser 是用戶自己的宿主窗口,在它的OnCreate里頭創建com對象,一個瀏覽器窗口就出來了,這個代碼是不是很簡潔?CAxHostWindow為我們做 了很多事情,包括IDocHostUIHandler也被實現,所以我們從它派生就天然的擁有了很多控制IE控件的能力,當然都是通過com接口來完成 的。以后如果有定制需求,大可重寫父類的虛函數來達到目的。CAxHostWindow還封裝了一個方法SetExternalDispatch,到這里 一切都可以暫時告一段落了,你可以在CWebBrowser中實現IDispatch也可以單獨用一個類來實現,然后把IDispatch接口設進去就可 以了。有興趣研究這個寄宿控件過程的童鞋們可以看CAxHostWindow的代碼實現,全在一個頭文件中。

        假設你的external提供了一個函數創建對象   function newMyObject,在js中

         var newObject=window.external.newMyObject(); //通過external構建一個c++對象交給js持有

         alert(newObject.name);       //訪問該對象的屬性

         alert(newObject.GetValue())  //調用該對象的方法

        那么你需要做的事情其實還是關注Invoke就可以了.在external的IDispatch的Invoke實現中

STDMETHODIMP CWebBrowserDisp::Invoke(DISPID dispIdMember,  REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS* pDispParams, VARIANT* pVarResult, EXCEPINFO* pExcepInfo, unsigned int* puArgErr)
{
    HRESULT nRet = S_OK;

    if(wFlags&DISPATCH_METHOD) //屬於方法調用
    {
		//給newMyObject分配的id,字符串名字映射

		if(dispIdmember== DISPID_newMyObject)

		{
			IDispatch* pMyObject=NULL;

			//創建c++對象並獲取其IDispatch接口

			CreateMyObject(&pMyObject);

			pVarResult->vt=VT_DISPATCH;

			pVarResult->pdispVal=pMyObject;   //作為返回值傳遞給js
		}
    }
    return 0;
}

 

        這個代碼也很簡潔。據此可以看出,要把c++對象導出到js中,那么該對象必須要實現IDispatch接口,只需要把這個接口作為Invoke的返回值 傳給js即可。它有引用計數,不必擔心內存的釋放問題,在js的垃圾回收被觸發的某個時刻自然會被銷毀。接下來,MyObject有哪些屬性和方法可以被 js調用,那就又歸它自己的IDispatch的Invoke實現來關心了。

        另外一種就是在webbrowser控件中，JS調用C++方法。如果你對webbrowser控件熟悉的話，這里使用起來就更簡單了。Invoke接口實現基本上和上邊的類似，唯一不同的是如何讓JS調用到本地的C++ 代碼。在JS代碼中創建了函數window.external.newMyObject()。頁面渲染時，會觸發瀏覽器的GETEXTERNAL事件，在瀏覽器中，通過消息過濾，當消息為WN_GETEXTERNAL時，通過IDispatch接口，獲取JS代碼需要調用的類。

            IDispatch **ppDispatch = (IDispatch**)wParam;

            *ppDispatch = &m_superCall;

       綜上所述,在IE中和c++與js交互,IDispatch扮演了很重要的角色,理解好了它你就可以隨心所欲的c++和js的混合編程了。COM接口很不容易理 解,知道怎么用,卻難以了解其內部機制。其實,在前面所講的過程中,IDispatch是自己的代碼創建的,和系統完全無關。從c++的語法看,它就是繼 承了一個虛基類,實現其全部方法而已,還有就是引用計數。所以,我們完全可以用很簡單的c++代碼來寫自己的IDispatch,不必去理會那么多的COM特性。js執行環境總是在主線程,所以你要知道一點你的對象的方法也總是在主線程被調用。下邊給出簡單的實現代碼：

#include "StdAfx.h"
#include "SQSuperCall.h"

CJSCallC::CJSCallC(void)
{
	 m_mapFunction[TEXT("FuncTest")] = DISPID_FuncTest;
}

CJSCallC::~CJSCallC(void)
{
}

HRESULT STDMETHODCALLTYPE CJSCallC::GetIDsOfNames( 
	/* [in] */ __RPC__in REFIID riid,
	/* [size_is][in] */ __RPC__in_ecount_full(cNames) LPOLESTR *rgszNames,
	/* [range][in] */ UINT cNames,
	/* [in] */ LCID lcid,
	/* [size_is][out] */ __RPC__out_ecount_full(cNames) DISPID *rgDispId)
{
	HRESULT hr = NOERROR;
	for (UINT nIndex = 0; nIndex < cNames; ++nIndex)
	{
		wstring strFuntion = rgszNames[nIndex];
		map<wstring, int>::iterator iter = m_mapFunction.find(strFuntion);
		if (m_mapFunction.end() != iter)
		{
			rgDispId[nIndex] = iter->second;
		}
		else
		{
			hr = ResultFromScode(DISP_E_UNKNOWNNAME);
			rgDispId[nIndex] = DISPID_UNKNOWN;
		}
	}

	return hr;
}

/* [local] */ HRESULT STDMETHODCALLTYPE CJSCallC::Invoke( 
	/* [in] */ DISPID dispIdMember,
	/* [in] */ REFIID riid,
	/* [in] */ LCID lcid,
	/* [in] */ WORD wFlags,
	/* [out][in] */ DISPPARAMS *pDispParams,
	/* [out] */ VARIANT *pVarResult,
	/* [out] */ EXCEPINFO *pExcepInfo,
	/* [out] */ UINT *puArgErr)
{
	if (dispIdMember == DISPID_FuncTest)
	{
        int paramsCount = pDispParams->cArgs;
		if (paramsCount < 2)
            return S_FALSE;

		VARIANTARG* cmdVar = (VARIANTARG*)(&pDispParams->rgvarg[paramsCount - 1]);
	    if (!(cmdVar->vt == VT_I4  || cmdVar->vt == VT_BSTR))
			return S_FALSE;
        int nCmdId = cmdVar->intVal;

        cmdVar = (VARIANTARG*)(&pDispParams->rgvarg[paramsCount - 2]);
        if( cmdVar->vt != VT_BSTR )
            return S_FALSE;
        CString csInfos = cmdVar->bstrVal;
        wstring strInfos(csInfos);

	}
	return S_OK;
}

HRESULT STDMETHODCALLTYPE CJSCallC::QueryInterface( 
	/* [in] */ REFIID riid,
	/* [iid_is][out] */ 
	__RPC__deref_out  void **ppvObject)
{
	//*ppvObject = NULL;
	if (riid == IID_IUnknown)
	{
		*ppvObject = static_cast<IUnknown*>(this);
	}
	else if (riid == IID_IDispatch)
	{
		*ppvObject = static_cast<IDispatch*>(this);
	}
	else
	{
		return E_NOINTERFACE;
	}
	return S_OK;
}

 

 

參考文檔：

VC與JavaScript交互(一) ———— 如何實現

瀏覽器編程之二IE控件與JS交互篇