├── .gitignore ├── LICENSE ├── README.MD ├── pom.xml └── src ├── main ├── java │ └── pers │ │ └── doublebin │ │ └── example │ │ └── groovy │ │ └── script │ │ ├── GroovyScriptExampleApplication.java │ │ ├── component │ │ └── TestScript.java │ │ ├── config │ │ └── GroovyBindingConfig.java │ │ ├── controller │ │ └── GroovyScriptController.java │ │ └── service │ │ └── TestService.java └── resources │ └── application.properties └── test └── java └── pers └── doublebin └── example └── groovy └── script └── GroovyScriptExampleApplicationTests.java /.gitignore: -------------------------------------------------------------------------------- 1 | /target/ 2 | !.mvn/wrapper/maven-wrapper.jar 3 | 4 | ### STS ### 5 | .apt_generated 6 | .classpath 7 | .factorypath 8 | .project 9 | .settings 10 | .springBeans 11 | .sts4-cache 12 | 13 | ### IntelliJ IDEA ### 14 | .idea 15 | *.iws 16 | *.iml 17 | *.ipr 18 | 19 | ### NetBeans ### 20 | /nbproject/private/ 21 | /build/ 22 | /nbbuild/ 23 | /dist/ 24 | /nbdist/ 25 | /.nb-gradle/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.MD: -------------------------------------------------------------------------------- 1 | ### springboot接口动态执行groovy脚本 2 | 3 | > 展示如何通过动态groovy脚本直接调用spring context中注册的bean的方法，方便项目测试，但正式项目中请对脚本运行接口做好权限控制 4 | 5 | 1. 打包：项目根目录运行: mvn clean install ,在target目录下生产可执行jar包：groovy-script-example-1.0.0.jar 6 | 2. 运行: 以jar包所在目录运行为例： java -jar groovy-script-example-1.0.0.jar, 默认使用8080端口(可自行修改springboot配置文件定义端口号) 7 | 3. 脚本执行： 8 | + url: [http://${ip}:8080/groovy/script/execute](http://localhost:8080/groovy/script/execute) 9 | + method: post 10 | + bodytype: Text 11 | + body: groovy脚本 12 | 13 | 4. 示例groovy脚本： 14 | 15 | + 调用TestService方法： 16 | 17 | ``` 18 | def query = testService.testQuery(1L) 19 | query 20 | ``` 21 | 结果返回："Test query success, id is 1". 22 | 23 | 24 | + 直接调用scriptBaseClass的方法： 25 | 26 | ``` 27 | def sum = add(1,2) 28 | sum 29 | ``` 30 | 结果返回: 3. 31 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | pers.doublebin.example 7 | groovy-script-example 8 | 1.0.0 9 | jar 10 | 11 | groovy-script-example 12 | Demo project for Spring Boot 13 | 14 | 15 | org.springframework.boot 16 | spring-boot-starter-parent 17 | 2.1.0.RELEASE 18 | 19 | 20 | 21 | 22 | UTF-8 23 | UTF-8 24 | 1.8 25 | 26 | 27 | 28 | 29 | org.springframework.boot 30 | spring-boot-starter 31 | 32 | 33 | 34 | org.springframework.boot 35 | spring-boot-starter-test 36 | test 37 | 38 | 39 | 40 | org.springframework.boot 41 | spring-boot-starter-web 42 | 43 | 44 | 45 | 46 | 47 | org.codehaus.groovy 48 | groovy-all 49 | 2.4.7 50 | 51 | 52 | 53 | org.projectlombok 54 | lombok 55 | 1.16.10 56 | 57 | 58 | 59 | 60 | 61 | 62 | org.springframework.boot 63 | spring-boot-maven-plugin 64 | 65 | 66 | 67 | 68 | 69 | 70 | -------------------------------------------------------------------------------- /src/main/java/pers/doublebin/example/groovy/script/GroovyScriptExampleApplication.java: -------------------------------------------------------------------------------- 1 | package pers.doublebin.example.groovy.script; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class GroovyScriptExampleApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(GroovyScriptExampleApplication.class, args); 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /src/main/java/pers/doublebin/example/groovy/script/component/TestScript.java: -------------------------------------------------------------------------------- 1 | package pers.doublebin.example.groovy.script.component; 2 | 3 | import groovy.lang.Script; 4 | 5 | public class TestScript extends Script { 6 | @Override 7 | public Object run() { 8 | return null; 9 | } 10 | 11 | public Integer add (Integer first, Integer second) { 12 | return first + second; 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/main/java/pers/doublebin/example/groovy/script/config/GroovyBindingConfig.java: -------------------------------------------------------------------------------- 1 | package pers.doublebin.example.groovy.script.config; 2 | 3 | import groovy.lang.Binding; 4 | import org.springframework.beans.BeansException; 5 | import org.springframework.context.ApplicationContext; 6 | import org.springframework.context.ApplicationContextAware; 7 | import org.springframework.context.annotation.Bean; 8 | import org.springframework.context.annotation.Configuration; 9 | 10 | import java.util.Map; 11 | 12 | @Configuration 13 | public class GroovyBindingConfig implements ApplicationContextAware { 14 | 15 | private ApplicationContext applicationContext; 16 | 17 | //@Bean("groovyBinding") 18 | public Binding groovyBinding() { 19 | Binding groovyBinding = new Binding(); 20 | 21 | Map beanMap = applicationContext.getBeansOfType(Object.class); 22 | //遍历设置所有bean,可以根据需求在循环中对bean做过滤 23 | for (String beanName : beanMap.keySet()) { 24 | groovyBinding.setVariable(beanName, beanMap.get(beanName)); 25 | } 26 | return groovyBinding; 27 | } 28 | 29 | @Bean("groovyBinding1") 30 | public Binding groovyBinding1() { 31 | Map beanMap = applicationContext.getBeansOfType(Object.class); 32 | return new Binding(beanMap); //如果不需要对bean做过滤，直接用beanMap构造Binding对象即可 33 | } 34 | 35 | @Override 36 | public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { 37 | this.applicationContext = applicationContext; 38 | 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/main/java/pers/doublebin/example/groovy/script/controller/GroovyScriptController.java: -------------------------------------------------------------------------------- 1 | package pers.doublebin.example.groovy.script.controller; 2 | 3 | import groovy.lang.Binding; 4 | import groovy.lang.GroovyClassLoader; 5 | import groovy.lang.GroovyShell; 6 | import groovy.lang.Script; 7 | import org.codehaus.groovy.control.CompilerConfiguration; 8 | import org.springframework.beans.factory.annotation.Autowired; 9 | import org.springframework.web.bind.annotation.RequestBody; 10 | import org.springframework.web.bind.annotation.RequestMapping; 11 | import org.springframework.web.bind.annotation.RequestMethod; 12 | import org.springframework.web.bind.annotation.RestController; 13 | import pers.doublebin.example.groovy.script.component.TestScript; 14 | 15 | import javax.annotation.PostConstruct; 16 | 17 | @RestController 18 | @RequestMapping("/groovy/script") 19 | public class GroovyScriptController { 20 | 21 | @Autowired 22 | private Binding groovyBinding; 23 | 24 | private GroovyShell groovyShell; 25 | 26 | @PostConstruct 27 | public void init(){ 28 | GroovyClassLoader groovyClassLoader = new GroovyClassLoader(this.getClass().getClassLoader()); 29 | CompilerConfiguration compilerConfiguration = new CompilerConfiguration(); 30 | compilerConfiguration.setSourceEncoding("utf-8"); 31 | compilerConfiguration.setScriptBaseClass(TestScript.class.getName()); 32 | 33 | groovyShell = new GroovyShell(groovyClassLoader, groovyBinding, compilerConfiguration); 34 | } 35 | 36 | @RequestMapping(value = "/execute", method = RequestMethod.POST) 37 | public String execute(@RequestBody String scriptContent) { 38 | Script script = groovyShell.parse(scriptContent); //此处简单示例，实际应用中可根据脚本特征将script存储, 下次运行时可根据脚本特征直接获取Script对象，避免parse的成本 39 | return String.valueOf(script.run()); 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/main/java/pers/doublebin/example/groovy/script/service/TestService.java: -------------------------------------------------------------------------------- 1 | package pers.doublebin.example.groovy.script.service; 2 | 3 | import groovy.lang.Binding; 4 | import groovy.lang.GroovyShell; 5 | import groovy.lang.Script; 6 | import org.springframework.stereotype.Service; 7 | 8 | @Service 9 | public class TestService { 10 | 11 | public String testQuery(long id){ 12 | return "Test query success, id is " + id; 13 | } 14 | 15 | public static void main(String[] args) { 16 | Binding groovyBinding = new Binding(); 17 | groovyBinding.setVariable("testService", new TestService()); 18 | GroovyShell groovyShell = new GroovyShell(groovyBinding); 19 | 20 | String scriptContent = "import pers.doublebin.example.groovy.script.service.TestService\n" + 21 | "def query = new TestService().testQuery(1L);\n" + 22 | "query"; 23 | 24 | /*String scriptContent = "def query = testService.testQuery(2L);\n" + 25 | "query";*/ 26 | 27 | Script script = groovyShell.parse(scriptContent); 28 | System.out.println(script.run()); 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/double-bin/groovy-script-example/cf5bd5bd56509019a97be90f50fb99a331158c4d/src/main/resources/application.properties -------------------------------------------------------------------------------- /src/test/java/pers/doublebin/example/groovy/script/GroovyScriptExampleApplicationTests.java: -------------------------------------------------------------------------------- 1 | package pers.doublebin.example.groovy.script; 2 | 3 | import org.junit.Test; 4 | import org.junit.runner.RunWith; 5 | import org.springframework.boot.test.context.SpringBootTest; 6 | import org.springframework.test.context.junit4.SpringRunner; 7 | 8 | @RunWith(SpringRunner.class) 9 | @SpringBootTest 10 | public class GroovyScriptExampleApplicationTests { 11 | 12 | @Test 13 | public void contextLoads() { 14 | } 15 | 16 | } 17 | --------------------------------------------------------------------------------