29、探索 Stitch 语言与应用脚本编程

探索 Stitch 语言与应用脚本编程

1. Stitch 语言：托管语言的 DSL

Stitch 是一种领域特定语言（DSL），它能够让语言托管更加声明式，并且减少与底层 .NET 和 DLR 平台的耦合。Stitch 语言具备声明性和平台独立性，可按顺序或并行运行基于 DLR 和非 DLR 的语言代码。

1.1 运行基于 DLR 的语言代码

要将语言接入 Stitch 运行时，需实现 IScript 接口。对于像 IronPython 和 IronRuby 这类基于 DLR 的语言，由于 DLR 托管 API 提供了统一的代码执行方式，所以只需一个 IScript 接口的实现，就能将这些语言接入 Stitch 运行时。Stitch 运行时自带 DlrScript 类，它为所有基于 DLR 的语言实现了 IScript 接口。

以下是 IScript 接口的定义：

public interface IScript
{
    IDictionary<String, object> Execute(IDictionary<String, object> scope);
}

DlrScript 类的 Execute 方法如下：

public IDictionary<String, object> Execute(IDictionary<String, object> dictionary)
{
    ScriptScope scope = runtime.CreateScope();
    foreach (var item in dictionary)
        scope.SetVariable(item.Key, item.Value);

    ScriptEngine engine;
    lock (runtime)
    {
        engine = runtime.GetEngine(lang);
    }
    ScriptSource source = engine.CreateScriptSourceFromString(code,
        SourceCodeKind.Statements);
    source.Execute(scope);
    IDictionary<String, object> result = new Dictionary<String, object>();
    foreach (var item in scope.GetItems())
        result.Add(item.Key, item.Value);

    return result;
}

在 Execute 方法中创建新的 ScriptScope 实例，意味着在多个 Stitch 函数执行时不会共享单个 ScriptScope 对象。这很重要，因为 Stitch 函数可以并行运行，而 ScriptScope 类并非线程安全的。不过，从字典对象到 ScriptScope 对象的变量复制是浅复制，即只复制对象引用，不创建新的变量实例。Stitch 语言采用函数式编程范式，要求并行运行的 Stitch 函数只产生新结果，不修改输入变量，这样变量只读，可安全地在多线程间共享。

1.2 语言插件

Stitch 运行时对基于 DLR 的语言有内置支持，若要支持非 DLR 语言，需为这些语言提供 Stitch 插件。下面以 PowerShell 插件为例，介绍如何开发 Stitch 插件以及插件机制的工作原理。

开发 Stitch 插件需实现 ILanguagePlugin 和 IScript 两个接口。以下是实现 IScript 接口的 PowerShellScript 类：

class PowerShellScript : IScript
{
    private string code;
    private string returnValue;

    public PowerShellScript(string code, string returnValue)
    {
        this.code = code;
        this.returnValue = returnValue;
    }

    public IDictionary<String, object> Execute(IDictionary<String, object> scope)
    {
        Runspace runspace = RunspaceFactory.CreateRunspace();
        runspace.Open();
        Pipeline pipeline = runspace.CreatePipeline();
        pipeline.Commands.AddScript(code);
        Collection<PSObject> results = pipeline.Invoke();
        runspace.Close();
        IDictionary<String, object> result = new Dictionary<String, object>();
        result.Add(returnValue, results);
        return result;
    }
}

ILanguagePlugin 接口定义如下：

public interface ILanguagePlugin
{
    IList<string> FileExtensions { get; }
    IList<string> LanguageNames { get; }
    IScript CreateScript(Ast.IFunction function);
}

PowerShellPlugin 类实现了 ILanguagePlugin 接口：

public class PowerShellPlugin : ILanguagePlugin
{
    private IList<string> fileExtensions = new List<string>(new string[] { ".ps" });
    private IList<string> languageNames = new List<string>(new string[] { "PowerShell" });

    public IList<string> FileExtensions
    {
        get { return fileExtensions; }
    }

    public IList<string> LanguageNames
    {
        get { return languageNames; }
    }

    public IScript CreateScript(IFunction function)
    {
        String returnValue = null;
        if (function.ReturnValues.Count > 0)
            returnValue = function.ReturnValues[0];

        return new PowerShellScript(function.Code, returnValue);
    }
}

1.3 配置插件

要使用 PowerShell 插件，需将其注册到 Stitch 运行时，有两种方式：

• 代码方式 ：

StitchScriptEngine engine = new StitchScriptEngine(
    ExecutionMode.Sequential, new ILanguagePlugin[] { new PowerShellPlugin() });

• 配置文件方式 ：在 App.config 文件中进行配置，示例如下：

<microsoft.scripting>
  <languages>
    …
    <language names="Stitch"
              extensions=".st"
              displayName="Stitch 1.0"
              type="Stitch.StitchContext, Stitch, Version=1.0.0.0, Culture=neutral" />
  </languages>
  <options>
    <set option="plugin" language="Stitch"  
         value="PowerShellStitchPlugin.PowerShellPlugin,  
                PowerShellStitchPlugin, Version=1.0.0.0, Culture=neutral" />
    <set option="executionMode" language="Stitch" value="ParallelNoWait" />
  </options>
