Winform客户端内嵌Vue页面(开放源码)

        目前很多应用都存在网页端和客户端形式,例如常用的:钉钉、微信等。按传统的开发形式,需要为客户端开发一套界面。基于当前 Web 应用可以利用三大前端框架和 UI 框架快速开发出各种酷炫的界面,于是出现了客户端嵌浏览器的方式,它不仅可以重用 Web 应用,而且以客户端内嵌浏览器的形式,不用担心用户用 IE 浏览器打开你的 Web 应用(滑稽);

下面展示 Winform 客户端 +ChromiumFX 嵌 Vue 应用页面效果:


 

一、下载资源文件#

(1)Chromiumfx 下载(目前最新版本 73.1.13.0,发布时间 2019-04-18)

下载链接:https://bitbucket.org/chromiumfx/chromiumfx/downloads/

解压后打开 cef 文件夹中的 readme.txt 文件,查看依赖的 cef 的版本。

 

(2)下载依赖的 cef(这里对应的版本为 73.1.13+g6e3c989+chromium-73.0.3683.75)

下载链接:http://opensource.spotify.com/cefbuilds/index.html#windows32_builds

根据不同的操作系统版本下载相应的 Sample Application 即可

解压后的文件如下:


二、新建 Winfrom 项目#

(1)编译 ChromiumFX 程序

        打开 ChromiumFX.sln 解决方案(我用的是 VS2015),按平台需求选择 Release x86 或者其他,依次生成 libcfx、ChromiumFX、ChromiumWebBrowser 项目生。

        在 \Build\ Release 中复制我们需要的三个文件 libcfx.dll、ChromiumFX.dll、ChromiumWebBrowser.dll(这里要编译 libcfx C 项目,有点麻烦,源码中已经编译好了,这步可以省略)

(2)新建 Winform 项目,项目中引用 ChromiumFX.dll、ChromiumWebBrowser.dll

添加初始化页面窗体

private string mUrl = "";
        ChromiumWebBrowser testWeb;
        public InitForm(string url)
        {InitializeComponent();
            mUrl = url;
        }
    </span><span style="color: rgba(0, 0, 255, 1)">private</span> <span style="color: rgba(0, 0, 255, 1)">void</span> Form1_Load(<span style="color: rgba(0, 0, 255, 1)">object</span><span style="color: rgba(0, 0, 0, 1)"> sender, EventArgs e)
    {
        testWeb </span>= <span style="color: rgba(0, 0, 255, 1)">new</span><span style="color: rgba(0, 0, 0, 1)"> ChromiumWebBrowser(mUrl);
        testWeb.GlobalObject.AddFunction(</span><span style="color: rgba(128, 0, 0, 1)">"</span><span style="color: rgba(128, 0, 0, 1)">newpage</span><span style="color: rgba(128, 0, 0, 1)">"</span>).Execute += NewPage;<span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">定义JS调用C#事件</span>
        testWeb.GlobalObject.AddFunction(<span style="color: rgba(128, 0, 0, 1)">"</span><span style="color: rgba(128, 0, 0, 1)">userLogin</span><span style="color: rgba(128, 0, 0, 1)">"</span>).Execute +=<span style="color: rgba(0, 0, 0, 1)"> UserLogin;
        testWeb.Dock </span>= DockStyle.Fill;<span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">铺满</span>
        <span style="color: rgba(0, 0, 255, 1)">this</span>.WindowState =<span style="color: rgba(0, 0, 0, 1)"> FormWindowState.Maximized;
        </span><span style="color: rgba(0, 0, 255, 1)">this</span><span style="color: rgba(0, 0, 0, 1)">.Controls.Add(testWeb);
        CEFHelper.cefevent(testWeb, </span><span style="color: rgba(0, 0, 255, 1)">this</span>.Handle);<span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">F12调试窗口,方便开发,生产环境可去掉</span>

}

