使用CellReport实现dotnet集成js脚本功能

首先非常感谢老刀研发的CellReport解决了中小企业报表难的问题。

CellReport的官网地址：https://gitee.com/NoneDay/CellReport 欢迎小伙伴围观；对应的文档地址：http://noneday.gitee.io/cellreport/

CellReport强大的功能，不用我在这里赘述。用过的人都知道。

本文主要记录一下CellReport的脚本功能。

一直以来，都希望有一款趁手的脚本解析和执行器来满足自定义脚本功能，满足不同场景、不同功能的需求。

一个美好的周末，主动联系了一下CellReport的作者（老刀），在老刀热心的指点，不厌其烦的解答后，终于满足了我的小心愿。

言归正传，实现脚本功能的步骤如下：

• 创建.NET6的项目，并引入CellReport.dll和Antlr3.Runtime.dll；
• 单独表达式例子：创建ExprFaced2实例，并将参数传入calculate方法中；具体代码如下：

public static bool RunExpress(string express, out IDictionary<Object, Object> resDic)
{
    bool ok = false;
    resDic = new Dictionary<Object, Object>();
    try
    {
        var ef = new ExprFaced2();
        ef.addNewScopeForScript();
 9         var _env = new Env();
10         //固定要加的，脚本运行环境使用环境变量的时候，要找这个变量
11         ef.addVariable("__env__", _env);
        // 可以直接测试加法
13         //var tt = exprFaced.calculate("=1+2+4 ");
14         //var tt2 = exprFaced.calculate("=iif(11>2,true,false)");
15         var exec_result = ef.calculate($"{express} ;");
        if (exec_result is Exception ex)
        {
            ok = false;
            throw ex;
        }
        resDic = exec_result as IDictionary<Object, Object>;
        ok = true;
    }
    catch (Exception ex)
    {
        string err = ex.Message;
        throw;
    }
    return ok;
}

• 脚本例子，同上面不同的地方，我们需要事先定义好执行的脚本，然后再传入脚本对应的参数；

js脚本定义，本脚本定义了两个函数，其中main作为主函数，login_script做为子函数执行对应的业务逻辑

function login_script(userid, password) {
    var _password = password + '-----'
    return { errcode: 0, message: _password }
}
function main(userid, password) {
    return login_script(userid, password)
}

封装执行脚本RunScript方法，其中script为脚本内容；varDic为参数字典用户传递参数，并拼接主函数入口的参数个数；resDic为返回的结果字典；expFun为主函数入口；data_source为同数据库交互是指定的数据源（数据源名称、数据源连接串、数据库类型）

public static bool RunScript(string script, Dictionary<string, object> varDic, out IDictionary<Object, Object> resDic, string expFun = "main", DbSource data_source = null)
{
    bool ok = false;
    resDic = new Dictionary<Object, Object>();
    try
    {
        var exprFaced = new ExprFaced2();
        //addNewScopreForScipt是为了载入脚本的。里面的函数仅仅是被解析了，没有被执行
         exprFaced.addNewScopeForScript(script);
        var __env__ = new Env();
        // 如果需要数据库连接，则在此定义数据源
        if (data_source != null)
        {
            __env__.addDataSource(data_source.Name, data_source.ConnString, data_source.DbType, "0");
        }
        //固定要加的，脚本运行环境使用环境变量的时候，要找这个变量
        exprFaced.addVariable("env", __env__);
        exprFaced.addVariable("__env__", __env__);
        exprFaced.addVariable("_user_", null);
        string funParams = string.Empty;
        //加自己的预定义变量
        if (varDic != null && varDic.Count > 0)
        {
            foreach (var kv in varDic)
            {
                exprFaced.addVariable(kv.Key, kv.Value);
            }
            funParams = string.Join(",", varDic.Keys).ToString();
        }
        var exec_result = exprFaced.calculate("{ " + $"{expFun}({funParams});" + "\n}", new());
        if (exec_result is Exception ex)
        {
            ok = false;
            throw ex;
        }
        resDic = exec_result as IDictionary<Object, Object>;
        ok = true;
    }
    catch (Exception ex)
    {
        string err = ex.Message;
        throw;
    }
    return ok;
}

调用方法（非数据库交互的，不需要传递data_source）：

string test_user = "admin";
string test_password = Guid.NewGuid().ToString();
Dictionary<string, object> varDic = new Dictionary<string, object>();
varDic.Add("userid", test_user);
varDic.Add("password", test_password);
IDictionary<Object, Object> resDic = new Dictionary<Object, Object>();
var ok = ScriptRun.RunScript(script, varDic, out resDic);

