C#执行代码块js脚本

一、背景

在低代码平台中为了扩展功能，我们在业务编排中会扩展代码块的功能，允许用户直接在界面中进行代码（Node.js、 Python）的编写，来实现取数或者赋值的一些功能，类似某某云效果：

二、代码实现

.Net执行js的框架有很多，大致分为两类1、浏览器内核/无头浏览器，2、Js引擎/框架。主要区别是前者模拟浏览器去请求一个完整的网页，后者则是单单去计算调用一个纯粹的js方法，我更倾向于后者。
以下介绍几种常见的Js引擎框架：
● Microsoft.AspNetCore.NodeServices (接口方法已标注过时，后续有可能不会在.net 新版本中支持)
● Microsoft.ClearScript (主要是使用v8引擎)
● JavaScriptEngineSwitcher.ChakraCore (使用的ChakraCore引擎)

1、NodeServices

1.1 前提

● Nodejs环境
● 脚本需要按照Nodejs的模块导出的格式将方法写成导出的形式

1.2 安装

在项目中引入 NuGet 包：Microsoft.AspNetCore.NodeServices ,这里我使用的是 3.1.23版

1.3 实现

服务注入
修改 Startup 类，在 ConfigureServices 方法中添加下面代码：

public void ConfigureServices(IServiceCollection services)
{
    ...
    services.AddNodeServices();
}

创建js文件
项目的根目录创建jsfiles文件夹，文件中中创建一个名为 hello.js 的脚本文件，文件的属性中的「复制到输出目录」设置为「始终复制」，文件的内容如下

module.exports = function (callback, name) {
  var msg = "Hello " + name;
  callback(null, msg);
};

控制器实现
控制器的构造中依赖注入INodeServices服务,使用InvokeAsync执行js文件

[ApiController]
[Route("[controller]")]
public class NodeServicesController : ControllerBase
{
    private readonly INodeServices _nodeServices;
    public NodeServicesController(INodeServices nodeServices)
    {
        _nodeServices = nodeServices;
    }

    [HttpGet]
    public async Task<IActionResult> Get()
    {
        var result = await _nodeServices.InvokeAsync<string>("./jsfiles/hello.js", "nodeServices");
        return Ok(result);
    }
}

1.4 运行效果

2、ClearScript

2.1 优点

● 支持原生js编写
● 支持直接执行js字符串

2.2 安装

在项目中引入 NuGet 包：Microsoft.ClearScript,这里我使用的是 7.2.3版

2.3 实现

调用脚本支持加载脚本文件和加载脚本字符串
加载脚本文件
调用engine.ComplieDocument方法直接加载js文件，然后调用engine.Execute将引入的脚本执行一遍，这样后面就可以调用js方法，say就是js的方法名，调用格式与js相同。

V8Script script = engine.CompileDocument("./jsfiles/hellojs.js");   // 载入并编译js文件, 然后Execute, 就可以直接调用。 
engine.Execute(script); 
var result = engine.Script.say("clearScript");　　

加载脚本字符串
直接调用engine.Execute将引入的脚本执行一遍

string jsText = @"function say(name){
                    return 'Hello '+ name;    
                }";
engine.Execute(jsText); 
var result = engine.Script.say("clearScript");　　

最终代码

[ApiController]
[Route("[controller]")]
public class ClearScriptController : ControllerBase
{
    public ClearScriptController()
    {
    }

    [HttpGet]
    public async Task<IActionResult> Get()
    {
        string jsText = @"function say(name){
                            return 'Hello '+name;    
                        }";
        using (var engine = new V8ScriptEngine())
        {
            engine.DocumentSettings.AccessFlags = Microsoft.ClearScript.DocumentAccessFlags.EnableFileLoading;
            engine.DefaultAccess = Microsoft.ClearScript.ScriptAccess.Full;
            //V8Script script = engine.CompileDocument("./jsfiles/hellojs.js");   // 载入并编译js文件。
            engine.Execute(jsText);  //直接执行js字符串
            var result = engine.Script.say("clearScript");  //执行方法
            return Ok(result);
        }
    }
}

