何以落实C

NanUI文档目录,与JS执行相关的回调函数被暴露是通过CefRenderProcessHandler接口实现

NanUI文档目录

一、介绍

Google浏览器和CEF使用V8JavaScript
Engine作为内容的JavaScript实现。在浏览器中的每个窗口都有它自己在的JS上下文提供功能域和在窗口中平安的施行JS代码。CEF透露大量JS效率集成在客户端应用程序。
CEF3的Webkit和JS在独立的渲染进程中运作。在渲染进程的主线程中动用TID_RENDERER
作为唯一标识。所有V8的执行必须放置在这个线程中。
与JS执行有关的回调函数被透露是通过CefRenderProcessHandler接口实现。当一个新的渲染进程被起初化时经过CefApp::GetRenderProcessHandler()函数获取这多少个接口。

什么样兑现C#与Javascript的互动通信

因此事先的作品,相信您已经对NanUI有了先河的询问。但到目前截至,我们选用NanUI仅仅只是作为显示HTML界面的容器,并未涉及CEF与C#间数据的竞相。那么本文将简单介绍如何在NanUI中使用C#调用Javascript的函数以及哪些在Javascript注入C#的对象、属性和方法。

二、执行JavaScript

C#调用Javascript函数

在客户端应用程序中简单的点子实施JS使用CefFrame::ExecuteJavaScript()函数,这个函数在浏览进程一和渲染进程中都可用。在一个JS上下文外可安好拔取。

不需要得到再次来到值的场合

假若页面中犹如下Javascript的函数sayHello,它的效能是在DOM中创建一个分包有“Hello
NanUI!”字样的p元素。

function sayHello() {
    var p = document.createElement("p");
    p.innerText = "Hello NanUI!";

    var container = document.getElementById("hello-container");
    container.appendChild(p);
}

以身作则中,该函数并不曾在Javascript环境里调用,而是在页面加载成功后采用NanUI的ExecuteJavascript艺术来调用它。ExecuteJavascript形式执行的归来结果为一个bool类型,它指示了本次有没有成功推行。

在窗体的构造函数中,通过注册Formium的LoadHandler中的OnLoadEnd事件来监测页面加载成功的气象,并在页面加载成功后调用JS环境中的函数sayHello。

namespace CommunicateBetweenJsAndCSharp
{
    using NetDimension.NanUI;
    public partial class Form1 : Formium
    {
        public Form1()
            : base("http://res.app.local/www/index.html",false)
        {
            InitializeComponent();

            LoadHandler.OnLoadEnd += LoadHandler_OnLoadEnd;
        }

        private void LoadHandler_OnLoadEnd(object sender, Chromium.Event.CfxOnLoadEndEventArgs e)
        {
            // Check if it is the main frame when page has loaded.
            if(e.Frame.IsMain)
            {
                ExecuteJavascript("sayHello()");
            }
        }
    }
}

运行后,可以观望界面中显示了“Hello
NanUI!”字样,表明使用ExecuteJavascript可以调用JS函数。


CefRefPtr<CefBrowser> browser = …;
CefRefPtr<CefFrame> frame = browser->GetMainFrame(); 
frame->ExecuteJavaScript(“alert(‘ExecuteJavaScript
works!’);”, frame->GetURL(), 0);

亟待得到重返值的事态

下面的例子中经过ExecuteJavascript主意来得逞调用了JS环境中的函数。但不难察觉,这种调用情势C#是没有接收到其他重回值的。但实则的门类里,我们是索要从JS环境得到到再次来到值的,这时候使用ExecuteJavascript将不可以满意要求,使用另外一个艺术EvaluateJavascript可以帮忙我们从JS环境中得到JS函数的重返值。

尽管有此外一个Javascript函数sayHelloToSomeone,它能接过一个字符传参数,在函数体中拼接并回到拼接后的字符串。

function sayHelloToSomeone(who) {
    return "Hello " + who + "!";
}

一律的,在上头例子LoadHandler的OnLoadEnd事件中我们来实施sayHelloToSomeone,并通过C#传送参数并获取拼接后的再次来到值。EvaluateJavascript方法通过一个回调Action来得到JS环境中的重临值。这多少个Action有三个参数,第一个是再次来到值的聚合,第二个是JS环境的非凡对象,假设函数正确履行,那么第二个参数为null

