炫技Groovy!SpringBoot中的动态编程实战

戳上方蓝字“Java知音”关注我

Groovy简介

Groovy 是增强 Java 平台的唯一的脚本语言。它提供了类似于 Java 的语法,内置映射(Map)、列表(List)、方法、类、闭包(closure)以及生成器。脚本语言不会替代系统编程语言,两者是相互补充的。

大名鼎鼎的 Gradle,背后是 Groovy。Spring 的未来越来越多的使用 Groovy,甚至在用 Jira 跟踪项目时,背后也有 Groovy。

实际上,就应用场景而言,Java 开发已经有越来越多的 Groovy 出现在后台了。而对于一般的应用开发,只要能用 Java 就都能用到 Groovy,唯一的难点只在于能不能招到足够的人员。

应用场景

  • 连接已有的组件
  • 处理经常变化的多种类型的实体
  • 具有图形化用户界面
  • 拥有快速变化的功能

注:今天我们分享的就是利用Groovy脚本在SpringBoot项目中实现动态编程,使业务逻辑的动态化,极大地提升了开发效率和灵活性。

集成与使用

那么接下来介绍SpringBoot如何集成Groovy脚本,并应用到实际开发中。

第一步、与SpringBoot集成

1、pom.xml文件如下:

<dependency>
    <groupId>org.codehaus.groovy</groupId>
    <artifactId>groovy-all</artifactId>
    <version>2.4.7</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

第二步、写出Groovy版本的“Hello World”

1、HelloWorld.groovy脚本代码

package groovy

def HelloWorld()
{
    println "hello world"
}

2、创建测试类GroovyTest.java

package com.example.springbootgroovy.service;

import groovy.lang.GroovyShell;
import groovy.lang.Script;

/**
 * 这个是Groovy的第一个小程序,脚本为:
 * 
 package groovy
 
 def helloworld(){
  println "hello world"
 }
 *
 */

public class GroovyTest {

    public static void main(String[] args) throws Exception {
        //创建GroovyShell
        GroovyShell groovyShell = new GroovyShell();
        //装载解析脚本代码
        Script script = groovyShell.parse("package groovyn" +
                "n" +
                "def HelloWorld(){n" +
                "    println "hello world"n" +
                "}");
        //执行
        script.invokeMethod("HelloWorld"null);
    }
}

3、运行结果

炫技Groovy!SpringBoot中的动态编程实战

第三步、传入变量与获取返回值

1、变量与返回值Groovy脚本代码

package groovy

/**
 * 简易加法
 * @param a 数字a
 * @param b 数字b
 * @return 和
 */

def add(int a, int b) {
    return a + b
}

/**
 * map转化为String
 * @param paramMap 参数map
 * @return 字符串
 */

def mapToString(Map<String, String> paramMap) {
    StringBuilder stringBuilder = new StringBuilder();
    paramMap.forEach({ key, value ->
        stringBuilder.append("key:" + key + ";value:" + value)
    })
    return stringBuilder.toString()
}

2、创建测试类GroovyTest2.java

package com.example.springbootgroovy.service;

import groovy.lang.GroovyShell;
import groovy.lang.Script;

import java.util.HashMap;
import java.util.Map;

/**
 * 向Groovy脚本中传入变量,以及获取返回值
 */

public class GroovyTest2 {
    public static void main(String[] args) {
        //创建GroovyShell
        GroovyShell groovyShell = new GroovyShell();
        //装载解析脚本代码
        Script script = groovyShell.parse("package groovyn" +
                "n" +
                "/**n" +
                " * 简易加法n" +
                " * @param a 数字an" +
                " * @param b 数字bn" +
                " * @return 和n" +
                " */n" +
                "def add(int a, int b) {n" +
                "    return a + bn" +
                "}n" +
                "n" +
                "/**n" +
                " * map转化为Stringn" +
                " * @param paramMap 参数mapn" +
                " * @return 字符串n" +
                " */n" +
                "def mapToString(Map<String, String> paramMap) {n" +
                "    StringBuilder stringBuilder = new StringBuilder();n" +
                "    paramMap.forEach({ key, value ->n" +
                "        stringBuilder.append("key:" + key + ";value:" + value)n" +
                "    })n" +
                "    return stringBuilder.toString()n" +
                "}");
        //执行加法脚本
        Object[] params1 = new Object[]{12};
        int sum = (int) script.invokeMethod("add", params1);
        System.out.println("a加b的和为:" + sum);
        //执行解析脚本
        Map<String, String> paramMap = new HashMap<>();
        paramMap.put("科目1""语文");
        paramMap.put("科目2""数学");
        Object[] params2 = new Object[]{paramMap};
        String result = (String) script.invokeMethod("mapToString", params2);
        System.out.println("mapToString:" + result);
    }
}

3、运行结果

炫技Groovy!SpringBoot中的动态编程实战

第四步、启动SpringBoot

在Groovy脚本中通过SpringContextUtil获取SpringBoot容器中的Bean

1、创建SpringContextUtil.java

package com.example.springbootgroovy.util;

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

/**
 * Spring上下文获取
 */

@Component
public class SpringContextUtil implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringContextUtil.applicationContext = applicationContext;
    }

    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    /**
     * 通过name获取 Bean.
     *
     * @param name
     * @return
     */

    public static Object getBean(String name) {
        return getApplicationContext().getBean(name);
    }

    /**
     * 通过class获取Bean.
     *
     * @param clazz
     * @param <T>
     * @return
     */

    public static <T> getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }

    /**
     * 通过name,以及Clazz返回指定的Bean
     *
     * @param name
     * @param clazz
     * @param <T>
     * @return
     */

    public static <T> getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }
}

