ClearScript.Manager 使用教程

1. 项目介绍

ClearScript.Manager 是一个轻量级的工具，旨在帮助开发者更有效地管理和调试JavaScript引擎，如V8和JScript。该项目由yuzd开发并维护，提供了一种简单易用的方式来探索、运行和测试JavaScript代码。ClearScript.Manager 主要用js作为sql的执行上下文，目前有sql、http、log三大组件，sql和log的执行器可以自由扩展。此外，js编辑器有remoteDebugger、代码智能提示、语法高亮、语法错误提示、智能搜索、代码收缩、打标签等功能。

2. 项目快速启动

2.1 安装

首先，通过NuGet安装ClearScript.Manager包：

Install-Package ClearScript.Manager

2.2 基本使用

以下是一个简单的示例，展示如何使用ClearScript.Manager来执行JavaScript代码：

using ClearScript.Manager;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // 初始化RuntimeManager
        var manager = new RuntimeManager(new ManagerSettings());

        // 执行JavaScript代码
        var result = await manager.ExecuteAsync("test", "var i = 0; i++;");

        // 输出结果
        Console.WriteLine(result);
    }
}

2.3 配置参数

ClearScript.Manager提供了多种配置参数，可以通过ManagerSettings类进行设置。例如：

var settings = new ManagerSettings
{
    MaxExecutableBytes = 1024 * 1024, // 最大可执行字节数
    ScriptTimeoutMilliSeconds = 5000, // 脚本超时时间（毫秒）
    RuntimeMaxCount = 10 // 最大同时运行的V8 Runtime数量
};

var manager = new RuntimeManager(settings);

3. 应用案例和最佳实践

3.1 在Web应用中使用

ClearScript.Manager可以用于在Web应用中执行动态JavaScript代码。例如，在ASP.NET Core中，可以通过以下方式集成：

public class JsExecutorService
{
    private readonly RuntimeManager _manager;

    public JsExecutorService(RuntimeManager manager)
    {
        _manager = manager;
    }

    public async Task<string> ExecuteScript(string script)
    {
        return await _manager.ExecuteAsync("dynamicScript", script);
    }
}

3.2 调试JavaScript代码

ClearScript.Manager支持远程调试功能，可以通过Visual Studio Code进行调试。首先，在Visual Studio Code中添加调试配置：

{
    "type": "node",
    "request": "attach",
    "name": "Attach to CSV8:9222 (Inspector)",
    "protocol": "inspector",
    "address": "127.0.0.1",
    "port": 9222
}

然后在代码中启用调试模式：

using (var engine = new V8ScriptEngine("debug-v8engine", V8ScriptEngineFlags.EnableDebugging | V8ScriptEngineFlags.AwaitDebuggerAndPauseOnStart, 9222))
{
    engine.Execute("var i = 0; i++;");
}

4. 典型生态项目

4.1 ClearScript.Manager.Http

ClearScript.Manager.Http 是一个扩展包，允许在JavaScript代码中进行HTTP请求。通过安装此包，可以在JavaScript中使用类似Node.js的request模块进行HTTP调用。

Install-Package ClearScript.Manager.Http

4.2 ClearScript.Manager.Sql

ClearScript.Manager.Sql 是另一个扩展包，允许在JavaScript代码中执行SQL查询。通过此包，可以将SQL查询与JavaScript代码无缝集成。

Install-Package ClearScript.Manager.Sql

通过这些扩展包，ClearScript.Manager可以更好地满足不同场景下的需求，提供更强大的功能支持。