Qt嵌入浏览器（五）——CEF入口与QCefView控件的使用

上一节中我们讲解了基于CEF浏览器开发的基本方法，并实现了QCefView控件和其核心组件QCefClient。 >>点这里回顾上节内容

先来回顾一下上一节中提到的CEF3应用整体结构：

其中第三条浏览器实例相关的实现在上一节中已经完成了，本篇我们将继续完成另一个核心组件QCefApp的开发，并通过实际使用QCefView，展示如何提供CEF初始化入口，最终完成浏览器核心功能和基本UI的开发。

本篇的小目标：

和CefClient类似，我们的应用程序需要提供一个CefApp的封装，来处理进程相关的回调——这里进程相关的回调对于我们要实现的简单浏览器而言，就是对浏览器进程本身的管理。因此，我们的QCefApp组件头文件声明如下：

和CefClient类似，CefApp也可以通过继承多个接口的方式实现进程级的各类管理。因为我们要实现的简单浏览器暂时不涉及太多复杂的管理，所以这里只简单实现了浏览器进程处理和上下文初始化的接口。同样和CefClient类似，对于CefXXXHandler接口，只需要将引用设为本实例，即可重载对应接口所提供的方法了。

额外说明一点：这里的创建浏览器进程方法里有一个添加ca证书的方法，目前先作为预留，有关ca证书和https的话题在之后的小节中会有专门的讲解。

浏览器上下文初始化、添加和关闭浏览器接口的具体实现如下：

通过上面的实现可以看出，添加浏览器实例进程实际上就是创建了一个QCefClient的引用，并将这个引用和浏览器相关的一些设置传入到静态方法CefBrowserHost::CreateBrowser中。而OnContextInitialized方法通过设置m_contextReady标志确保在创建浏览器实例时CEF上下文已初始化完成。

在完成CefApp组件的实现后，我们已经基本凑齐了启动CEF所需的零件。最后让我们来看看如何把这些零件借助CEF程序入口组装起来。

首先，声明一个QCefContext类，来封装CEF程序入口所需的基本设置和初始化方法：

其中，负责初始化CEF的initCef方法实现如下：

这个初始化方法包含了下面流程：

这里需要特别说明的是，CEF应用在默认情况下包含很多子进程（渲染进程、插件、GPU进程等等），这些进程会共享同一个执行入口。这里我们简单起见，仅就主进程进行处理——从上面的实现可以看到，当检测到当前进程为主进程时，创建一个CefApp的实例即可。这个实例的引用会通过cefApp()方法提供给需要获取CefApp的其他组件使用。

接下来我们来看看如何实际使用上面封装好的程序入口。

首先声明一个继承了QDialog的主窗口MainDlg:

在这个主窗口的构造方法中，会调用初始化QCefView的方法initWebview：

initWebview方法包含了QCefView界面布局相关的一些设置，这里我们略过这些实现，只专注于QCefView本身初始化的流程：

从上面的实现可以看出，这里我们只需要通过CefApp的添加浏览器方法获取QCefClient的引用，并将其提供给QCefView，就能简单完成QCefView控件的创建。

回到整个应用程序的入口，也就是main函数，除了传统Qt应用的实现之外，还需要添加一下CEF入口相关（也就是我们上一小节封装好的QCefContext）的实现：

至此，我们的浏览器应用初版终于完成了。运行一下看看效果：

本节所涉及到的组件及其流程可以总结为下面的时序图：

有关基于CEF的浏览器基本功能的实现，就讲解到这里了。下一节我们将介绍如何基于CEF实现浏览器与页面的互相通信。

>>返回系列索引

[1] Chromium Embedded Framework官网

[2] Chromium Embedded Framework官方教程

开始

首先，根据自身所使用的开发平台，可以去 这里 下载对应的发布版本。针对这个教程，我们需要下载1750或者更新的版本。当前支持的平台有Windows, Linux和Mac OS X。每一个版本都包含了当在特定平台上编译特定版本CEF3时所需要的所有文件和资源。您可以通过包含在里边的 REDME.txt 文件或者在Wiki上GeneralUsage 中的 Getting Started，了解每个发布版本的具体内容和细节。

编译发布版本中的项目

以CEF发布版本为基础开发的应用程序可以使用标准的平台编译工具进行编译执行。包括 Windows 平台下的 Visual Studio, Mac OS X 平台下的 Xcode, 以及 Linux 平台下的 gcc/make。针对平台的不同，项目的编译过程也有些许的不同和要求。

Windows

Windows 平台下编译 Cefsimple 步骤：

1. 用对应的 Visual Studio 版本打开项目解决方案。举个例子，如果你安装的是 Visual Studio 2010， 那么，打开的就是 cesimple2010.sln。

2. 如果你下载的是 x64版本，请确保你选择的是 x64的开发平台。

3. 开始编译。

4. 如果编译通过，那么，在当前解决方案的目录下，将出现“out/Debug”（或者 “out/Release”）文件夹。