namespace CommunicateBetweenJsAndCSharp
{
    using NetDimension.NanUI;
    public partial class Form1 : Formium
    {
        public Form1()
            : base("http://res.app.local/www/index.html",false)
        {
            InitializeComponent();

            LoadHandler.OnLoadEnd += LoadHandler_OnLoadEnd;
        }

        private void LoadHandler_OnLoadEnd(object sender, Chromium.Event.CfxOnLoadEndEventArgs e)
        {
            // Check if it is the main frame when page has loaded.
            if(e.Frame.IsMain)
            {
                EvaluateJavascript("sayHelloToSomeone('C#')", (value, exception) =>
                {
                    if(value.IsString)
                    {
                        // Get value from Javascript.
                        var jsValue = value.StringValue;

                        MessageBox.Show(jsValue);
                    }
                });
            }
        }
    }
}

在上边的示范中,通过我们可以明显知道JS函数sayHelloToSomeone的再次回到值一定为String类型,因而在C#的回调中一直动用Value的StringValue属性来博取JS函数的字符传再次回到值。但在其实的拔取中,有可能并不完全知晓重返值的档次,因而需要采纳Value中置放的次第判断属性来挨家挨户筛选重临值。

需要专注的是,Value的类是是ChromiumFX中的CfrV8Value品类,它是一个不胜重要的项目,基本上所有在C#与CEF间的通信都是由这几个项目来形成的。


下面的引起alert(‘ExecuteJavaScript works!’)在浏览器的主窗口中执行。

Javascript调用C#目的及方法

在窗口的JS上下文中ExecuteJavaScript函数可用以函数和变量交互。是为着从JS到客户端应用程序重临值使用窗口绑定和扩大。

简单的利用示范

地点的著作中示范了什么样用C#来调用Javascript中的函数,那么下边的内容将介绍如何使用Javascript来调用C#中的对象、属性和各个措施。

此前,需要介绍NanUI窗体基类Formium中的紧要性质GlobalObject,您可以把他领略成Javascript环境中的window对象。假若您需要在Javascript环境下使用C#中的各个对象、属性和情势,都亟需将这一个目的、属性、方法注册到GlobalObject里。

上边的例证,通过在Form1的构造函数中登记一个名为my的JS对象,并在my放到一个只读属性name,以及showCSharpMessageBoxgetArrayFromCSharpgetObjectFromCSharp多少个函数。

//register the "my" object
var myObject = GlobalObject.AddObject("my");

//add property "name" to my, you should implemnt the getter/setter of name property by using PropertyGet/PropertySet events.
var nameProp = myObject.AddDynamicProperty("name");
nameProp.PropertyGet += (prop, args) =>
{
    // getter - if js code "my.name" executes, it'll get the string "NanUI". 
    args.Retval = CfrV8Value.CreateString("NanUI");
    args.SetReturnValue(true);
};
nameProp.PropertySet += (prop, args) =>
{
    // setter's value from js context, here we do nothing, so it will store or igrone by your mind.
    var value = args.Value;
    args.SetReturnValue(true);
};


//add a function showCSharpMessageBox
var showMessageBoxFunc = myObject.AddFunction("showCSharpMessageBox");
showMessageBoxFunc.Execute += (func, args) =>
{
    //it will be raised by js code "my.showCSharpMessageBox(`some text`)" executed.
    //get the first string argument in Arguments, it pass by js function.
    var stringArgument = args.Arguments.FirstOrDefault(p => p.IsString);

    if (stringArgument != null)
    {
        MessageBox.Show(this, stringArgument.StringValue, "C# Messagebox", MessageBoxButtons.OK, MessageBoxIcon.Information);


    }
};

//add a function getArrayFromCSharp, this function has an argument, it will combind C# string array with js array and return to js context.
var friends = new string[] { "Mr.JSON", "Mr.Lee", "Mr.BONG" };

var getArrayFromCSFunc = myObject.AddFunction("getArrayFromCSharp");