</microsoft.scripting>

2. 应用脚本编程：Ball World 应用

应用脚本编程允许用户通过编写脚本来控制应用程序的行为，例如自动化日常任务、添加新功能或自定义现有功能等。下面以 Ball World 应用为例进行说明。

2.1 Ball World 应用概述

Ball World 是一个简单的独立应用程序，模拟了一个由不同颜色和大小的球组成的二维世界，四周有四面无形的墙。球在这个世界中移动，直到撞到墙或其他球，碰撞时会改变运动方向。该应用是一个 WPF 应用程序，还使用了 Farseer Physics 库来检测球与球、球与墙之间的碰撞。

2.2 软件要求

要运行 Ball World 应用，需要 Farseer Physics 库的编译二进制文件，设置步骤如下：
1. 从 CodePlex 网站 下载 Farseer Physics 源代码，使用版本 2.1.3，因为后续的 3.0 版本与 2.1.3 版本有很大差异且不向后兼容。由于运行环境是 WPF，应下载 “Farseer Physics 2.1.3 Class Library” 包，并解压到 C:\Farseer Physics 2.1.3 Class Library 文件夹（若使用其他文件夹，需相应调整后续步骤）。
2. 在 Visual Studio C# 2010 Express 中打开 FarseerPhysics.csproj 文件，由于该文件是旧版本的 Visual Studio 文件，会提示将其转换为 Visual Studio C# 2010 Express 能理解的格式，完成转换后，在 Visual Studio 的解决方案资源管理器中会看到 FarseerPhysics 项目。
3. 构建 FarseerPhysics 项目，编译后的二进制文件将放在 C:\Farseer Physics 2.1.3 Class Library\bin\Debug 文件夹中，将该文件夹中的所有文件复制到 C:\ProDLR\lib\FaseerPhysics\Debug 文件夹即可。

2.3 应用架构

Ball World 是一个 WPF 应用程序，采用了 MVVM（Model-View-ViewModel）模式来构建应用程序的用户界面层。MVVM 模式与 MVC（Model-View-Controller）模式类似，由模型（Model）、视图（View）和视图模型（ViewModel）三部分组成。对于 Ball World 这样的简单应用，将模型和视图模型合并为一个单一的对象模型。

2.4 应用对象模型

Ball World 应用的核心是一个对象模型，包含表示球和球世界的类。其中， BallWorldViewModel 类最为重要，它模拟了球的世界，包含一个私有成员变量 balls 用于存储球，每个球是 BallViewModel 类的实例。

以下是 BallWorldViewModel 类的代码：

public class BallWorldViewModel
{
    private BallWorldPhysicsEngine physicsEngine = new BallWorldPhysicsEngine();
    private ObservableCollection<BallViewModel> balls;

    public BallWorldViewModel()
    {
        balls = new ObservableCollection<BallViewModel>();
        BorderViewModel border = new BorderViewModel(
            720f, 520f, 60, new Vector2(400f, 300f));
        physicsEngine.AddBorder(border);
        physicsEngine.Start();
        RunInitScript();
    }

    public ObservableCollection<BallViewModel> Balls
    {
        get { return balls; }
    }

    public void AddBall(Color color, float radius,  
                        float x, float y, float speedx, float speedy)
    {
        BallViewModel ball = new BallViewModel(color, radius,  
            new Vector2D(x, y), new Vector2D(speedx, speedy));
        balls.Add(ball);
        physicsEngine.AddBall(ball);
    }

    private void RunInitScript()
    {
        ScriptRuntime scriptRuntime = ScriptRuntime.CreateFromConfiguration();
        scriptRuntime.Globals.SetVariable("world", this);
        ScriptScope scope = scriptRuntime.ExecuteFile(@"Script\InitScript.py");
    }
}

AddBall 和 RunInitScript 方法使应用程序支持脚本编程。用户可以通过在 InitScript.py 文件中编写 Python 代码来定制 Ball World 应用，定义球的颜色、位置和速度。 RunInitScript 方法使用 DLR 托管 API 加载 InitScript.py 文件，并在脚本作用域中将变量名 “world” 绑定到表示球世界的 BallWorldViewModel 实例，这样 Python 代码就可以通过调用 AddBall 方法向球世界添加球。

为使脚本运行时支持 IronPython，需在 BallWorld 项目的 App.config 文件中添加以下代码：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="microsoft.scripting"
        type="Microsoft.Scripting.Hosting.Configuration.Section, Microsoft.Scripting,  
        Version=1.0.0.0, Culture=neutral" />
  </configSections>
  <microsoft.scripting>
    <languages>
      <language names="IronPython,Python,py"
                extensions=".py"
                displayName="IronPython 2.6.1"
                type="IronPython.Runtime.PythonContext,IronPython,  
