BeanShell:多线程环境下Interpreter解释器的优化使用

BeanShell是用 Java 编写的一个小型、免费、可嵌入的 Java 代码的脚本解释器。 BeanShell动态执行标准Java语法，并使用通用语法对其进行扩展 脚本编写便利性，适用于 Java 的轻量级脚本。本文说明在并发环境下对BeanShell更加优化的使用方式。

简单示例

如下是一个简单的使用BeanShell脚本解释执行脚本的示例：

	@Test
	public void testBsh() {
		try {
			/** 创建脚本解释器实例 */
			Interpreter interpreter = new Interpreter();  
			/** 定义脚本中引用的内置变量 */
			interpreter.set("name", "world");
			/** 执行脚本，脚本中访问内置对象的字段，保存运行结果到res */
			Object res = interpreter.eval("\"hello \"+ name");
			/** 输出hello world */
			System.out.println("res "+res);
			assertTrue("hello world".equals(res));
		} catch (EvalError e) {
			e.printStackTrace();
			assertFalse(true);
		}
	}

BeanShell官方的示例差不多都是这样的，看起来非常简单。

线程安全

在实际工程也可以如上使用，在我的项目中，我差不多也是这么用的。
但每次都创建一个Interpreter实例，这样真的有必要么？初步看了bsh.Interpreter的源码，其构造方法在构造实例时的逻辑还是有些复杂的。所以如果频繁的创建/销毁Interpreter实例其实是有不小的系统开销的。Interpreter实例可不可以在并发环境下由多线程复用呢？如果可以就只需要创建一个静态实例就可以了，岂不是更有效率？
所以,Interpreter实例是线程安全的（thread-safe）的么？如果是，那么上面的想法就是现实的。
带着这个问题我翻阅了BeanShell的官方文档，得到的答案是肯定的。

BeanShell is thread-safe internally, so as long as your scripts do not explicitly do anything ordinarily non-thread safe (e.g. access shared variables or objects) you can write multi-threaded scripts.

BeanShell 在内部是线程安全的，所以只要你的脚本不显式执行任何通常非线程安全的操作（例如访问共享）变量或对象），您可以编写多线程脚本。

摘自《Threads - Scripting Runnable》 https://beanshell.github.io/manual/interfaces.html#Threads_-_Scripting_Runnable

NameSpace（名字空间）

虽然bsh.Interpreter可以在并发环境下使用，但就上面示例而言并不是简单的将 interpreter定义成静态成员变就可以安全的让多线程共享interpreter实例的。
因为interpreter.set("name", "world");这行语句实际是在interpreter的全局名字空间(bsh.NameSpace)定义变量（即Interpreter.globalNameSpace成员），这实际上是在修改interpreter实例的成员状态，在并发环境下，多个线程如果都这样执行，就会互相干扰，无法得到正确的结果。

eval

如下是 bsh.Interpreter.eval(Reader,NameSpace,String)方法的实例代码片段

可以看到在调用eval方法执行脚本的时候，eval又创建一个内部的解释器实例，所以它可以保证线程安全。
只是在创建这个内部实例的时候，把当前实例做为父实例参数传递给了构造方法。这个新的实例即可以访问父实例的名字空间也可以有自己单独使用的名字空间。

优化方案

看懂了eval执行脚本的逻辑，在上面示例的基础上可以如下修改，即减少无谓的实例创建和销毁，又可以保证在并发环境下的线程安全。
请注意下面示例中执行脚本调用的是Interpreter.eval(String,NameSpace)方法而不是上面示例中的Interpreter.eval(String)方法

public class BshTest{
	/** 创建脚本解释器实例静态成员 */
	private static final Interpreter interpreter = new Interpreter();  
	@Test
	public void testBsh() {
		try {
			/** 
			 * 多线程环境下为了确保不同线程间命名空间互相不干扰，创建临时名字空间对象
			 * 用于定义脚本中引用的变量
			 */
			NameSpace ns = new NameSpace(interpreter.getNameSpace(), "test");
			/** 在临时命名空间对象中定义脚本中引用的内置变量 */
			ns.setVariable("name", "world", false);
			/** 
			 * 调用 Interpreter.eval(String,NameSpace)方法执行脚本
			 * 将临时名字空间对象传递给解释器
			 */
			Object res = interpreter.eval("\"hello \"+ name",ns);
			/** 输出hello world */
			System.out.println("res "+res);
			assertTrue("hello world".equals(res));
		} catch (EvalError e) {
			e.printStackTrace();
			assertFalse(true);
		}
	}