getArrayFromCSFunc.Execute += (func, args) =>
{
    var jsArray = args.Arguments.FirstOrDefault(p => p.IsArray);



    if (jsArray == null)
    {
        jsArray = CfrV8Value.CreateArray(friends.Length);
        for (int i = 0; i < friends.Length; i++)
        {
            jsArray.SetValue(i, CfrV8Value.CreateString(friends[i]));
        }
    }
    else
    {
        var newArray = CfrV8Value.CreateArray(jsArray.ArrayLength + friends.Length);

        for (int i = 0; i < jsArray.ArrayLength; i++)
        {
            newArray.SetValue(i, jsArray.GetValue(i));
        }

        var jsArrayLength = jsArray.ArrayLength;

        for (int i = 0; i < friends.Length; i++)
        {
            newArray.SetValue(i + jsArrayLength, CfrV8Value.CreateString(friends[i]));
        }


        jsArray = newArray;
    }


    //return the array to js context

    args.SetReturnValue(jsArray);

    //in js context, use code "my.getArrayFromCSharp()" will get an array like ["Mr.JSON", "Mr.Lee", "Mr.BONG"]
};

//add a function getObjectFromCSharp, this function has no arguments, but it will return a Object to js context.
var getObjectFormCSFunc = myObject.AddFunction("getObjectFromCSharp");
getObjectFormCSFunc.Execute += (func, args) =>
{
    //create the CfrV8Value object and the accssor of this Object.
    var jsObjectAccessor = new CfrV8Accessor();
    var jsObject = CfrV8Value.CreateObject(jsObjectAccessor);

    //create a CfrV8Value array
    var jsArray = CfrV8Value.CreateArray(friends.Length);

    for (int i = 0; i < friends.Length; i++)
    {
        jsArray.SetValue(i, CfrV8Value.CreateString(friends[i]));
    }

    jsObject.SetValue("libName", CfrV8Value.CreateString("NanUI"), CfxV8PropertyAttribute.ReadOnly);
    jsObject.SetValue("friends", jsArray, CfxV8PropertyAttribute.DontDelete);


    args.SetReturnValue(jsObject);

    //in js context, use code "my.getObjectFromCSharp()" will get an object like { friends:["Mr.JSON", "Mr.Lee", "Mr.BONG"], libName:"NanUI" }
};

运转项目开辟CEF的DevTools窗口,在Console中输入my,就能见到my目的的详细信息。

图片 1

执行my.showCSharpMessageBox(“SOME TEXT FROM
JS”)
命令,将调用C#的MessageBox来具体JS函数中提供的“SOME TEXT FROM
JS”字样。

执行my.getArrayFromCSharp()能够从C#中取到我们放手的字符串数组中的多少个字符串。假若在函数中指定了一个数组作为参数,那么指定的这一个数组将和C#的字符串数组合并。

> my.getArrayFromCSharp()
["Mr.JSON", "Mr.Lee", "Mr.BONG"]

> my.getArrayFromCSharp(["Js_Bison", "Js_Dick"])
["Js_Bison", "Js_Dick", "Mr.JSON", "Mr.Lee", "Mr.BONG"]

执行my.getObjectFromCSharp()能够从C#重临我们拼装的目标,该目的有一个字符型的libName特性,以及一个字符串数组friends

> my.getObjectFromCSharp()
Object {libName: "NanUI", friends: Array(3)}

 

回调函数

回调函数是Javascript里面首要和常用的效应,要是您在JS环境中登记的措施具有函数型的参数(即回调函数),通过Execute事件的Arguments能够获取回调的function,并动用CfrV8Value的ExecuteFunction来举办回调。

//add a function with callback function

var callbackTestFunc = GlobalObject.AddFunction("callbackTest");
callbackTestFunc.Execute += (func,args)=> {
    var callback = args.Arguments.FirstOrDefault(p => p.IsFunction);
    if(callback != null)
    {
        var callbackArgs = CfrV8Value.CreateObject(new CfrV8Accessor());
        callbackArgs.SetValue("success", CfrV8Value.CreateBool(true), CfxV8PropertyAttribute.ReadOnly);
        callbackArgs.SetValue("text", CfrV8Value.CreateString("Message from C#"), CfxV8PropertyAttribute.ReadOnly);

        callback.ExecuteFunction(null, new CfrV8Value[] { callbackArgs });
    }
};