//弹出新窗体
private void NewPage(object sender, Chromium.Remote.Event.CfrV8HandlerExecuteEventArgs e)
{
//获取 js 传入的参数,需对应到参数类型
if (e.Arguments.Length > 0)
{
ShadowForm shadow
= new ShadowForm(e.Arguments[0].StringValue);
shadow.Show();
}

        </span><span style="color: rgba(128, 128, 128, 1)">///</span><span style="color: rgba(0, 128, 0, 1)">/设置返回值,可为基本类型,js将接收到此返回值,如不需返回值,则此处可省略</span>
        <span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">e.SetReturnValue("这是调用c#函数的结果");</span>

}

//JS 调用后台的登录方法,获取 token
private void UserLogin(object sender, Chromium.Remote.Event.CfrV8HandlerExecuteEventArgs e)
{
ResponseInfo response
= new ResponseInfo();
try
{
//获取 js 传入的参数,需对应到参数类型
if (e.Arguments.Length > 0)
{
if (e.Arguments[0].StringValue == "test" && e.Arguments[1].StringValue == "123")
{
UserInfo user
= new UserInfo();
user.userName
= "admin";
user.token
= "JWT.token";
response.success
= true;
response.data
= JsonConvert.SerializeObject(user);
e.SetReturnValue(JsonConvert.SerializeObject(response));
//返回数据
}
else
{
response.success
= false;
response.errMsg
= "用户名或密码错误!";
e.SetReturnValue(JsonConvert.SerializeObject(response));
}
}
}
catch (Exception ex)
{
response.success
= false;
response.errMsg
= ex.Message;
e.SetReturnValue(JsonConvert.SerializeObject(response));
}

    }</span></pre>

 #

三、新建弹出窗体#

(1)创建蒙层窗体

private string mUrl = "";
        public ShadowForm(string url)
        {InitializeComponent();
            mUrl = url;
        }
    </span><span style="color: rgba(0, 0, 255, 1)">private</span> <span style="color: rgba(0, 0, 255, 1)">void</span> timer1_Tick(<span style="color: rgba(0, 0, 255, 1)">object</span><span style="color: rgba(0, 0, 0, 1)"> sender, EventArgs e)
    {
        timer1.Enabled </span>= <span style="color: rgba(0, 0, 255, 1)">false</span><span style="color: rgba(0, 0, 0, 1)">;
        NewPageForm page </span>= <span style="color: rgba(0, 0, 255, 1)">new</span><span style="color: rgba(0, 0, 0, 1)"> NewPageForm(mUrl);
        page.StartPosition </span>=<span style="color: rgba(0, 0, 0, 1)"> FormStartPosition.CenterScreen;
        page.ShowInTaskbar </span>= <span style="color: rgba(0, 0, 255, 1)">false</span><span style="color: rgba(0, 0, 0, 1)">;
        page.ShowDialog(</span><span style="color: rgba(0, 0, 255, 1)">this</span><span style="color: rgba(0, 0, 0, 1)">);
        Close();
    }

    </span><span style="color: rgba(0, 0, 255, 1)">private</span> <span style="color: rgba(0, 0, 255, 1)">void</span> ShadowForm_Load(<span style="color: rgba(0, 0, 255, 1)">object</span><span style="color: rgba(0, 0, 0, 1)"> sender, EventArgs e)
    {
        </span><span style="color: rgba(0, 0, 255, 1)">this</span>.WindowState =<span style="color: rgba(0, 0, 0, 1)"> FormWindowState.Maximized;
        timer1.Enabled </span>= <span style="color: rgba(0, 0, 255, 1)">true</span><span style="color: rgba(0, 0, 0, 1)">;
    }</span></pre>

 