2、创建GroovyTestService.java,并加上@Service注解加入到SpringBoot容器中

package com.example.springbootgroovy.service;

import org.springframework.stereotype.Service;

@Service
public class GroovyTestService {

    public void test(){
        System.out.println("我是SpringBoot框架的成员类,但该方法由Groovy脚本调用");
    }

}

3、Groovy脚本如下

package groovy

import com.example.springbootgroovy.service.GroovyTestService
import com.example.springbootgroovy.util.SpringContextUtil

/**
 * 静态变量
 */

class Globals {
    static String PARAM1 = "静态变量"
    static int[] arrayList = [12]
}

def getBean() {
    GroovyTestService groovyTestService = SpringContextUtil.getBean(GroovyTestService.class);
    groovyTestService.test()
}

4、启动类代码如下

package com.example.springbootgroovy;

import groovy.lang.GroovyShell;
import groovy.lang.Script;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/groovy")
@SpringBootApplication
public class SpringBootGroovyApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootGroovyApplication.classargs);
    }

    @RequestMapping("/test")
    public String test() {
        //创建GroovyShell
        GroovyShell groovyShell = new GroovyShell();
        //装载解析脚本代码
        Script script = groovyShell.parse("package groovyn" +
                "n" +
                "import com.example.springbootgroovy.service.GroovyTestServicen" +
                "import com.example.springbootgroovy.util.SpringContextUtiln" +
                "n" +
                "/**n" +
                " * 静态变量n" +
                " */n" +
                "class Globals {n" +
                "    static String PARAM1 = "静态变量"n" +
                "    static int[] arrayList = [1, 2]n" +
                "}n" +
                "n" +
                "def getBean() {n" +
                "    GroovyTestService groovyTestService = SpringContextUtil.getBean(GroovyTestService.class);n" +
                "    groovyTestService.test()n" +
                "}");
        //执行
        script.invokeMethod("getBean"null);
        return "ok";
    }
}

5、启动后调用接口:http://localhost:8080/groovy/test,运行结果如下

炫技Groovy!SpringBoot中的动态编程实战

注意!!!

通过第四步中我们可以看到,在Groovy中是可以获取到SpringBoot容器对象的。虽然很方便,但是很危险。如果没有做好权限控制,Groovy脚本将会成为攻击你系统最有力的武器!!!

另外Groovy脚本用不好,会导致OOM,最终服务器宕机

我最开始的用法

public static List<JSONObject> invokeMethod(String templateScript, JSONObject configParam) {
     Binding groovyBinding = new Binding();
     GroovyShell groovyShell = new GroovyShell(groovyBinding);
     Script script = groovyShell.parse(templateScript);
     Object[] params = new Object[]{configParam};
     List<JSONObject> resultList = (List<JSONObject>) script.invokeMethod("methodName", params);
     return resultList;
 }

这种用法肯定是不对的,这相当于每次调用这个方法都创建了GroovyShell、Script等实例,随着调用次数的增加,必然会出现OOM。

第一次改造,在方法最后增加一行:groovyShell.getClassLoader().clearCache();

也就是在方法的最后调用一次clearCache方法,这样可以清除掉GroovyShell、Script等实例,但是还是不够。导致OOM的原因并不止GroovyShell、Script等实例过多,经过查阅资料得知,如果脚本中的Java代码也创建了对象或者new了实例,即使销毁了GroovyShell也不会销毁脚本中的对象。

例如下面这个脚本,会创建一个ArrayList对象。这个对象不会随着GroovyShell、Script等实例的消失而消失,所以还是会有问题。

def test(){
    List<String> list = new ArrayList<>();
}

第二次改造,增加SCRIPT_MAP,将已有的Groovy实例放入缓存中维护起来

/**
 * 缓存Script,避免创建太多
 */

private static final Map<String, Script> SCRIPT_MAP = Maps.newHashMap();

private static final GroovyClassLoader CLASS_LOADER = new GroovyClassLoader();

public static Script loadScript(String key, String rule) {
    if (SCRIPT_MAP.containsKey(key)) {
        return SCRIPT_MAP.get(key);
    }
    Script script = loadScript(rule, new Binding());
    SCRIPT_MAP.put(key, script);
    return script;
}


public static Script loadScript(String rule, Binding binding) {
    if (StringUtils.isEmpty(rule)) {
        return null;
    }
    try {
        Class ruleClazz = CLASS_LOADER.parseClass(rule);
        if (ruleClazz != null) {
            log.info("load rule:" + rule + " success!");
            return InvokerHelper.createScript(ruleClazz, binding);
        }
    } catch (Exception e) {
        log.error(e.getMessage(), e);
    } finally {
        CLASS_LOADER.clearCache();
    }
    return null;
}

这种方法的好处是解决了OOM问题,但也有一个问题,如果脚本内容修改了的话,需要清空SCRIPT_MAP,重新装载脚本实例。

来源:juejin.cn/post/7139877924676567048

后端专属技术群

构建高质量的技术交流社群,欢迎从事编程开发、技术招聘HR进群,也欢迎大家分享自己公司的内推信息,相互帮助,一起进步!

文明发言,以交流技术职位内推行业探讨为主

广告人士勿入,切勿轻信私聊,防止被骗

炫技Groovy!SpringBoot中的动态编程实战

加我好友,拉你进群

炫技Groovy!SpringBoot中的动态编程实战

原文始发于微信公众号(Java知音):炫技Groovy!SpringBoot中的动态编程实战

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/278309.html

(0)
Java知音的头像Java知音bm

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!