在Console中执行callbackTest(function(result){ console.log(result);
})
将推行匿名回调,并拿到到C#回传的result对象。

> callbackTest(function(result){ console.log(result); })
Object {success: true, text: "Message from C#"}

在大部状态下,在Javascript中回调都是因为执行了部分异步的操作,那么一旦这几个异步的操作是在C#推行也是行得通的,只是实现起来就相比较复杂。上面将演示如何促成一个异步回调。

//add a function with async callback
var asyncCallbackTestFunc = GlobalObject.AddFunction("asyncCallbackTest");
asyncCallbackTestFunc.Execute += async (func, args) => {
//save current context
var v8Context = CfrV8Context.GetCurrentContext();
var callback = args.Arguments.FirstOrDefault(p => p.IsFunction);

//simulate async methods.
await Task.Delay(5000);

if (callback != null)
{
    //get render process context
    var rc = callback.CreateRemoteCallContext();

    //enter render process
    rc.Enter();

    //create render task
    var task = new CfrTask();
    task.Execute += (_, taskArgs) =>
    {
        //enter saved context
        v8Context.Enter();

        //create callback argument
        var callbackArgs = CfrV8Value.CreateObject(new CfrV8Accessor());
        callbackArgs.SetValue("success", CfrV8Value.CreateBool(true), CfxV8PropertyAttribute.ReadOnly);
        callbackArgs.SetValue("text", CfrV8Value.CreateString("Message from C#"), CfxV8PropertyAttribute.ReadOnly);

        //execute callback
        callback.ExecuteFunction(null, new CfrV8Value[] { callbackArgs });


        v8Context.Exit();

        //lock task from gc
        lock (task)
        {
            Monitor.PulseAll(task);
        }
    };

    lock (task)
    {
        //post task to render process
        v8Context.TaskRunner.PostTask(task);
    }

    rc.Exit();

    GC.KeepAlive(task);
}

在Console中执行asyncCallbackTest(function(result){
console.log(result);
})
将推行匿名回调,大约5秒后拿走到C#回传的result对象。

> asyncCallbackTest(function(result){ console.log(result); })
Object {success: true, text: "Message from C#"}

以上,您已经简单明白了使用NanUI咋办到C#和Javascript的交互通信。NanUI基于开源项目ChromiumFX开发,由此C#与Javascript的竞相与ChomiumFX保持一致,如若需要开销尤其错综复杂的效用,请自行检索和参照ChromiumFX的相干API及示范。

三、窗口绑定

以身作则源码

git clone https://github.com/NetDimension/NanUI-Examples-04-Communicate-Between-CSharp-And-JS.git

 窗口绑定允许客户端应用程序系上一个值到窗口的window对象上,窗口绑定的实现利用CefRenderProcessHandler::OnContextCreated()函数。

社群和协理

GitHub
https://github.com/NetDimension/NanUI/

交流群QQ群
521854872

援救作者

假如您欢喜自己的劳作,并且期待NanUI持续的升华,请对NanUI项目展开援救以此来鼓励和帮助自己连续NanUI的支出工作。你可以动用微信或者支付宝来围观上边的二维码举办扶助。

图片 2

如:

void MyRenderProcessHandler::OnContextCreated(
    CefRefPtr<CefBrowser> browser,
    CefRefPtr<CefFrame> frame,
    CefRefPtr<CefV8Context> context) {
  // Retrieve the context's window object.
  CefRefPtr<CefV8Value> object = context->GetGlobal();

  // Create a new V8 string value. See the "Basic JS Types" section below.
  CefRefPtr<CefV8Value> str = CefV8Value::CreateString("My Value!");

  // Add the string to the window object as "window.myval". See the "JS Objects" section below.
  object->SetValue("myval", str, V8_PROPERTY_ATTRIBUTE_NONE);
}

JavaScript框架可以与之相互的窗口绑定。

<script language="JavaScript">
alert(window.myval); // Shows an alert box with "My Value!"
</script>

窗口绑定是历次重复加载一个框架加载给客户端应用程序在必要时更改绑定的机遇。例如,不同的框架通过改动绑定框架的窗口对象值可以访问不同的特征。

四、扩展

扩充像window绑定一样除了为每个框架
加载到上下文之外,一旦加载就无法修改,当一个扩大已经加载并总结在壮大加载中走访DOM就会现身DOM不存在的crash。扩展应该在CefRenderProcessHandler::OnWeb基特Initialized()函数中应用CefRegisterExtension函数注册。

void MyRenderProcessHandler::OnWebKitInitialized() {
  // Define the extension contents.
  std::string extensionCode =
    "var test;"
    "if (!test)"
    " test = {};"
    "(function() {"
    " test.myval = 'My Value!';"
    "})();";

  // Register the extension.
  CefRegisterExtension("v8/test", extensionCode, NULL);
}

通过extensionCode描述的字符串可以是其余有效的代码,JS框架可以和扩展代码举办交互

<script language="JavaScript">
alert(test.myval); // Shows an alert box with "My Value!"
</script>

五、基本JS类型

CEF扶助要旨数据类型的开创,包括:undefined, null, bool, int, double,
date 和
string.这一个主旨数据类型使用CefV8Value::Create*()类别静态函数创立。如创造一个JS字符串:CefRefPtr<CefV8Value> str = CefV8Value::CreateString(“My
Value!”);

要旨数据类型可在另外地点创设和在所提到的前后文中不用起先化。如:

CefRefPtr<CefV8Value> val = …;
if (val.IsString())
{ // The value is a string. }

使用Get*Value()连串函数获取值:CefString strVal = val.GetStringValue();

六、JS数组

拔取CefV8Value::CreateArray()静态函数并传递一个长短作为参数创造数组。数组只可以在上下文内部成立并应用。如:

CefRefPtr<CefV8Value> arr = CefV8Value::CreateArray(2);

 值赋给一个数组使用SetValue()方法的变体,以一个索引作为首个参数。
arr->SetValue(0, CefV8Value::CreateString(“My First
String!”));
arr->SetValue(1, CefV8Value::CreateString(“My Second
String!”));

IsArray()函数测试CefV8Value是否为数组,GetArrayLength()函数获取数据的长短,从数组中取得一个值使用GetValue()变体函数。

七、JS对象

行使CefV8Value::CreateObject静态函数可带一个可选的CefV8Accessor参数创立JS对象。对象也只可以在js上下文中创立并选取。

 CefRefPtr<CefV8Value> obj = CefV8Value::CreateObject(NULL);

应用SetValue()变体函数并以字符串key作为第一参数给指标分配值。

八、对象的访问者

JS对象可挑选使用一个与之提到的CefV8Accessor以提供一个源生的getting和setting值的落实。
CefRefPtr<CefV8Accessor> accessor = …;
CefRefPtr<CefV8Value> obj = CefV8Value::CreateObject(accessor);

CefV8Accessor接口的一个兑现,必须由客户端应用程序提供。

class MyV8Accessor : public CefV8Accessor {
public:
  MyV8Accessor() {}

  virtual bool Get(const CefString& name,
                   const CefRefPtr<CefV8Value> object,
                   CefRefPtr<CefV8Value>& retval,
                   CefString& exception) OVERRIDE {
    if (name == "myval") {
      // Return the value.
      retval = CefV8Value::CreateString(myval_);
      return true;
    }

    // Value does not exist.
    return false;
  }

  virtual bool Set(const CefString& name,
                   const CefRefPtr<CefV8Value> object,
                   const CefRefPtr<CefV8Value> value,
                   CefString& exception) OVERRIDE {
    if (name == "myval") {
      if (value.IsString()) {
        // Store the value.
        myval_ = value.GetStringValue();
      } else {
        // Throw an exception.
        exception = "Invalid value type";
      }
      return true;
    }

    // Value does not exist.
    return false;
  }

  // Variable used for storing the value.
  CefString myval_;

  // Provide the reference counting implementation for this class.
  IMPLEMENT_REFCOUNTING(MyV8Accessor);
};

为了将值传递给访问者必须运用SetValue()变体函数设置,接受AccessControl和PropertyAttribute参数

九、JS函数

CEF协理JS函数创立和本土实现,