背景

cef是一種跨平臺的框架，屬于chrome內核，可以用來顯示web相關頁面。目前在咚咚工作臺上使用，顯示聊天框，歷史消息，插件頁面等等。之前只是在win平臺上使用，在今年開發mac版本商家咚咚過程中，完成了mac版本的適配，積累了一些在兩個平臺上的使用方法，避免以后再踩坑。

?

一. 庫和資源文件

基本的庫文件包含了多個文件夾和資源文件，這些是運行cef時必須要依賴的，因此需要打包在安裝包中。

表1.1 cef依賴文件

以上是cef運行時所依賴的所有文件，其中include和libcef_dll, 可以組合生成一個lib靜態庫，一般名稱為libcef_dll_wrapper.lib，在其它模塊中需要依賴該cef頭文件時，導入lib庫即可。

在升級cef版本的過程中，只需要替換替換對應的文件夾中的文件，就可以升級到對應的版本，目前最新的100以上的版本，基本都是這些固定的文件格式。

如果添加了新的文件或者依賴庫，則需要添加對應的庫和資源。

?

二. 文件路徑查找

資源文件，需要設定路徑才能找到對應的文件，在CefSettings指定對應的路徑。

表2.1 cef資源路徑設置

2.1 對于資源路徑，win版本可以放到同一目錄下面，例如在安裝目錄下，新建一個CEF目錄，專門用來放置資源文件：

2.2 dll庫則在主安裝目錄下面：

2.3 mac版本的目錄文件基本是固定的：

Chromium Embedded Framework.framework

一般可以放置到app包的頂層或者Frameworks目錄下面

?

以上的路徑，都需要明確指定絕對路徑，即完整的訪問路徑資源，不能使用相對路徑，比如../../../之類的，因此在程序內部，需要專門封裝查找資源路徑的方法，這樣在應用安裝到用戶電腦上，才能準確找到對應的資源。

若資源文件無法找到，則在后續的初始化，第一步就會報錯，只有找到文件，才能進行后續的步驟。

?

三. 主進程初始化

主進程初始化分為多個步驟：

?

3.1 加載cef動態庫

如果將libcef庫放置在標準目錄下面，即win是exe同級目錄，則無需查找動態庫，系統可以自行查找到，如果放到其它目錄，則需要采用動態加載庫的方式。

mac可以使用cef提供的標準方法：

CefScopedLibraryLoader library_loader;

library_loader.LoadInMain()

來直接加載主進程庫。

若采用顯示路徑來加載的方式，可以指定

Chromium Embedded Framework.framework下面的Chromium Embedded Framework，整個的完整路徑

然后使用cef提供的方法：cef_load_library，加載指定路徑下的主進程文件。

加載主庫必須成功，失敗則直接返回，后續一切步驟都依賴主進程的加載完成。

3.2 獲取啟動參數

啟動的時候，都需要使用CefMainArgs，來獲取命令行的參數

表3.1 cef獲取啟動命令

接著生成 CefRefPtr app，這個類繼承自cef的基本app類：CefApp

繼承ClientApp，來生成主進程方法：

app = new ClientAppBrowser();

3.3 設置其它參數

設置日志級別：settings.log_severity

日志目錄：settings.log_file

瀏覽器版本和說明：settings.user_agent

調試時的端口：settings.remote_debugging_port

3.4 主進程初始化

直接調用CefInitialize(main_args, settings, app.get(), sandbox_info)

傳入命令，設置選項，app實例，sandbox的內容，通常來說sandbox為空，不啟用即可

返回成功可以進行后續步驟，失敗表示主進程啟動異常，后續也無法顯示頁面。

?

四.渲染進程生成

渲染進程，可以采用和主進程合并模式，也可以采用單獨的進程。一般比較大型或者復雜的項目，都需要單獨的進程，并為了不同的頁面，還需要啟動多個子進程。

啟動流程和主進程類似，先加載子進程路徑，再獲取命令行參數，繼承CefApp啟動實例，最后再初始化。

進程名稱，win可以自己定義，mac有嚴格限制，必須以xxx Helper結尾，否則找不到對應的渲染子進程。

表1.1 cef子進程名稱

4.1 子進程的路徑，理論上可以設置到專門的目錄下面，但也可以讓系統去默認路徑查找，即和主應用同級別即可。

加載cef資源的時候，win版本在主應用同級別的exe，不用專門的方法去加載。

mac版本需要使用cef的專用方法：

CefScopedLibraryLoader library_loader;

library_loader.LoadInHelper()

若是需要專門的路徑，則仍然使用cef_load_library去加載庫的絕對路徑，加載成功后，才能正常初始化子進程。

?

4.2 在最后初始化時，可以直接調用cef的方法：

