Skip to content

apijson function支持脚本引擎，比如JavaScript、lua等 #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 20, 2023
Merged

apijson function支持脚本引擎，比如JavaScript、lua等 #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e6d6ec9
function支持脚本引擎，比如JavaScript、lua等
cloudAndMonkey Jan 16, 2023
017d876
apijson function支持脚本引擎，比如JavaScript、lua等
cloudAndMonkey Jan 16, 2023
a4c2f4c
apijson function支持脚本引擎，比如JavaScript、lua等
cloudAndMonkey Jan 16, 2023
22ba330
删除无效代码
cloudAndMonkey Jan 16, 2023
9db1b50
假删除添加null 判断,避免客户端json传递不存在的对象
cloudAndMonkey Jan 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 14 additions & 115 deletions APIJSONORM/src/main/java/apijson/orm/AbstractFunctionParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
import apijson.NotNull;
import apijson.RequestMethod;
import apijson.StringUtil;
import apijson.framework.APIJSONApplication;
import apijson.orm.exception.UnsupportedDataTypeException;
import apijson.orm.script.ScriptExecutor;

/**可远程调用的函数类
* @author Lemon
Expand All @@ -47,11 +49,11 @@ public class AbstractFunctionParser implements FunctionParser {

// <methodName, JSONObject>
// <isContain, <arguments:"array,key", tag:null, methods:null>>
public static Map<String, ScriptExecutor> SCRIPT_EXECUTOR_MAP;
public static Map<String, JSONObject> FUNCTION_MAP;
public static Map<String, JSONObject> SCRIPT_MAP;
static {
FUNCTION_MAP = new HashMap<>();
SCRIPT_MAP = new HashMap<>();
SCRIPT_EXECUTOR_MAP = new HashMap<>();
}

private RequestMethod method;
Expand Down Expand Up @@ -198,20 +200,10 @@ public static Object invoke(@NotNull AbstractFunctionParser parser, @NotNull Str
throw new UnsupportedOperationException("language = " + language + " 不合法！AbstractFunctionParser.ENABLE_SCRIPT_FUNCTION" +
" == false 时不支持远程函数中的脚本形式！如需支持则设置 AbstractFunctionParser.ENABLE_SCRIPT_FUNCTION = true ！");
}
ScriptEngine engine = lang == null ? null : SCRIPT_ENGINE_MAP.get(lang);
if (lang != null) {
if (engine == null) {
engine = new ScriptEngineManager().getEngineByName(lang);
}
if (engine == null) {
engine = new ScriptEngineManager(null).getEngineByName(lang);
}
if (engine == null) {
throw new ClassNotFoundException("找不到脚本语言 " + language + " 对应的执行引擎！请先依赖相关库并在后端 ScriptEngineManager 中注册！");
}

SCRIPT_ENGINE_MAP.put(lang, engine);
}

if (lang != null && SCRIPT_EXECUTOR_MAP.get(lang) == null) {
throw new ClassNotFoundException("找不到脚本语言 " + lang + " 对应的执行引擎！请先依赖相关库并在后端 APIJSONFunctionParser 中注册！");
}

int version = row.getIntValue("version");
if (parser.getVersion() < version) {
Expand All @@ -228,7 +220,7 @@ public static Object invoke(@NotNull AbstractFunctionParser parser, @NotNull Str
}

try {
return invoke(parser, fb.getMethod(), fb.getTypes(), fb.getValues(), row.getString("returnType"), currentObject, engine);
return invoke(parser, fb.getMethod(), fb.getTypes(), fb.getValues(), row.getString("returnType"), currentObject, SCRIPT_EXECUTOR_MAP.get(lang));
}
catch (Exception e) {
if (e instanceof NoSuchMethodException) {
Expand Down Expand Up @@ -278,9 +270,9 @@ public static Object invoke(@NotNull AbstractFunctionParser parser, @NotNull Str
*/
public static Object invoke(@NotNull AbstractFunctionParser parser, @NotNull String methodName
, @NotNull Class<?>[] parameterTypes, @NotNull Object[] args, String returnType
, JSONObject currentObject, ScriptEngine engine) throws Exception {
if (engine != null) {
return invokeScript(parser, methodName, parameterTypes, args, returnType, currentObject, engine);
, JSONObject currentObject, ScriptExecutor scriptExecutor) throws Exception {
if (scriptExecutor != null) {
return invokeScript(parser, methodName, parameterTypes, args, returnType, currentObject, scriptExecutor);
}

Method m = parser.getClass().getMethod(methodName, parameterTypes); // 不用判空，拿不到就会抛异常
Expand All @@ -303,29 +295,6 @@ public static Object invoke(@NotNull AbstractFunctionParser parser, @NotNull Str
return m.invoke(parser, args);
}

public static Invocable INVOCABLE;
public static ScriptEngine SCRIPT_ENGINE;
public static Map<String, ScriptEngine> SCRIPT_ENGINE_MAP;
static {
try {
System.setProperty("Dnashorn.args", "language=es6");
System.setProperty("Dnashorn.args", "--language=es6");
System.setProperty("-Dnashorn.args", "--language=es6");

/*获取执行JavaScript的执行引擎*/
SCRIPT_ENGINE = new ScriptEngineManager().getEngineByName("javascript");
INVOCABLE = (Invocable) SCRIPT_ENGINE;

SCRIPT_ENGINE_MAP = new HashMap<>();
SCRIPT_ENGINE_MAP.put("JavaScript", SCRIPT_ENGINE);
SCRIPT_ENGINE_MAP.put("javascript", SCRIPT_ENGINE);
SCRIPT_ENGINE_MAP.put("js", SCRIPT_ENGINE);
}
catch (Exception e) {
e.printStackTrace();
}
}

/**Java 调用 JavaScript 函数
* @param parser
* @param methodName
Expand All @@ -337,78 +306,8 @@ public static Object invoke(@NotNull AbstractFunctionParser parser, @NotNull Str
* @throws Exception
*/
public static Object invokeScript(@NotNull AbstractFunctionParser parser, @NotNull String methodName
, @NotNull Class<?>[] parameterTypes, @NotNull Object[] args, String returnType, JSONObject currentObject, ScriptEngine engine) throws Exception {
JSONObject row = SCRIPT_MAP.get(methodName);
if (row == null) {
throw new UnsupportedOperationException("调用的远程函数脚本 " + methodName + " 不存在!");
}

String script = row.getString("script");

if (engine == null) {
engine = SCRIPT_ENGINE;
}
engine.eval(script); // 必要，未执行导致下方 INVOCABLE.invokeFunction 报错 NoSuchMethod

//Object[] newArgs = args == null || args.length <= 0 ? null : new Object[args.length];

// APIJSON 远程函数不应该支持
//if (row.getBooleanValue("simple")) {
// return SCRIPT_ENGINE.eval(script);
//}

Invocable invocable = engine instanceof Invocable ? (Invocable) engine : null;

Object result;
if (args == null || args.length <= 0) {
result = invocable.invokeFunction(methodName);
}
else {
//args[0] = JSON.toJSONString(args[0]); // Java 调 js 函数只支持传基本类型，改用 invokeMethod ？

//for (int i = 0; i < args.length; i++) {
// Object a = currentObject == null ? null : currentObject.get(args[i]);
// newArgs[i] = a == null || apijson.JSON.isBooleanOrNumberOrString(a) ? a : JSON.toJSONString(a);
//}

// 支持 JSONObject
result = invocable.invokeFunction(methodName, args);
//result = INVOCABLE.invokeMethod(args[0], methodName, args);

//switch (newArgs.length) {
// case 1:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0]);
// break;
// case 2:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0], newArgs[1]);
// break;
// case 3:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0], newArgs[1], newArgs[2]);
// break;
// case 4:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0], newArgs[1], newArgs[2], newArgs[3]);
// break;
// case 5:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0], newArgs[1], newArgs[2], newArgs[3], newArgs[4]);
// break;
// case 6:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0], newArgs[1], newArgs[2], newArgs[3], newArgs[4], newArgs[5]);
// break;
// case 7:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0], newArgs[1], newArgs[2], newArgs[3], newArgs[4], newArgs[5], newArgs[6]);
// break;
// case 8:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0], newArgs[1], newArgs[2], newArgs[3], newArgs[4], newArgs[5], newArgs[6], newArgs[7]);
// break;
// case 9:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0], newArgs[1], newArgs[2], newArgs[3], newArgs[4], newArgs[5], newArgs[6], newArgs[7], newArgs[8]);
// break;
// case 10:
// result = INVOCABLE.invokeFunction(methodName, newArgs[0], newArgs[1], newArgs[2], newArgs[3], newArgs[4], newArgs[5], newArgs[6], newArgs[7], newArgs[8], newArgs[9]);
// break;
//}
}

, @NotNull Class<?>[] parameterTypes, @NotNull Object[] args, String returnType, JSONObject currentObject, ScriptExecutor scriptExecutor) throws Exception {
Object result = scriptExecutor.execute(parser, currentObject, methodName, args);
if (Log.DEBUG && result != null) {
Class<?> rt = result.getClass(); // 作为远程函数的 js 类型应该只有 JSON 的几种类型
String fullReturnType = (StringUtil.isSmallName(returnType)
Expand Down
4 changes: 2 additions & 2 deletions APIJSONORM/src/main/java/apijson/orm/AbstractParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2120,8 +2120,8 @@ private JSONObject batchVerify(RequestMethod method, String tag, int version, St
case apijson.JSONObject.KEY_DATABASE:
object_attributes_map.put(apijson.JSONObject.KEY_DATABASE, objAttrJson.getString(objAttr));
break;
case apijson.JSONObject.VERSION:
object_attributes_map.put(apijson.JSONObject.VERSION, objAttrJson.getString(objAttr));
case JSONRequest.KEY_VERSION:
object_attributes_map.put(JSONRequest.KEY_VERSION, objAttrJson.getString(objAttr));
break;
case apijson.JSONObject.KEY_ROLE:
object_attributes_map.put(apijson.JSONObject.KEY_ROLE, objAttrJson.getString(objAttr));
Expand Down
2 changes: 1 addition & 1 deletion APIJSONORM/src/main/java/apijson/orm/AbstractSQLConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5004,7 +5004,7 @@ else if (userId instanceof Subquery) {}
if(config.isFakeDelete()) {
// 查询Access假删除
Map<String, Object> accessFakeDeleteMap = AbstractVerifier.ACCESS_FAKE_DELETE_MAP.get(config.getTable());
if (StringUtil.isNotEmpty(accessFakeDeleteMap.get("deletedKey"), true)) {
if (accessFakeDeleteMap != null && StringUtil.isNotEmpty(accessFakeDeleteMap.get("deletedKey"), true)) {
Map<String, Object> fakeDeleteMap = new HashMap<>();
boolean isFakeDelete = true;
if(method != DELETE) {
Expand Down
80 changes: 80 additions & 0 deletions APIJSONORM/src/main/java/apijson/orm/script/JSR223ScriptExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
package apijson.orm.script;

import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import javax.script.Bindings;
import javax.script.Compilable;
import javax.script.CompiledScript;
import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;
import javax.script.SimpleBindings;

import com.alibaba.fastjson.JSONObject;

import apijson.orm.AbstractFunctionParser;

/**
* JSR223 script engine的统一实现抽象类
*/
public abstract class JSR223ScriptExecutor implements ScriptExecutor {
protected ScriptEngine scriptEngine;

private final Map<String, CompiledScript> compiledScriptMap = new ConcurrentHashMap<>();

@Override
public ScriptExecutor init() {
ScriptEngineManager scriptEngineManager = new ScriptEngineManager();
scriptEngine = scriptEngineManager.getEngineByName(scriptEngineName());
return this;
}

protected abstract String scriptEngineName();

protected abstract Object extendParameter(AbstractFunctionParser parser, JSONObject currentObject, String methodName, Object[] args);

protected abstract boolean isLockScript(String methodName);

protected String convertScript(String script) {
return script;
}

@Override
public void load(String name, String script) {
try {
CompiledScript compiledScript = ((Compilable) scriptEngine).compile(convertScript(script));
compiledScriptMap.put(name, compiledScript);
} catch (Exception e) {
e.printStackTrace();
}

}

@Override
public Object execute(AbstractFunctionParser parser, JSONObject currentObject, String methodName, Object[] args) throws Exception {
CompiledScript compiledScript = compiledScriptMap.get(methodName);
Bindings bindings = new SimpleBindings();
// 往脚本上下文里放入元数据
// 把 RequestMethod method, String tag, int version, @NotNull JSONObject request,
// HttpSession session 等参数作为全局参数传进去供脚本使用

// 加载扩展属性
Object extendParameter = this.extendParameter(parser, currentObject, methodName, args);
if(extendParameter != null) {
bindings.put("extParam", extendParameter);
}

Map<String, Object> metaMap = new HashMap<>();
metaMap.put("version", parser.getVersion());
metaMap.put("tag", parser.getTag());
metaMap.put("args", args);
bindings.put("_meta", metaMap);
return compiledScript.eval(bindings);
}

@Override
public void cleanCache() {
compiledScriptMap.clear();
}
}
27 changes: 27 additions & 0 deletions APIJSONORM/src/main/java/apijson/orm/script/JavaScriptExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package apijson.orm.script;

import com.alibaba.fastjson.JSONObject;

import apijson.orm.AbstractFunctionParser;

/**
* JavaScript脚本语言的执行器实现
*/
public class JavaScriptExecutor extends JSR223ScriptExecutor {

@Override
protected String scriptEngineName() {
return "javascript";
}

@Override
protected Object extendParameter(AbstractFunctionParser parser, JSONObject currentObject, String methodName, Object[] args) {
return null;
}

@Override
protected boolean isLockScript(String methodName) {
return false;
}

}
17 changes: 17 additions & 0 deletions APIJSONORM/src/main/java/apijson/orm/script/ScriptExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package apijson.orm.script;

import com.alibaba.fastjson.JSONObject;

import apijson.orm.AbstractFunctionParser;

public interface ScriptExecutor {

ScriptExecutor init();

void load(String name, String script);

Object execute(AbstractFunctionParser parser, JSONObject currentObject, String methodName, Object[] args) throws Exception;

void cleanCache();

}