(2)创建弹出窗体

        ChromWebHelper cwh;
        ChromiumWebBrowser webBrowser;
        private string mUrl = "";
        public NewPageForm(string url)
        {InitializeComponent();
            mUrl = url;
        }
    </span><span style="color: rgba(0, 0, 255, 1)">private</span> <span style="color: rgba(0, 0, 255, 1)">void</span> NewPageForm_Load(<span style="color: rgba(0, 0, 255, 1)">object</span><span style="color: rgba(0, 0, 0, 1)"> sender, EventArgs e)
    {
        webBrowser </span>= <span style="color: rgba(0, 0, 255, 1)">new</span><span style="color: rgba(0, 0, 0, 1)"> ChromiumWebBrowser(mUrl);
        webBrowser.GlobalObject.AddFunction(</span><span style="color: rgba(128, 0, 0, 1)">"</span><span style="color: rgba(128, 0, 0, 1)">newpage</span><span style="color: rgba(128, 0, 0, 1)">"</span>).Execute +=<span style="color: rgba(0, 0, 0, 1)"> NewPage;
        webBrowser.GlobalObject.AddFunction(</span><span style="color: rgba(128, 0, 0, 1)">"</span><span style="color: rgba(128, 0, 0, 1)">closefrm</span><span style="color: rgba(128, 0, 0, 1)">"</span>).Execute +=<span style="color: rgba(0, 0, 0, 1)"> CloseFrm;
        webBrowser.Dock </span>= DockStyle.Fill;<span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">铺满</span>
        <span style="color: rgba(0, 0, 255, 1)">this</span>.Controls.Add(webBrowser);<span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">加入窗体</span>
        cwh = <span style="color: rgba(0, 0, 255, 1)">new</span><span style="color: rgba(0, 0, 0, 1)"> ChromWebHelper(webBrowser);

        CEFHelper.cefevent(webBrowser, </span><span style="color: rgba(0, 0, 255, 1)">this</span><span style="color: rgba(0, 0, 0, 1)">.Handle);
    }

    </span><span style="color: rgba(0, 0, 255, 1)">private</span> <span style="color: rgba(0, 0, 255, 1)">void</span> NewPage(<span style="color: rgba(0, 0, 255, 1)">object</span><span style="color: rgba(0, 0, 0, 1)"> sender, Chromium.Remote.Event.CfrV8HandlerExecuteEventArgs e)
    {
        </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">获取js传入的参数,需对应到参数类型</span>
        <span style="color: rgba(0, 0, 255, 1)">if</span> (e.Arguments.Length &gt; <span style="color: rgba(128, 0, 128, 1)">0</span><span style="color: rgba(0, 0, 0, 1)">)
        {
            ShadowForm shadow </span>= <span style="color: rgba(0, 0, 255, 1)">new</span> ShadowForm(e.Arguments[<span style="color: rgba(128, 0, 128, 1)">0</span><span style="color: rgba(0, 0, 0, 1)">].StringValue);
            shadow.Show();
        }

        </span><span style="color: rgba(128, 128, 128, 1)">///</span><span style="color: rgba(0, 128, 0, 1)">/设置返回值,可为基本类型,js将接收到此返回值,如不需返回值,则此处可省略</span>
        <span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">e.SetReturnValue("这是调用c#函数的结果");</span>

}

    </span><span style="color: rgba(0, 0, 255, 1)">private</span> <span style="color: rgba(0, 0, 255, 1)">void</span> CloseFrm(<span style="color: rgba(0, 0, 255, 1)">object</span><span style="color: rgba(0, 0, 0, 1)"> sender, Chromium.Remote.Event.CfrV8HandlerExecuteEventArgs e)
    {
        </span><span style="color: rgba(0, 0, 255, 1)">this</span><span style="color: rgba(0, 0, 0, 1)">.Close();
    }</span></pre>

 

四、编译 Winform 窗体程序#

(1)把依赖的 cef 库文件夹中的 Release 文件夹更名为 cef

并把它复制到 Winform 程序的 \bin\Release\ 目录下

 

(2)把上述编译生成的 libcfx.dll 也复制到 \bin\Release\,然后编译程序,以 Release 方式运行。


 

五、总结#

Winform 客户端嵌 Web 应用的方式不仅可以简化开发,而且做出来的应用界面美观。

源码地址:https://github.com/Bingjian-Zhu/ChromeiumFXDemo.git   (喜欢的记得 star)