场景
在开发的Spring Cloud 的项目或者Sprng Boot 或者其他Web 项目时候,在版本控制或数据库关闭比较严格的场景下。 例如,我在吉祥的时候每次版本发布上总会出现一些BUG导致数据不一致。 某个第三方接口发送超时没有重试机制的时候(有的小伙伴会说我提前开放好不就行了)这里主要指没有开放接口的API
解决办法
当然如果你能提现预料,开发API接口也是可以的, 如果遇到这种版本控制严格不能水边发版就需要可以执行动态脚本进行接口调用。
动态语言
- Groovy
- JavaScript
- Python
Groovy 非常好与Java 配置程度很高,但是编写起来有点麻烦,上手程度一般
JavaScript 非常好轻量级能与Java互相调用,与Java 配置程度很高,但是编写简单,上手程度简单
Python 非常重量级能与Java互相调用,与Java 配置程度一般,但是编写复杂,能适合全部复杂场景
PS:在执行调试脚本的时候,并不需要最求速度与性能,最主要是简单和不容易错。所以我选择了JavaScript
思路与代码
在JDK8-17版本中都覆盖了JavaScript 轻量级的引擎,所以JDK对JS的支持还是很优秀的。
📢 编写的调试接口不要对公网开放
思路
- 提供一个HTTP(其他协议)的一个接口用于接受脚本内容
- 提供脚本提供一个默认的执行的方法名
- 定义脚本可能需要的全局参数
- 注入全局参数,编译脚本,调用默认执行的方法名
- 获取执行结果并返回
参考代码(详细注释版)
package com.xxscloud.mes.controller;
import lombok.SneakyThrows;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import javax.script.Invocable;
import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;
import javax.servlet.http.HttpServletRequest;
import java.util.Objects;
/**
* @author 橘猫.
*/
@RestController
@RequestMapping("/debug")
public class DebugController implements ApplicationContextAware {
private ApplicationContext applicationContext;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
@SneakyThrows
public Object getBean(String className) {
return applicationContext.getBean(Class.forName(className));
}
@SuppressWarnings("AlibabaUndefineMagicConstant")
@SneakyThrows
@PostMapping("/run")
public ResponseEntity<String> run(HttpServletRequest httpServletRequest) {
// 我用的JDK14+ 所有有这个方法 JDK8 用 apache 的 IOUtils.toString()
final String code = new String(httpServletRequest.getInputStream().readAllBytes());
final StringBuilder result = new StringBuilder();
try {
final ScriptEngine scriptEngine = new ScriptEngineManager().getEngineByExtension("js");
scriptEngine.put("applicationContext", applicationContext);
scriptEngine.put("output", result);
scriptEngine.put("tools", this);
scriptEngine.eval(code);
((Invocable) scriptEngine).invokeFunction("run");
} catch (Exception ex) {
result.append(ex.getMessage());
ex.printStackTrace();
}
return ResponseEntity.ok(result.toString());
}
}
Postman测试并调用
// 默认调用的方法
function run() {
// tools 是Java 全局注入的对象
var s = tools.getBean('com.xxscloud.mes.service.IndexService').getMenusList(0);
// output 是Java 全局注入的对象, 输出日志, append 是Java的类方法可以直接调用
output.append(s.get(0).id);
output.append(s.get(0).name);
output.append(s.get(0).sort);
}