CefExecuteProcess(main_args, app, nullptr)

返回值大于0，表示啟動子進程已經成功，可以開啟渲染頁面等操作。

返回值小于0，表示啟動子進程失敗，頁面將無法進行渲染，但是不影響主進程的正常運行。

子進程實現的最好方式，是將所有的依賴文件，都集成在同一個模塊工程中，不依賴其它的模塊，這樣在編譯運行的時候，就不會由于依賴過多導致各種錯誤。

?

五. 消息循環

不同的系統版本中，采用不同的消息循環模式，需要和主應用的消息循環合作運行。

5.1 在win版本中，可以通過設置multi_threaded_message_loop為true的參數，開啟瀏覽器多線程模式。能夠和主應用的主消息循環并行處理運行。

如圖所示，win應用中，在main方法中需要開啟主界面的消息循環，這里的消息循環就一直在UI主線程中運行，直到應用退出，消息循環主線程才會結束退出。

另外在cef的瀏覽器主進程中，也同時開啟多線程消息循環，此時Browser獨享自己的消息循環線程，和主消息循環互不影響，可以實時的收到界面的點擊響應和顯示web界面等。

?

5.2 在mac版本中，有兩種cef消息循環方式

第一種：直接將主應用的消息循環設置為cef的消息循環，即所有的消息接收和傳遞，都在CefRunMessageLoop()中進行，此時cef的消息循環占據了主導地位，主界面的按鈕點擊等操作，都需要cef拋出并提交給主線程。

第二種：當mac中采用了Qt等框架時，它本身有自己的消息主循環，而cef在mac中無法再開啟自己的消息主循環，也不支持采用多線程機制單獨運行。因此采用了將cef消息循環嵌入到Qt的消息循環中的方式，相當于時間片分割方式，到了定時時間，去專門處理cef的事件響應。

主循環消息啟動后，生命周期跟隨主應用，一直到應用退出才會結束。此時定一個時間片分割，時間自定義，可以50幀也就是每隔20ms處理一次。

當定時周期到的時候，就執行cef的消息循環處理，在CefDoMessageLoopWork()中去處理cef的具體事件響應。

另外在cef本身的回調中，也可以使用onScheduleMessageLoopWork()中拿到事件，然后到cef事件循環中去處理。

這樣主循環和cef自己的的循環，就不斷運行起來，在用戶使用時，感覺不到這個細微的延時差距，主界面和cef界面基本都是在同時響應。

?

六.窗口適配

在界面顯示過程中，打開網頁或者本地頁面時，通常需要重新修改窗口尺寸。在不同的版本需要不同的處理方式：

表6.1 cef窗口適配

在創建一個瀏覽器窗口時，需要調用SetAsChild設置瀏覽器的子窗口，這里首先獲取當前生成的窗口id，可以直接用CefWindowHandle來進行轉換。

在重繪窗口大小的時候，需要移動窗口，調整高和寬，這里cef沒有提供通用的方法，只能使用不同平臺的原生方法，因此調用了操作系統的系統接口。

獲取窗口可以直接使用cef內部封裝好的GetWindowHandle，這個是通用的接口，需要在UI線程中調用，但是在一些特殊的web窗口中，需要使用GetOpenerWindowHandle來獲取非pop窗口的句柄，從而操作窗口界面正常顯示。

?

七.版本區分

7.1 操作系統版本區分可以直接使用開源庫的方法：

win系統：Q_OS_WIN

mac系統：Q_OS_MAC

當需要區分使用不同操作系統的接口，或者調用對應系統的原生方法時，需要使用該宏定義進行區分處理。

7.2 cef版本區分，可以使用cef_version中的定義：

#define CEF_VERSION_MAJOR 106

#define CEF_VERSION_MINOR 1

#define CEF_VERSION_PATCH 0

#define CEF_COMMIT_NUMBER 2678

通常來說，若應用程序中，同時存在多個cef版本，比如89，106等，主要是主版本號不同，則直接判斷CEF_VERSION_MAJOR的數值即可，另外的三個小版本可以不做過多關注，若大版本相同，則需要進行小版本的詳細區分。

不同的cef大版本，接口基本是一樣的，但是當相差幾十個版本的cef庫時，則會出現接口參數變更，或者名稱變化，新增部分接口等差異點，則需要在不同版本進行對應的處理和適配。

?

結尾

使用cef在win和mac上用的同一套文件，利用Qt的宏定義對平臺進行了區分，利用cef版本對不同版本進行兼容，因此同樣的源代碼文件，在兩個平臺都可以運行，不同的cef版本也可以同時運行，比較方便維護升級。

后續可以繼續完善，形成更多不同的功能，并進一步拆分成獨立的模塊，讓大家少走一些彎路。

審核編輯 黃宇