调用成功我们就可以通过resDic获取对应的结果了。

• 同数据交互的脚本
  • 首先要在Startup.cs中注册数据库对应的dll
  • 如果用到kata，还需要注册Func_kata对应的执行函数；

具体看代码，我这里是winform应用，不过方式一样，没有区别

public static void Main(string[] args)
{
    try
    {
        //DbProviderFactories.RegisterFactory("MySql", MySqlClientFactory.Instance);
        //DbProviderFactories.RegisterFactory("Microsoft.Data.Sqlite", SqliteFactory.Instance);
           //此处的名称需要根据CellReportweb端中定义数据源时下拉框保持一致
        DbProviderFactories.RegisterFactory("SqlClient", SqlClientFactory.Instance);
           //如果需要用到kata脚本的时候才需要调用
        CreatHostBuilder(args).Build();
        ApplicationConfiguration.Initialize();
        Application.Run(new Form1());
    }
    catch (Exception)
    {
        throw;
    }
}
public static IHostBuilder CreatHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
    .ConfigureServices((hostContext, services) =>
    {
        CellReport.core.expr.ExprHelper.buildFuncMap();
        //CellReport.core.expr.ExprHelper.AddFunc(typeof(CellReport.function.Func_md5));
        //CellReport.core.expr.ExprHelper.AddFunc(typeof(CellReport.function.Func_qr_code));
        CellReport.core.expr.ExprHelper.AddFunc(typeof(CellReport.function.Func_kata));
        CellReport.core.expr.ExprHelper.AddFunc(typeof(CellReport.function.Func_kata_Variable));
    });

function main(dataSource, tableName, fieldNames) {
    var db = openDb(`${dataSource}`)
    var data = null
    if (fieldNames == null || fieldNames == '')
        data = db.select(`select * from  ${tableName} ;`)
    else 
        data = db.select(`select ${fieldNames}  from  ${tableName} ;`)
    db.close()
    return { data }
}

Dictionary<string, object> varDic = new Dictionary<string, object>();
varDic.Add("dataSource", SQL.Name);
varDic.Add("tableName", "iot_device");
varDic.Add("fieldNames", null);
IDictionary<Object, Object> resDic = new Dictionary<Object, Object>();
var ok = ScriptRun.RunScript(script, varDic, out resDic, "main", SQL);

SQL为DataSource，具体定义为：

DbSource SQL = new DbSource
{
    Name = "KIT",
    DbType = "SqlClient",
    ConnString = "Data Source=127.0.0.1;Initial Catalog=xx;Persist Security Info=True;User ID=sa;Password=xxx;Min Pool Size=1;Max Pool Size=50;Connect Timeout=15000;"
};

• kata脚本如下：，调用函数和方法同上面保持一致

function main(dataSource, tableName, fieldNames) {
    var db = kata(`${dataSource}`)
    var data = db
        .Query('iot_device')
        .Get()
        .select((x) => {
            return { id: x.id, device_name: x.device_name }
        })
    return { data }
}

注意事项：

• 对应依赖的dll的版本同CellReport例子中保持一致；
• 脚本的语法同js语法，变量定义var，每个语句必须要分号结束；具体的语法参考对应的文档：http://noneday.gitee.io/CellReport/zh/guide/lang.html#基础数据类型
• 在使用数据库功能时，需要增加其他的几个dll，包括：

<Reference Include="CellReport">
    <HintPath>.\libs\CellReport.dll</HintPath>
</Reference>
<Reference Include="Antlr3.Runtime">
    <HintPath>.\libs\Antlr3.Runtime.dll</HintPath>
</Reference>
<Reference Include="MySql.Data">
    <HintPath>.\libs\MySql.Data.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Data.Sqlite">
    <HintPath>.\libs\Microsoft.Data.Sqlite.dll</HintPath>
</Reference>
<Reference Include="SqlKata">
    <HintPath>.\libs\SqlKata.dll</HintPath>
</Reference>
<Reference Include="SqlKata.Execution">
    <HintPath>.\libs\SqlKata.Execution.dll</HintPath>
</Reference>
<Reference Include="Dapper">
    <HintPath>.\libs\Dapper.dll</HintPath>
</Reference>
<Reference Include="Humanizer">
    <HintPath>.\libs\Humanizer.dll</HintPath>
</Reference>

 如果要自定处理函数，参考如下：

 

 cs文件必须要以Func_开头，目前没有实际使用。