5. 执行文件夹下 cefsimple.exe, 确保能正确运行。

加载一个自定义URL

cefsimple项目中默认加载的URL是 google.com，当然，你也可以用自定义的 URL 去替代它，最方便的就是通过命令行搞定。

# Load the local file “c:\example\example.html”

cefsimple.exe --url=file://c:/example/example.html

除了命令行的方法，也可以通过直接修改在 cefsimple/simple.cpp 文件中的代码，达到你的目的。

# Load the local file “c:\example\example.html”

…

if (url.empty())

url = file://c:/example/example.html

应用程序组成

所有的 CEF 应用程序都有一下主要组成部分：

1. CEF 的动态链接库 。(在 Windows 平台下就是 libcef.dll)

2. 支持库。（ICU, FFMPEG等）

3. 资源。(html/js/css, strings等)

4. 客户端执行文件。(本教程中就是 cefsimple.exe.)

要点（必看）

1. CEF 使用的是多进程。应用程序主进程是浏览器进程，而其他子进程是由 renderer, plugins, GPU等创建。

2. 在 Windows 和 Linux 平台下的执行文件可以被主进程和子进程使用。

3. CEF 中所有进程都可以是多线程的。CEF提供了许多功能和接口在不同的线程中传递任务。

4. 一些回调方法和函数只能在特定的进程或者线程中使用。在你第一次使用新的回调方法或者函数之前，请确保你已经阅读了 API 头文件中源码，看使用要求。

流程分析

cefsimple 应用程序首先初始化CEF，然后创建了一个简单的d出浏览器窗口。当关闭了所有的浏览器窗口，应用程序就会结束。程序执行流程如下：

1. 系统执行入口点函数(main or wWinMain)，并创建浏览器进程。

2. 入口点函数：

1. 创建能够处理进程级别的回调方法的 SimpleApp 实例。

2. 初始化 CEF，进入 CEF 消息循环。

3. 初始化 CEF 之后，调用 SimpleApp::OnContextInitialized() 。这个方法中：

1. 创建单例的 SimpleHandler 。

2. 由 CefBrowserHost::CreateBrowsersync() 方法创建一个浏览器窗口。

4. 所有的浏览器共享 SimpleHandler 实例， 此实例能定制浏览器行为、处理浏览器相关回调方法(life span, loading state, title display等)。

5. 当一个浏览器窗口关闭的时候，调用 SimpleHandler::OnBeforeClose() 。当所有的浏览器窗口全部关闭时，OnBeforeClose() 函数就会执行跳出 CEF 消息循环的行为，退出应用程序。

入口点函数

程序的运行开始于浏览器进程中的入口点函数。这个函数会初始化 CEF 以及所有跟 *** 作系统有关的对象。

Windows

#include <windows.h>

#include "cefsimple/simple_app.h"

#include "include/cef_sandbox_win.h"

// Set to 0 to disable sandbox support.

#define CEF_ENABLE_SANDBOX 1

#if CEF_ENABLE_SANDBOX

// The cef_sandbox.lib static library is currently built with VS2010. It may not

// link successfully with other VS versions.

#pragma comment(lib, "cef_sandbox.lib")

#endif

// Entry point function for all processes.

int APIENTRY wWinMain(HINSTANCE hInstance,

HINSTANCE hPrevInstance,

LPTSTRlpCmdLine,

int nCmdShow) {

UNREFERENCED_PARAMETER(hPrevInstance)

UNREFERENCED_PARAMETER(lpCmdLine)

void* sandbox_info = NULL

#if CEF_ENABLE_SANDBOX

// Manage the life span of the sandbox information object. This is necessary

// for sandbox support on Windows. See cef_sandbox_win.h for complete details.

CefScopedSandboxInfo scoped_sandbox

sandbox_info = scoped_sandbox.sandbox_info()

#endif

// Provide CEF with command-line arguments.

CefMainArgs main_args(hInstance)

// SimpleApp implements application-level callbacks. It will create the first

// browser instance in OnContextInitialized() after CEF has initialized.

CefRefPtr<SimpleApp>app(new SimpleApp)

// CEF applications have multiple sub-processes (render, plugin, GPU, etc)

// that share the same executable. This function checks the command-line and,

// if this is a sub-process, executes the appropriate logic.

int exit_code = CefExecuteProcess(main_args, app.get(), sandbox_info)

if (exit_code >= 0) {

// The sub-process has completed so return here.

return exit_code

}

// Specify CEF global settings here.

CefSettings settings

#if !CEF_ENABLE_SANDBOX

settings.no_sandbox = true

#endif

// Initialize CEF.

CefInitialize(main_args, settings, app.get(), sandbox_info)

// Run the CEF message loop. This will block until CefQuitMessageLoop() is

// called.

CefRunMessageLoop()

// Shut down CEF.

CefShutdown()

return 0

}

SimpleApp