Version=2.6.10920.0, Culture=neutral" />
    </languages>
  </microsoft.scripting>
</configuration>

总结

通过上述内容，我们了解了 Stitch 语言的工作原理，包括如何运行基于 DLR 的语言代码、开发语言插件以及配置插件。同时，还学习了应用脚本编程的概念，并通过 Ball World 应用示例，掌握了如何使用 DLR 托管 API 加载和运行自定义脚本，实现应用程序的定制化。这些技术为开发更灵活、可扩展的应用程序提供了有力的支持。

3. 技术点分析与对比

3.1 Stitch 语言相关技术点

• 接口的作用 ： IScript 和 ILanguagePlugin 接口是 Stitch 运行时与语言插件之间的契约。 IScript 接口用于执行特定语言的代码，而 ILanguagePlugin 接口则提供了语言的文件扩展名、名称等信息，方便 Stitch 运行时查找合适的插件。
  | 接口名称 | 作用 | 关键方法 |
  | ---- | ---- | ---- |
  | IScript | 执行特定语言代码 | Execute |
  | ILanguagePlugin | 提供语言信息，创建脚本实例 | FileExtensions 、 LanguageNames 、 CreateScript |

• 变量复制问题 ：在 DlrScript 类的 Execute 方法中，变量从字典对象到 ScriptScope 对象的复制是浅复制。这虽然避免了共享 ScriptScope 对象带来的线程安全问题，但可能导致变量引用的共享。不过，由于 Stitch 语言采用函数式编程范式，要求输入变量只读，所以在一定程度上解决了线程同步问题。

3.2 Ball World 应用相关技术点

• MVVM 模式 ：Ball World 应用采用 MVVM 模式构建用户界面层。与传统的 MVC 模式相比，MVVM 模式利用了 WPF 提供的数据绑定等功能，将视图和模型分离，提高了代码的可维护性和可测试性。
  | 模式名称 | 组成部分 | 特点 |
  | ---- | ---- | ---- |
  | MVC | 模型、视图、控制器 | 广泛应用于非 WPF UI 应用 |
  | MVVM | 模型、视图、视图模型 | 适用于 WPF 应用，利用数据绑定 |

• DLR 托管 API 的使用 ：在 BallWorldViewModel 类的 RunInitScript 方法中，使用 DLR 托管 API 加载和运行 Python 脚本。通过将 BallWorldViewModel 实例绑定到脚本作用域中的 “world” 变量，Python 代码可以调用 AddBall 方法向球世界添加球，实现了应用程序的定制化。

4. 操作流程总结

4.1 Stitch 语言插件开发与配置流程

graph LR
    A[实现 IScript 接口] --> B[实现 ILanguagePlugin 接口]
    B --> C{选择注册方式}
    C -->|代码方式| D[创建 StitchScriptEngine 实例并传入插件]
    C -->|配置文件方式| E[在 App.config 文件中配置插件信息]

具体步骤如下：
1. 实现 IScript 接口，编写执行特定语言代码的逻辑。
2. 实现 ILanguagePlugin 接口，提供语言的文件扩展名、名称等信息，并创建脚本实例。
3. 选择注册方式：
- 代码方式：创建 StitchScriptEngine 实例，并将插件实例传入构造函数。
- 配置文件方式：在 App.config 文件中添加插件的相关配置信息。

4.2 Ball World 应用搭建与定制流程

graph LR
    A[下载并配置 Farseer Physics 库] --> B[采用 MVVM 模式构建应用架构]
    B --> C[实现 BallWorldViewModel 类]
    C --> D[编写 InitScript.py 脚本]
    D --> E[在 App.config 文件中配置 IronPython 支持]

具体步骤如下：
1. 从 CodePlex 网站 下载 Farseer Physics 源代码（版本 2.1.3），解压并编译，将编译后的二进制文件复制到指定文件夹。
2. 采用 MVVM 模式构建 Ball World 应用的用户界面层，将模型和视图模型合并为一个单一的对象模型。
3. 实现 BallWorldViewModel 类，包含 AddBall 和 RunInitScript 方法，使应用程序支持脚本编程。
4. 编写 InitScript.py 脚本，通过调用 AddBall 方法向球世界添加球，实现应用程序的定制化。
5. 在 App.config 文件中添加配置信息，使脚本运行时支持 IronPython。

展望

Stitch 语言和应用脚本编程为开发更灵活、可扩展的应用程序提供了强大的工具。未来，可以进一步探索以下方面：
- 更多语言支持 ：为 Stitch 语言开发更多的语言插件，支持更多的非 DLR 语言，如 JavaScript、Java 等，扩大 Stitch 语言的应用范围。
- 脚本功能扩展 ：在 Ball World 应用中，除了添加球的功能，还可以扩展脚本的功能，如修改球的运动规则、添加新的物理效果等，提高应用程序的趣味性和可玩性。
- 性能优化 ：针对 Stitch 语言和 Ball World 应用，进行性能优化，如优化变量复制方式、减少脚本执行时间等，提高应用程序的运行效率。