与Javascript的竞相通信

NanUI文档目录

咋样贯彻C#与Javascript的交互通信

透过事先的篇章,相信您曾经对NanUI有了开班的垂询。但到近年来停止,我们接纳NanUI仅仅只是作为显示HTML界面的器皿,并未涉嫌CEF与C#间数据的相互。那么本文将简单介绍如何在NanUI中使用C#调用Javascript的函数以及怎么样在Javascript注入C#的靶子、属性和模式。

C#调用Javascript函数

不需要得到重临值的情事

假定页面中似乎下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函数。


需要取得重临值的景色

地点的例子中经过ExecuteJavascript措施来得逞调用了JS环境中的函数。但容易发现,这种调用形式C#是没有收取到其余重返值的。但实则的门类里,我们是内需从JS环境得到到再次来到值的,这时候使用ExecuteJavascript亚洲必赢bwin696.com,将无法满足要求,使用其它一个情势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间的通信都是由这多少个序列来完成的。


Javascript调用C#对象及情势

简言之的使用示范

位置的篇章中示范了哪些用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对象的详细消息。

亚洲必赢bwin696.com 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

社群和帮助

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

交流群QQ群
521854872

救助作者

倘使你喜欢自己的办事,并且期望NanUI持续的向上,请对NanUI项目开展帮忙以此来鼓励和支撑我连续NanUI的开销工作。你可以运用微信或者支付宝来围观下面的二维码举办帮忙。

亚洲必赢bwin696.com 2

相关文章