C#NanUI文档 – 怎么着促成C#与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将不能够满意需求,使用另外一个措施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对象的详细音讯。

C# 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的支付工作。你可以拔取微信或者支付宝来围观上面的二维码进行接济。

C# 2

相关文章