package com.github.ompc.greys.core.command; import com.github.ompc.greys.core.Advice; import com.github.ompc.greys.core.advisor.AdviceListener; import com.github.ompc.greys.core.advisor.ReflectAdviceListenerAdapter; import com.github.ompc.greys.core.command.annotation.Cmd; import com.github.ompc.greys.core.command.annotation.IndexArg; import com.github.ompc.greys.core.command.annotation.NamedArg; import com.github.ompc.greys.core.server.Session; import com.github.ompc.greys.core.util.GaMethod; import com.github.ompc.greys.core.util.GaStringUtils; import com.github.ompc.greys.core.util.LogUtil; import com.github.ompc.greys.core.util.PointCut; import com.github.ompc.greys.core.util.matcher.*; import org.apache.commons.io.IOUtils; import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import javax.script.*; import java.io.IOException; import java.lang.instrument.Instrumentation; import java.nio.charset.Charset; import java.nio.charset.UnsupportedCharsetException; import java.util.HashMap; import java.util.Map; import static com.github.ompc.greys.core.util.GaStringUtils.getCauseMessage; import static org.apache.commons.lang3.StringUtils.EMPTY; /** * js脚本增强命令 * Created by vlinux on 16/2/9. */ @Cmd(name = "js", sort = 6, summary = "Enhanced JavaScript", eg = { "js *StringUtils isBlank /tmp/watch.js", "js -c UTF-8 *StringUtils isBlank /tmp/watch.js", "js *Test print* http://t.cn/RG03oNA", "js http://t.cn/RG03oNw", }) public class JavaScriptCommand implements ScriptSupportCommand, Command { private final Logger logger = LogUtil.getLogger(); @IndexArg(index = 0, name = "class-pattern\n\tOR\nscript-path", isRequired = false, summary = "Path and classname of Pattern Matching \n\tOR\nPath of javascript, support http/https") private String argument1; @IndexArg(index = 1, name = "method-pattern", isRequired = false, summary = "Method of Pattern Matching if class-pattern enable.") private String argument2; @IndexArg(index = 2, name = "script-path", isRequired = false, summary = "Path of javascript, support http/https if class-pattern enable.") private String argument3; private String classPattern; private String methodPattern; private String scriptPath; @NamedArg(name = "c", hasValue = true, summary = "The character of script-path") private String charsetString; @NamedArg(name = "E", summary = "Enable regular expression to match (wildcard matching by default)") private boolean isRegEx = false; /* * 获取指定字符集 */ private Charset fetchCharset() throws UnsupportedCharsetException { if (StringUtils.isBlank(charsetString)) { return Charset.defaultCharset(); } else { return Charset.forName(charsetString); } } /* * 加载支撑脚本(gblocking.js) */ private void loadJavaScriptSupport(Compilable compilable) throws IOException, ScriptException { // 加载 compilable.compile( IOUtils.toString( GaStringUtils.class.getResourceAsStream("/com/github/ompc/greys/core/res/javascript/gblocking.js"), Charset.forName("UTF-8") ) ).eval(); } /* * 加载greys模块脚本(greys-module.js) */ private void loadGreysModule(Compilable compilable) throws IOException, ScriptException { // 加载greys-module.js compilable.compile( IOUtils.toString( GaStringUtils.class.getResourceAsStream("/com/github/ompc/greys/core/res/javascript/greys-module.js"), Charset.forName("UTF-8") ) ).eval(); } /* * 加载自定义模块地址 */ private void loadCustomModule(Invocable invocable, String path, Charset charset) throws ScriptException, NoSuchMethodException { invocable.invokeFunction("__greys_load", path, charset.name()); } /** * 修正参数 */ private void fixArguments() { // js script-path if (StringUtils.isNotBlank(argument1) && StringUtils.isBlank(argument2) && StringUtils.isBlank(argument3)) { scriptPath = argument1; } // js class-pattern method-pattern script-path else if (StringUtils.isNotBlank(argument1) && StringUtils.isNotBlank(argument2) && StringUtils.isNotBlank(argument3)) { classPattern = argument1; methodPattern = argument2; scriptPath = argument3; } else { // 没有命中组合方式 throw new IllegalArgumentException("class-pattern/method-pattern/script-path or script-path is require."); } } @Override public Action getAction() { fixArguments(); /** * ScriptEngine放在这里是有讲究的,毕竟ScriptEngine将会被多线程并发执行,JavaScript却是单线程的实现 * 所以一个ScriptEngine的厂商实现是否支持并发,非常关键,还好默认的Rhino和Nashorn都是"MULTITHREADED"级别的实现 * 在ScriptEngineFactory中有一个getParameter方法,通过传入”THREADING”字符串作为参数,可以获知引擎是否是线程安全的 * * 线程安全级别说明 * 1. "null" * 引擎实现不是线程安全的,并且无法用来在多个线程上并发执行脚本。 * * 2. "MULTITHREADED" * 引擎实现是内部线程安全的,并且脚本可以并发执行,尽管在某个线程上执行脚本的效果对于另一个线程上的脚本是可见的。 * * 3. "THREAD-ISOLATED" * 该实现满足 "MULTITHREADED" 的要求,并且引擎为不同线程上执行的脚本中的符号维护独立的值。 * * 4. "STATELESS" * 该实现满足 "THREAD-ISOLATED" 的要求。此外,脚本执行不改变 Bindings 中的映射关系,该 Bindings 是 ScriptEngine 的引擎范围。 * 具体来说,Bindings 及其关联值中的键在执行脚本之前和之后是相同的。 * */ final ScriptEngineManager mgr = new ScriptEngineManager(); final ScriptEngine jsEngine = mgr.getEngineByMimeType("application/javascript"); final Compilable compilable = (Compilable) jsEngine; final Invocable invocable = (Invocable) jsEngine; try { loadJavaScriptSupport(compilable); loadGreysModule(compilable); loadCustomModule(invocable, scriptPath, fetchCharset()); } catch (final ScriptException e) { logger.warn("javascript compile failed. script={};", scriptPath, e); return new SilentAction() { @Override public void action(Session session, Instrumentation inst, Printer printer) throws Throwable { printer.println("javascript compile failed. because " + getCauseMessage(e)).finish(); } }; } catch (final NoSuchMethodException e) { logger.warn("javascript function not defined.", e); return new SilentAction() { @Override public void action(Session session, Instrumentation inst, Printer printer) throws Throwable { printer.println("javascript function not defined. because " + getCauseMessage(e)).finish(); } }; } catch (final IOException e) { logger.warn("load javascript failed.", e); return new SilentAction() { @Override public void action(Session session, Instrumentation inst, Printer printer) throws Throwable { printer.println("load javascript failed. because " + getCauseMessage(e)).finish(); } }; } return new GetEnhancerAction() { @Override public GetEnhancer action(Session session, Instrumentation inst, final Printer printer) throws Throwable { final Output output = new Output() { @Override public Output print(String string) { printer.print(string); return this; } @Override public Output println(String string) { printer.println(string); return this; } @Override public Output finish() { printer.print(EMPTY).finish(); return this; } }; return new GetEnhancer() { @Override public PointCut getPointCut() { final GroupMatcher<Class<?>> orClassMatcher = new GroupMatcher.Or<Class<?>>(); final GroupMatcher<GaMethod> orMethodMatcher = new GroupMatcher.Or<GaMethod>(); if (StringUtils.isNotBlank(classPattern)) { orClassMatcher.add(new ClassMatcher(new PatternMatcher(isRegEx, classPattern))); } if (StringUtils.isNotBlank(methodPattern)) { orMethodMatcher.add(new GaMethodMatcher(new PatternMatcher(isRegEx, methodPattern))); } orClassMatcher.add(new Matcher<Class<?>>() { @Override public boolean matching(Class<?> target) { try { return (Boolean) invocable.invokeFunction("__greys_module_test_java_class_name", target.getName()); } catch (Throwable t) { logger.warn("invoke function 'test_java_class_name' failed.", t); return false; } } }); orMethodMatcher.add(new Matcher<GaMethod>() { @Override public boolean matching(GaMethod target) { try { return (Boolean) invocable.invokeFunction("__greys_module_test_java_method_name", target.getName()); } catch (Throwable t) { logger.warn("invoke function 'test_java_method_name' failed.", t); return false; } } }); return new PointCut(orClassMatcher, orMethodMatcher); } @Override public AdviceListener getAdviceListener() { return new ReflectAdviceListenerAdapter() { private final ThreadLocal<ThreadSafeMap> mapRef = new ThreadLocal<ThreadSafeMap>() { @Override protected ThreadSafeMap initialValue() { return new ThreadSafeMap(); } }; @Override public void create() { try { invocable.invokeFunction("__greys_module_create", output); } catch (Throwable e) { output.println("invoke function 'create' failed. because : " + getCauseMessage(e)); logger.warn("invoke function 'create' failed.", e); } } @Override public void destroy() { try { invocable.invokeFunction("__greys_module_destroy", output); } catch (Throwable e) { output.println("invoke function 'destroy' failed. because : " + getCauseMessage(e)); logger.warn("invoke function 'destroy' failed.", e); } } @Override public void before(Advice advice) throws Throwable { try { invocable.invokeFunction("__greys_module_before", output, advice, mapRef.get()); } catch (Throwable e) { output.println("invoke function 'before' failed. because : " + getCauseMessage(e)); logger.warn("invoke function 'before' failed.", e); } } @Override public void afterReturning(Advice advice) throws Throwable { try { invocable.invokeFunction("__greys_module_returning", output, advice, mapRef.get()); } catch (Throwable e) { output.println("invoke function 'returning' failed. because : " + getCauseMessage(e)); logger.warn("invoke function 'returning' failed.", e); } } @Override public void afterThrowing(Advice advice) throws Throwable { try { invocable.invokeFunction("__greys_module_throwing", output, advice, mapRef.get()); } catch (Throwable e) { output.println("invoke function 'throwing' failed. because : " + getCauseMessage(e)); logger.warn("invoke function 'throwing' failed.", e); } } }; } }; } }; } /** * 用于协同JavaScript作业的Map封装 */ public static class ThreadSafeMap { private ThreadLocal<Map<String, Object>> mapRef = new ThreadLocal<Map<String, Object>>() { @Override protected Map<String, Object> initialValue() { return new HashMap<String, Object>(); } }; public void put(String key, Object val) { mapRef.get().put(key, val); } public Object get(String key) { return mapRef.get().get(key); } public boolean has(String key) { return mapRef.get().containsKey(key); } } }