美文网首页Qt学习程序员
Qt嵌入浏览器(五)——CEF入口与QCefView控件的使用

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

作者: ArcDriver | 来源:发表于2018-08-18 17:45 被阅读500次

    本篇简介

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

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

    • 提供一个入口方法初始化CEF,并执行CEF的消息循环;
    • 提供CefApp的实现,以处理进程相关(process-specific)的回调;
    • 提供CefClient的实现,以处理浏览器实例相关(browser-instance-specific)的回调。

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

    本篇的小目标:

    • 实现QCefApp组件
    • 实现CEF程序入口
    • 使用封装好的QCefView,完成浏览器开发

    实现QCefApp组件

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

    class QCefApp: public CefApp,
            public CefBrowserProcessHandler
    {
    public:
        QCefApp();
        virtual ~QCefApp();
    
        // CefApp接口
        virtual CefRefPtr<CefBrowserProcessHandler> GetBrowserProcessHandler()
            OVERRIDE { return this; }
    
        // CefBrowserProcessHandler接口:
        virtual void OnContextInitialized() OVERRIDE;
    
        // 创建浏览器进程的工厂方法
        CefRefPtr<QCefClient> addBrowser(QList<QSslCertificate> caCerts = QList<QSslCertificate>());
        
        // 关闭所有浏览器进程
        void closeAllBrowser();
    
       private:
        bool m_contextReady;
        QQueue<CefRefPtr<QCefClient> > m_clients;
        // Include the default reference counting implementation.
        IMPLEMENT_REFCOUNTING(QCefApp)
    };
    

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

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

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

    void QCefApp::OnContextInitialized()
    {
        CEF_REQUIRE_UI_THREAD();
        m_contextReady = true;
    }
    
    CefRefPtr<QCefClient> QCefApp::addBrowser(QList<QSslCertificate> caCerts)
    {
        if (m_contextReady)
        {
            // 创建本地窗口所需的信息
            CefWindowInfo windowInfo;
    
    #if defined(OS_WIN)
            // 针对Windows系统,需要指定特殊的标识,
            // 这个标识会被传递给CreateWindowEx()方法
            windowInfo.SetAsPopup(NULL, "QCefView");
    #endif
            // 初始化cef client方法
            CefRefPtr<QCefClient> client(new QCefClient());
            client->setCaCerts(caCerts);
            // 指定CEF浏览器设置
            CefBrowserSettings browserSettings;
            std::string url = "data:text/html,chromewebdata";
            // 创建浏览器窗口
            CefBrowserHost::CreateBrowser(windowInfo, client.get(), url, browserSettings, NULL);
            // 将浏览器引用添加到浏览器队列
            m_clients.enqueue(client);
            return client;
        }
        return NULL;
    }
    
    void QCefApp::closeAllBrowser()
    {
        while (!m_clients.empty())
        {
            m_clients.dequeue()->browser()->GetHost()->CloseBrowser(true);
        }
    }
    

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

    CEF程序入口

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

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

    class QCefContext
    {
    public:
        QCefContext(CefSettings* settings);
        ~QCefContext();
    
        //初始化 Cef
        int initCef(int argc, char *argv[]);
    
    public:
        CefRefPtr<QCefApp> cefApp() const;
    
    private:
        int initCef(CefMainArgs& mainArgs);
    
    private:
        CefSettings* m_settings;
        CefRefPtr<QCefApp> m_cefApp;
        CefRefPtr<CefCommandLine> m_cmdLine;
    };
    

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

    int QCefContext::initCef(int argc, char *argv[])
    {
        // 创建CEF默认命令行参数.
        m_cmdLine = CefCommandLine::CreateCommandLine();
    #ifdef CEF_LINUX
        CefMainArgs mainArgs(argc, argv);
        m_cmdLine->InitFromArgv(argc, argv);
    #else
        // 兼容WINDOWS系统
        HINSTANCE hInstance = (HINSTANCE)GetModuleHandle(NULL);
        CefMainArgs mainArgs(hInstance);
        m_cmdLine->InitFromString(::GetCommandLineW());
    #endif
        return initCef(mainArgs);
    }
    
    int QCefContext::initCef(CefMainArgs& mainArgs)
    {
        CefRefPtr<CefApp> app;
    
        // 创建一个正确类型的App Client
        if (!m_cmdLine->HasSwitch("type"))
        {
          app = new QCefApp();
          m_cefApp = CefRefPtr<QCefApp>((QCefApp*)app.get());
        }
    
        int result = CefExecuteProcess(mainArgs, app, NULL);
        if (result >= 0)
        {
          return result;
        }
    
        // 初始化CEF
        CefInitialize(mainArgs, *m_settings, app.get(), NULL);
    
        return -1;
    }
    

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

    • 创建CEF默认命令行参数,并将应用程序本身的参数也提供给CEF上下文
    • 根据命令行参数类型,实例化对应类型的CefApp

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

    QCefView控件的使用

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

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

    namespace Ui {
    class MainDlg;
    }
    
    class MainDlg : public QDialog
    {
        Q_OBJECT
    public:
        explicit MainDlg(CefRefPtr<QCefApp> cefApp, QWidget *parent = 0);
        ~MainDlg();
    
    private:
        void initWebview(CefRefPtr<QCefApp> cefApp);
    
    private:
        Ui::MainDlg *ui;
        QCefView* m_webview;
    };
    

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

    MainDlg::MainDlg(CefRefPtr<QCefApp> cefApp, QWidget* parent) : QDialog(parent), ui(new Ui::MainDlg)
    {
        ui->setupUi(this);
        initWebview(cefApp);
    }
    

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

    void MainDlg::initWebview(CefRefPtr<QCefApp> cefApp)
    {
        // 省略界面布局的设置
        ...
        // 初始化QCefView
        m_webview = new QCefView(cefApp->addBrowser(), upperFrame);
    
        connect(m_webview, SIGNAL(cefEmbedded()), this, [this]() {
            show();
        });
    
        connect(ui->btnGo, &QPushButton::clicked, this, [this]() {
            m_webview->load(QUrl(ui->editAddress->text()));
        });
    
        // 省略界面布局的设置
        ...
    }
    

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

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

    int main(int argc, char *argv[])
    {
        int result = 0;
    
        CefSettings settings;
        // 禁用日志
        settings.log_severity = LOGSEVERITY_DISABLE;
        // 设置CEF资源路径(cef.pak和/或devtools_resources.pak)
        CefString(&settings.resources_dir_path) = CefString();
        // 本地化资源路径
        CefString(&settings.locales_dir_path) = CefString();
    
        QCefContext* cef = new QCefContext(&settings);
        result = cef->initCef(argc, argv);
        if (result >= 0)
            return result;
    
        QApplication a(argc, argv);
        QApplication::addLibraryPath(".");
    
        MainDlg* browser = new MainDlg(cef->cefApp());
        result = a.exec();
    
        delete browser;
        delete cef;
    
        CefShutdown();
    
        return result;
    }
    

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


    cef_browser.png

    流程总结

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


    QCefBrowser应用时序图.png

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

    参考链接

    [1] Chromium Embedded Framework官网
    [2] Chromium Embedded Framework官方教程

    相关文章

      网友评论

      • 冯冯冯_223b:请问 我这里MainDlg显示了,浏览器的三个进程也在,就是没渲染到MainDlg上,是不是布局的问题,能指导下吗
      • 61f34b66750d:您好,请问 initWebview 这个函数里面的 upperFrame 这个变量是哪里来的呀?:no_mouth:
        ArcDriver:@MatthiasKk 您好,这个变量只是定义了装载控件的布局,对主流程没有影响,所以没有详细说

      本文标题:Qt嵌入浏览器(五)——CEF入口与QCefView控件的使用

      本文链接:https://www.haomeiwen.com/subject/qcwfiftx.html