SimpleApp 负责处理进程级别的回调方法。它会曝露出一些在多进程中共享或者被特定进程使用的接口和方法。CefBrowserProcessHandler 接口，在浏览器进程中调用。还有一个被分离出 CefBrowserProcessHandler 接口（例子项目没有展示）只会在渲染进程中被调用。由于 CefBrowserProcessHandler 不光实现了 CefApp, 同时还有 CefBrowserProcessHandler，所以它的返回值必须是[this]。

// simple_app.h

#include "include/cef_app.h"

class SimpleApp : public CefApp,

public CefBrowserProcessHandler {

public:

SimpleApp()

// CefApp methods:

virtual CefRefPtr<CefBrowserProcessHandler>GetBrowserProcessHandler()

OVERRIDE { return this}

// CefBrowserProcessHandler methods:

virtual void OnContextInitialized() OVERRIDE

private:

// Include the default reference counting implementation.

IMPLEMENT_REFCOUNTING(SimpleApp)

}

// simple_app.cpp

#include "cefsimple/simple_app.h"

#include <string>

#include "cefsimple/simple_handler.h"

#include "cefsimple/util.h"

#include "include/cef_browser.h"

#include "include/cef_command_line.h"

SimpleApp::SimpleApp() {

}

void SimpleApp::OnContextInitialized() {

REQUIRE_UI_THREAD()

// Information used when creating the native window.

CefWindowInfo window_info

#if defined(OS_WIN)

// On Windows we need to specify certain flags that will be passed to

// CreateWindowEx().

window_info.SetAsPopup(NULL, "cefsimple")

#endif

// SimpleHandler implements browser-level callbacks.

CefRefPtr<SimpleHandler>handler(new SimpleHandler())

// Specify CEF browser settings here.

CefBrowserSettings browser_settings

std::string url

// Check if a "--url=" value was provided via the command-line. If so, use

// that instead of the default URL.

CefRefPtr<CefCommandLine>command_line =

CefCommandLine::GetGlobalCommandLine()

url = command_line->GetSwitchValue("url")

if (url.empty())

url = "http://www.google.com"

// Create the first browser window.

CefBrowserHost::CreateBrowserSync(window_info, handler.get(), url,

browser_settings, NULL)

}

SimpleHandler

SimpleHandler 负责处理浏览器级别的回调方法。这些回调方法会在浏览器进程中执行。在这个项目中，针对所有的浏览器使用相同的 CefClient 实例，但是如果你愿意，可以在自己的应用程序中使用不同的 CefClient实例的。

// simple_handler.h

#include "include/cef_client.h"

#include <list>

class SimpleHandler : public CefClient,

public CefDisplayHandler,

public CefLifeSpanHandler,

public CefLoadHandler {

public:

SimpleHandler()

~SimpleHandler()

// Provide access to the single global instance of this object.

static SimpleHandler* GetInstance()

// CefClient methods:

virtual CefRefPtr<CefDisplayHandler>GetDisplayHandler() OVERRIDE {

return this

}

virtual CefRefPtr<CefLifeSpanHandler>GetLifeSpanHandler() OVERRIDE {

return this

}

virtual CefRefPtr<CefLoadHandler>GetLoadHandler() OVERRIDE {

return this

}

// CefDisplayHandler methods:

virtual void OnTitleChange(CefRefPtr<CefBrowser>browser,

const CefString&title) OVERRIDE

// CefLifeSpanHandler methods:

virtual void OnAfterCreated(CefRefPtr<CefBrowser>browser) OVERRIDE

virtual void OnBeforeClose(CefRefPtr<CefBrowser>browser) OVERRIDE

// CefLoadHandler methods:

virtual void OnLoadError(CefRefPtr<CefBrowser>browser,

CefRefPtr<CefFrame>frame,

ErrorCode errorCode,

const CefString&errorText,

const CefString&failedUrl) OVERRIDE

// Request that all existing browser windows close.

void CloseAllBrowsers(bool force_close)

private:

// List of existing browser windows. Only accessed on the CEF UI thread.

typedef std::list<CefRefPtr<CefBrowser>>BrowserList

BrowserList browser_list_

// Include the default reference counting implementation.

IMPLEMENT_REFCOUNTING(SimpleHandler)

}

// simple_handler.cpp

#include "cefsimple/simple_handler.h"

#include <sstream>

#include <string>

#include "cefsimple/util.h"

#include "include/cef_app.h"

#include "include/cef_runnable.h"

namespace {

SimpleHandler* g_instance = NULL

最近打算用 CEF 给我们自己的应用做一套插件系统，功能很简单，简单说来就两个：支持自定义 js 接口，支持 html 页面展现。

做的时候遇到了一个问题，就是 CEF 官方示例都是基于 CEF 进程架构，只要主程序一启动，相关进程都要起来。我们的需求是，当前应用程序只有在需要 CEF 的时候再启动。所以，要搞定的是动态加载 CEF，启动相关进程。

总体的实现思路如下：

---