ClearScript中动态更新脚本全局变量的正确方法

问题背景

在使用ClearScript库进行.NET与脚本引擎交互时，开发者可能会遇到一个常见问题：当尝试通过AddHostObject方法更新已存在的全局变量时，发现脚本中访问的仍然是旧值。这种现象在Windows Script引擎（如VBScriptEngine）中尤为明显。

现象分析

考虑以下典型场景：

1. 开发者首先创建一个XmlDocument对象doc1，并通过AddHostObject将其作为"page"变量添加到脚本引擎
2. 脚本访问"page"变量并正确显示doc1的内容
3. 开发者随后创建另一个XmlDocument对象doc2，并尝试用相同的名称"page"更新脚本引擎中的变量
4. 脚本再次访问"page"变量时，却仍然得到doc1的内容

技术原理

这种现象源于Windows Script引擎对"host item"（宿主项）的特殊处理机制。当使用AddHostObject或AddHostType方法时，实际上创建的是一个宿主项，而非普通的脚本变量。宿主项有以下关键特性：

1. 一次性初始化：引擎在脚本第一次访问宿主项时获取其值，之后会缓存该值
2. 不可变性：引擎假设宿主项在其生命周期内不会改变
3. 特殊用途设计：宿主项主要用于暴露主机API接口，而非作为可变数据容器

解决方案

要实现在脚本中动态更新全局变量，应避免使用AddHostObject，转而使用ScriptEngine.Global属性的SetProperty方法。这种方法会创建标准的脚本全局变量，具有以下优势：

1. 动态更新：可以随时修改变量的值
2. 常规行为：遵循脚本语言的标准变量处理规则
3. 更广泛适用：适用于需要频繁更新的数据场景

最佳实践示例

' 创建脚本引擎
Dim Script As VBScriptEngine = New VBScriptEngine(WindowsScriptEngineFlags.EnableDebugging)

' 第一个文档
Dim doc1 As XmlDocument = New XmlDocument()
doc1.LoadXml("<root id=""A""><page id=""1""/></root>")
Script.Global.SetProperty("page", doc1.DocumentElement)
Script.Execute("console.write(page.attributes(""id"").value)") ' 输出 A

' 第二个文档
Dim doc2 As XmlDocument = New XmlDocument()
doc2.LoadXml("<root id=""B""><page id=""2""/></root>")
Script.Global.SetProperty("page", doc2.DocumentElement)
Script.Execute("console.write(page.attributes(""id"").value)") ' 输出 B

使用场景建议

1. 宿主项(AddHostObject)：

   • 适合暴露静态API接口
   • 适合长期不变的核心功能对象
   • 需要利用特殊功能如GlobalMembers时

2. 全局变量(SetProperty)：

   • 适合频繁变化的数据
   • 需要动态更新的业务对象
   • 临时性的脚本变量

总结

理解ClearScript中宿主项与普通全局变量的区别对于开发稳定的脚本集成应用至关重要。当需要动态更新脚本中的对象时，应优先考虑使用Global.SetProperty方法而非AddHostObject。这种选择不仅解决了变量更新的问题，也使代码行为更符合常规脚本开发的预期。