Qt嵌入浏览器(六)——QCefView实现JS通信接口

本篇简介

上一节中,我们完成了CEF各基本组件的封装,并完成了浏览器基本功能的实现。>>点这里回顾上节内容

本节我们将尝试扩展所实现的各组件,实现浏览器与页面的双向通信。

本篇的小目标:

  • 实现浏览器与页面的双向通信

原理简述

上一节曾提到过,CEF应用在默认情况下包含很多子进程,这些进程会共享同一个执行入口。除了主进程的各类处理接口外,CEF还提供了各类子进程的处理接口。而页面到浏览器的消息通道就可以借助对渲染进程的控制来实现,整体流程如下:

  1. 重载渲染进程的上下文初始化监听接口,获取V8上下文引用
  2. 从V8上下文中获取所加载的窗口对象
  3. 借助V8处理器定义消息通道函数
  4. 向窗口对象中注册消息通道函数

完成上述步骤后,在页面调用对应的消息通道函数时,V8处理器则会相应地进行处理,从而完成消息的发送。

另一方面,实现浏览器到页面的消息通道和第二节中基于Qt WebEngine的方法类似,CEF也提供了执行JS脚本的方法,只需在页面中定义好对应的消息接口,并通过执行脚本方法执行该接口即可完成消息的发送。

因此,实现双向通道主要的问题集中在针对渲染进程处理和JS脚本执行的扩展上。接下来先就渲染进程处理进行说明。

渲染进程处理

为了实现对渲染进程的处理,我们首先需要向上一节中封装的QCefContext中添加对渲染进程入口的解析和处理。具体实现如下:

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());
    }
    else
    {
        CefString procType = m_cmdLine->GetSwitchValue("type");
        bool typeJudge = (procType == "renderer");
#ifdef CEF_LINUX
        typeJudge |= (procType == "zygote");
#endif
        if (typeJudge)
        {
            app = new QCefRenderHandler();
            m_cefRenderer = CefRefPtr<QCefRenderHandler>((QCefRenderHandler*)app.get());
        }
    }
    // 后续处理与上一小节相同,略过
    ...
}

上面的实现除了处理了CEF主进程外,还判断了子进程是否为渲染进程(Windows环境下的renderer进程和Linux环境下的zygote进程),如果发现当前处理的是渲染进程,则创建一个渲染进程处理器QCefRenderHandler的实例。QCefRenderHandler的声明如下:

class QCefRenderHandler : public CefApp,
        public CefRenderProcessHandler
{
public:
    QCefRenderHandler();
    ~QCefRenderHandler();

    CefRefPtr<CefRenderProcessHandler> GetRenderProcessHandler() OVERRIDE
    {
        return this;
    }

    virtual void OnContextCreated(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame, CefRefPtr<CefV8Context> context) OVERRIDE;

private:
    CefRefPtr<QCefV8Handler> m_v8Handler;

    IMPLEMENT_REFCOUNTING(QCefRenderHandler)
};

和主进程CefApp的实现类似,这里也实现了CefApp接口,此外额外实现了CefRenderProcessHandler接口的OnContextCreated方法,来获取V8上下文的引用,具体实现如下:

void QCefRenderHandler::OnContextCreated(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame, CefRefPtr<CefV8Context> context)
{
    qDebug() << "V8 Context Created!";

    // 取回V8上下文的window对象
    CefRefPtr<CefV8Value> object = context->GetGlobal();

    // 创建"sendMessage"函数,作为消息通道使用.
    m_v8Handler = CefRefPtr<QCefV8Handler>(new QCefV8Handler(browser));
    CefRefPtr<CefV8Value> func = CefV8Value::CreateFunction("sendMessage", m_v8Handler);

    // 将消息通道注册到window对象
    object->SetValue("sendMessage", func, V8_PROPERTY_ATTRIBUTE_NONE);
}

上面的实现将sendMessage函数定义为消息通道,并注册到了window对象上。sendMessage函数的具体实现则放在v8Handler的实现中。QCefV8Handler声明如下:

class QCefV8Handler : public CefV8Handler
{
public:
    QCefV8Handler(CefRefPtr<CefBrowser> browser);
    ~QCefV8Handler();

virtual bool Execute(const CefString& name, CefRefPtr<CefV8Value> object, const CefV8ValueList& arguments, CefRefPtr<CefV8Value>& retval, CefString& exception) OVERRIDE;

private:
    CefRefPtr<CefBrowser> m_browser;

  IMPLEMENT_REFCOUNTING(QCefV8Handler)
};

QCefV8Handler通过实现CEF V8处理器的Execute执行方法,完成对所加载的JS函数的过滤,并进行相应的处理,实现如下:

bool QCefV8Handler::Execute(const CefString& name,
           CefRefPtr<CefV8Value> object,
           const CefV8ValueList& arguments,
           CefRefPtr<CefV8Value>& retval,
           CefString& exception)
{
    if (name == "sendMessage")
    {
        if (arguments.size() == 1)
        {
            CefString msgStr = arguments.at(0)->GetStringValue();
            //消息会被发送到CefClient的OnProcessMessageReceived接口方法
            m_browser->SendProcessMessage(PID_BROWSER, CefProcessMessage::Create(msgStr));
            retval = CefV8Value::CreateInt(0);
        }
        return true;
    }
    return false;
}

这里首先对函数名和参数进行了校验,之后调用CefBrowser的IPC方法SendProcessMessage向主进程的CefClient发送消息,从而完成页面向浏览器主进程消息的传递。

实现消息通道

页面->浏览器

要实现页面到浏览器的消息通道,除了完成了上面渲染进程的控制扩展,我们还需要在QCefClient中添加接收IPC消息的接口实现。首先在QCefClient头文件中声明对CefClient接口的重载:

virtual bool OnProcessMessageReceived(CefRefPtr<CefBrowser> browser, CefProcessId source_process, CefRefPtr<CefProcessMessage> message) OVERRIDE;

然后实现这个接口,完成消息的接收处理:

bool QCefClient::OnProcessMessageReceived(CefRefPtr<CefBrowser> browser, CefProcessId source_process,  CefRefPtr<CefProcessMessage> message)
{
    emit webMsgReceived(QString(message->GetName().ToString().c_str()));
    return true;
}

可以看到这里只是对收到的消息进行了简单的转换,并通过信号发送给感兴趣的下游控件使用。在第四小节的实现中,我们将QCefClient封装到了QCefView中,因此在QCefView中也需要将这个信号转发给它的下游控件:

connect(cefClientPtr, SIGNAL(webMsgReceived(QString)), this, SIGNAL(webMsgReceived(QString)));

这样,QCefView接收JS消息的通道就实现完成了。

这里额外讲解一下有关js alert的特殊处理。要实现js调用alert方法时的弹窗提醒,需要额外在CefClient中实现CefJSDialogHandler接口的OnJSDialog方法,参考实现如下:

bool QCefClient::OnJSDialog(CefRefPtr<CefBrowser> browser, const CefString& origin_url,JSDialogType dialog_type, const CefString& message_text,const CefString& default_prompt_text, CefRefPtr<CefJSDialogCallback> callback, bool& suppress_message)
{
    QMessageBox::warning(NULL, "JavaScript Alert", QString(message_text.ToString().c_str()));
    return true;
}

浏览器->页面

承前所述,浏览器到页面的消息发送通过CEF的JS脚本执行接口实现。首先在QCefView中,声明并实现一个执行JS脚本的方法:

void QCefView::runJavaScript(QString script)
{
    CefRefPtr<CefFrame> frame = m_cefClient->browser()->GetMainFrame();
    frame->ExecuteJavaScript(script.toStdString(), frame->GetURL(), 0);
}

然后指定一个特定的JS方法,作为消息通道使用:

void QCefView::sendToWeb(QString msg)
{
    runJavaScript(QString("recvMessage('%1');").arg(msg));
}

如此,QCefView发送JS的通道也实现完成了。

使用消息通道发送消息

完成了消息通道的实现,接下来我们实际使用一下我们定义好的消息通道。

首先是Qt端的实现,在MainDlg的initWebView方法中,添加对JS消息的监听,并将监听到的消息通过QMessageBox显示出来:

connect(m_webview, SIGNAL(webMsgReceived(QString)), this, [this](QString msg){
    QMessageBox::information(this, "接收到Web消息", msg);
});

然后添加文本输入和发送按钮,并在按钮点击信号对应的槽中调用QCefView的消息发送方法:

connect(ui->btnSend, &QPushButton::clicked, this, [this]() {
        QString msg = ui->editJsMsg->text();
        if(!msg.isEmpty()){
            m_webview->sendToWeb(msg);
        }
    });

接下来在页面端实现消息接收和发送的接口msgutils.js:

// 接收qt发送的消息
function recvMessage(msg)
{
    alert("接收到Qt发送的消息:" + msg);
}

// 控件控制函数
function onBtnSendMsg()
{
    var cmd = document.getElementById("待发送消息").value;
    window.sendMessage(cmd);
}

可以看到这里我们使用了上面定义的recvMessage和sendMessage两个函数。然后在页面上调用这些接口:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>CEF JS通道测试</title>
</head>
<body>
    <p>Cef Js Channel Test</p>
    <script type="text/javascript" src="./msgutils.js"></script>
    <input id="待发送消息" type="text" name="msgText" />
    <input type="button" value="发送消息到浏览器" onclick="onBtnSendMsg()" />
</body>
</html>

实际运行一下浏览器,并加载我们实现的这个页面,消息发送效果如下:


cef消息通道qt->web.png
cef消息通道web->qt.png

有关CEF消息通道的讲解就先进行到这里。下一节将分析使用CEF接口实现Https双向认证的方法。

>>返回系列索引

参考链接

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容