2.4 运行效果

3、ChakraCore

3.1 优点

● 支持原生js编写
● 支持直接执行js字符串

3.2 安装

在项目中引入 NuGet 包：JavaScriptEngineSwitcher.ChakraCore

另外还需要安装的类库：（否则会执行报错）
JavaScriptEngineSwitcher.ChakraCore.Native.linux-x64 ///针对Linux-x64环境下组件；
JavaScriptEngineSwitcher.ChakraCore.Native.win-x64 //针对Wind-x64环境下组件；
JavaScriptEngineSwitcher.ChakraCore.Native.win-x32 //针对Wind-x32环境下组件；

3.3 实现

与ClearScript逻辑一样先把js文件执行一遍，然后再去调用要使用的方法。

engine.Execute(jsText);
string result = engine.CallFunction<string>("say", "chakraCoreJs");　

最终代码

[ApiController]
[Route("[controller]")]
public class ChakraCoreController : ControllerBase
{
    public ChakraCoreController()
    {
    }

    [HttpGet]
    public async Task<IActionResult> Get()
    {
        string jsText = @"function say(name){
                            return 'Hello '+name;    
                        }";
        IJsEngineSwitcher engineSwitcher = JsEngineSwitcher.Current;
        engineSwitcher.EngineFactories.Add(new ChakraCoreJsEngineFactory());
        engineSwitcher.DefaultEngineName = ChakraCoreJsEngine.EngineName;
        using (IJsEngine engine = JsEngineSwitcher.Current.CreateDefaultEngine())
        {
            engine.Execute(jsText);
            string result = engine.CallFunction<string>("say", "chakraCoreJs");
            return Ok(result);
        }

    }
}

3.4 运行效果

三、总结

以上三种框架特性：
● ClearScript、ChakraCore：原始js，支持直接执行脚本字符串
● NodeServices：植入Nodejs对象原则上执行会更快，需要Nodejs语法，只支持执行脚本文件

具体使用哪一种，需要根据业务功能如何实现来定，由于NodeServices不支持读取字符串且编写格式有要求，对于某某云的这种设置效果，猜测是用后面两种方式，即特定脚本头+代码块设置区域js+特定脚本尾
function dojs(input){
//中间拼接代码块的设置,input 获取入参，output作为出参

return output;
}
最后程序通过调用engine.Script.dojs(表单数据对象);将表单数据传入脚本作为input入参，并获取output输出。

代码实现（ClearScript方式）：
如程序执行js脚本，将用户对象的手机号中间四位加密

[HttpGet()]
public async Task<IActionResult> Get()
{
    string mobile = "13812345678";
    string jsTextPrefix = "function dojs(input){";   -- 脚本头
    string jsTextPostfix = "return output;}";		 -- 脚本尾
    //代码块设置区域内容
    var jsContent = @"var tel = input.Mobile;           //获取入参对象
                      var reg=/(\d{3})\d{4}(\d{4})/;	//业务逻辑，如手机号中间四位加密
                      var telnew = tel.replace(reg, '$1****$2');  
                      output = {'Mobile':telnew};       // 定义返回值格式
                      ";
    string jsText = jsTextPrefix + jsContent + jsTextPostfix;
    using (var engine = new V8ScriptEngine())
    {
        engine.DocumentSettings.AccessFlags = Microsoft.ClearScript.DocumentAccessFlags.EnableFileLoading;
        engine.DefaultAccess = Microsoft.ClearScript.ScriptAccess.Full;
        engine.Execute(jsText);  
        //数据对象作为入参
        var input = new
        {
            Mobile = mobile
        };
        var result = engine.Script.dojs(input);  //执行方法
        return Ok(JsonConvert.SerializeObject(result));
    }
}

效果：

git地址:NetCoreExecuteJs