├── src ├── main │ ├── resources │ │ ├── application.properties │ │ └── ScriptTemplate.groovy_template │ └── java │ │ └── com │ │ └── groovyexample │ │ ├── groovy │ │ ├── service │ │ │ ├── EngineGroovyModuleRule.java │ │ │ ├── RuleEngineGroovyExecutor.java │ │ │ ├── StrategyScriptDataSouce.java │ │ │ ├── GroovyScriptService.java │ │ │ ├── GroovyScriptTemplate.java │ │ │ └── impl │ │ │ │ ├── RuleEngineGroovyModuleRuleExecutor.java │ │ │ │ └── GroovyScriptServiceImpl.java │ │ └── bean │ │ │ ├── VariableType.java │ │ │ ├── RuleEngineExecuteContext.java │ │ │ ├── StrategyScriptEntity.java │ │ │ └── ScriptVariable.java │ │ ├── utils │ │ └── MD5Utils.java │ │ └── demo │ │ └── DemoApplication.java └── test │ └── java │ └── com │ └── groovyexample │ └── demo │ └── DemoApplicationTests.java ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── .gitignore ├── pom.xml ├── mvnw.cmd └── mvnw /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/loveurwish/RuleEngineByGroovy/HEAD/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.5.4/apache-maven-3.5.4-bin.zip 2 | -------------------------------------------------------------------------------- /src/main/resources/ScriptTemplate.groovy_template: -------------------------------------------------------------------------------- 1 | import com.groovyexample.groovy.* 2 | class %s implements EngineGroovyModuleRule { 3 | boolean run(Object context){ 4 | %s //place holder 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/service/EngineGroovyModuleRule.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.service; 2 | 3 | public interface EngineGroovyModuleRule { 4 | Boolean run(Object context, Object result); 5 | } 6 | -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/utils/MD5Utils.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.utils; 2 | 3 | public class MD5Utils { 4 | public static String getStringMD5(String input){ 5 | //TODO ADD MD5 Conversion 6 | return input; 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/service/RuleEngineGroovyExecutor.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.service; 2 | 3 | public interface RuleEngineGroovyExecutor { 4 | /** 5 | * 获取脚本执行实例 6 | */ 7 | T getInstance(String name); 8 | 9 | 10 | /** 11 | * 编译脚本并缓存 12 | */ 13 | void praseAndCache(String name, String script); 14 | } 15 | -------------------------------------------------------------------------------- /.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/ -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/demo/DemoApplication.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.demo; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class DemoApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(DemoApplication.class, args); 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /src/test/java/com/groovyexample/demo/DemoApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.demo; 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 DemoApplicationTests { 11 | 12 | @Test 13 | public void contextLoads() { 14 | } 15 | 16 | } 17 | -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/bean/VariableType.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.bean; 2 | 3 | public enum VariableType { 4 | 5 | STRING(0,"String类型"), 6 | 7 | INT(1,"int类型"); 8 | 9 | private final int value ; 10 | private final String desc ; 11 | 12 | VariableType(int value ,String desc){ 13 | this.value = value ; 14 | this.desc = desc; 15 | } 16 | 17 | public int getValue() { 18 | return value; 19 | } 20 | 21 | public String getDesc() { 22 | return desc; 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/service/StrategyScriptDataSouce.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.service; 2 | 3 | import com.groovyexample.groovy.bean.StrategyScriptEntity; 4 | import java.util.List; 5 | 6 | public interface StrategyScriptDataSouce { 7 | 8 | /** 9 | * 根据策略id查询对应表达式片段信息 10 | */ 11 | StrategyScriptEntity queryByStrategyId(Integer strategyId); 12 | 13 | 14 | List queryByStrategyIds(List strategyIds ); 15 | /** 16 | * 保存策略的执行片段 17 | */ 18 | boolean saveScript(StrategyScriptEntity strategyScriptEntity); 19 | 20 | /** 21 | * 查询所有的表达式片段 22 | */ 23 | List queryAll(); 24 | } 25 | -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/bean/RuleEngineExecuteContext.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.bean; 2 | 3 | import java.util.Map; 4 | import lombok.Data; 5 | 6 | @Data 7 | public class RuleEngineExecuteContext { 8 | 9 | /** 10 | * 业务元id,例如订单id,案件id等 11 | */ 12 | private String bizId; 13 | 14 | /** 15 | * 业务id,比如产品id或者产品组id 16 | */ 17 | private String proId; 18 | 19 | /** 20 | * 策略组ID,供使用方使用一个产品对应多个策略组的情况下使用(比如进行分流策略时) 21 | */ 22 | private Integer groupId; 23 | 24 | /** 25 | * 上下文数据 26 | */ 27 | private Map data; 28 | 29 | /** 30 | * 是否是初始节点,用于第一个节点自动迭代 31 | */ 32 | private boolean init = false; 33 | 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/bean/StrategyScriptEntity.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.bean; 2 | 3 | import java.util.Date; 4 | import lombok.Data; 5 | import org.apache.commons.lang.StringUtils; 6 | 7 | /** 8 | * script DTO 9 | */ 10 | @Data 11 | public class StrategyScriptEntity { 12 | /** 13 | * 策略id 14 | */ 15 | private Integer strategyId; 16 | 17 | /** 18 | * 脚本内容 19 | */ 20 | private String script; 21 | 22 | /** 23 | * 变量名称，类型json 24 | */ 25 | private String variables; 26 | 27 | /** 28 | * 作者 29 | */ 30 | private String author; 31 | 32 | /** 33 | * 创建时间 34 | */ 35 | private Date createTime; 36 | 37 | /** 38 | * 更新时间 39 | */ 40 | private Date updateTime; 41 | 42 | } -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/bean/ScriptVariable.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.bean; 2 | 3 | import java.io.Serializable; 4 | /** 5 | * Script variable 6 | */ 7 | public class ScriptVariable implements Serializable { 8 | 9 | private static final long serialVersionUID = 8432423423082665246L; 10 | 11 | /** 12 | * 变量名称 13 | */ 14 | private String name; 15 | 16 | /** 17 | * 变量类型 18 | */ 19 | private VariableType type; 20 | 21 | public VariableType getType() { 22 | return type; 23 | } 24 | 25 | public void setType(VariableType type) { 26 | this.type = type; 27 | } 28 | 29 | public String getName() { 30 | return name; 31 | } 32 | 33 | public void setName(String name) { 34 | this.name = name; 35 | } 36 | 37 | @Override 38 | public String toString() { 39 | final StringBuilder sb = new StringBuilder("ScriptVariable{"); 40 | sb.append("name='").append(name).append('\''); 41 | sb.append(", type='").append(type).append('\''); 42 | sb.append('}'); 43 | return sb.toString(); 44 | } 45 | } -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/service/GroovyScriptService.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.service; 2 | 3 | 4 | import com.groovyexample.groovy.bean.ScriptVariable; 5 | import com.groovyexample.groovy.bean.RuleEngineExecuteContext; 6 | import com.groovyexample.groovy.bean.StrategyScriptEntity; 7 | import java.util.List; 8 | 9 | public interface GroovyScriptService { 10 | 11 | Object fragmentEval(RuleEngineExecuteContext context,Integer strategyId); 12 | 13 | boolean booleanScript(RuleEngineExecuteContext context,Integer strategyId); 14 | /** 15 | * 存储执行脚本片段和变量 16 | * @param strategyId 17 | * @param script 18 | * @param variables 19 | */ 20 | void saveVariables(Integer strategyId, String script, List variables, String author); 21 | 22 | StrategyScriptEntity queryByStrategyId(Integer strategyId); 23 | 24 | List queryByStrategyIds(List strategyIds); 25 | 26 | /** 27 | * 测试脚本 28 | * @param scriptText 29 | * @return 30 | */ 31 | boolean scriptTest(String scriptText); 32 | 33 | /** 34 | * 加载数据库所有脚本 35 | */ 36 | void loadScript(); 37 | 38 | /** 39 | * 加载数据库所有未停用的脚本 40 | * @param isInit 是否初始化调用 41 | * @return 成功加载脚本个数 42 | */ 43 | int loadValidScript(boolean isInit); 44 | } 45 | -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/service/GroovyScriptTemplate.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.service; 2 | 3 | import java.io.BufferedReader; 4 | import java.io.IOException; 5 | import java.io.InputStream; 6 | import java.io.InputStreamReader; 7 | import java.util.Arrays; 8 | import java.util.Map; 9 | import java.util.concurrent.ConcurrentHashMap; 10 | import lombok.extern.slf4j.Slf4j; 11 | import org.apache.commons.lang.StringUtils; 12 | import org.springframework.beans.factory.InitializingBean; 13 | import org.springframework.core.io.support.PathMatchingResourcePatternResolver; 14 | import org.springframework.stereotype.Service; 15 | 16 | @Slf4j 17 | @Service 18 | public class GroovyScriptTemplate implements InitializingBean { 19 | 20 | private static final Map SCRIPT_TEMPLATE_MAP = new ConcurrentHashMap<>(); 21 | 22 | public String getScript(String fileName){ 23 | String template = SCRIPT_TEMPLATE_MAP.get(fileName); 24 | if(StringUtils.isEmpty(template)){ 25 | throw new RuntimeException(String.format("请添加脚本模板: %s 到resources目录下", fileName)); 26 | } 27 | return template; 28 | } 29 | 30 | private void scriptTemplate() throws IOException { 31 | 32 | final String path = "classpath*:*.groovy_template"; 33 | PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver(); 34 | 35 | Arrays.stream(resolver.getResources(path)) 36 | .parallel() 37 | .forEach(resource -> { 38 | try { 39 | String fileName = resource.getFilename(); 40 | InputStream input = resource.getInputStream(); 41 | InputStreamReader reader = new InputStreamReader(input); 42 | BufferedReader br = new BufferedReader(reader); 43 | StringBuilder template = new StringBuilder(); 44 | 45 | for (String line; (line = br.readLine()) != null; ) { 46 | template.append(line).append("\n"); 47 | } 48 | 49 | SCRIPT_TEMPLATE_MAP.put(fileName, template.toString()); 50 | log.info("load script template :{}", resource.getURL()); 51 | } catch (Exception e) { 52 | log.error("read file failed", e); 53 | } 54 | }); 55 | } 56 | 57 | @Override 58 | public void afterPropertiesSet() throws Exception { 59 | this.scriptTemplate(); 60 | } 61 | } -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/service/impl/RuleEngineGroovyModuleRuleExecutor.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.service.impl; 2 | 3 | import com.google.common.base.Preconditions; 4 | import com.google.common.collect.Maps; 5 | import com.groovyexample.groovy.service.RuleEngineGroovyExecutor; 6 | import com.groovyexample.groovy.service.EngineGroovyModuleRule; 7 | import com.groovyexample.groovy.service.GroovyScriptTemplate; 8 | import com.groovyexample.utils.MD5Utils; 9 | import groovy.lang.GroovyClassLoader; 10 | import java.util.Map; 11 | import lombok.extern.slf4j.Slf4j; 12 | import org.springframework.beans.factory.annotation.Autowired; 13 | import org.springframework.stereotype.Component; 14 | 15 | @Slf4j 16 | @Component 17 | public class RuleEngineGroovyModuleRuleExecutor implements 18 | RuleEngineGroovyExecutor { 19 | 20 | private Map> nameAndClass = Maps.newConcurrentMap(); 21 | 22 | private Map nameAndMd5 = Maps.newConcurrentMap(); 23 | 24 | @Autowired 25 | private GroovyScriptTemplate groovyScriptTemplate; 26 | 27 | @Override 28 | public EngineGroovyModuleRule getInstance(String name) { 29 | try { 30 | Class aClass = nameAndClass.get(name); 31 | if (aClass == null) { 32 | throw new IllegalArgumentException(String.format("script:%s not load", name)); 33 | } 34 | return aClass.newInstance(); 35 | } catch (Exception e) { 36 | throw new RuntimeException(e); 37 | } 38 | } 39 | @SuppressWarnings("unchecked") 40 | @Override 41 | public void praseAndCache(String name, String script) { 42 | try { 43 | Preconditions.checkNotNull(name); 44 | Preconditions.checkNotNull(script); 45 | String scriptBuilder = groovyScriptTemplate.getScript("ScriptTemplate.groovy_template"); 46 | String scriptClassName = RuleEngineGroovyModuleRuleExecutor.class.getSimpleName() + "_" + name; 47 | String fullScript = String.format(scriptBuilder, scriptClassName, script); 48 | 49 | String oldMd5 = nameAndMd5.get(name); 50 | String newMd5 = MD5Utils.getStringMD5(fullScript); 51 | if (oldMd5 != null && oldMd5.equals(newMd5)) { 52 | return; 53 | } 54 | 55 | GroovyClassLoader classLoader = new GroovyClassLoader(); 56 | Class aClass = classLoader.parseClass(fullScript); 57 | log.info("collection-engine load script:{} finish", name); 58 | nameAndClass.put(name, aClass); 59 | nameAndMd5.put(name, newMd5); 60 | } catch (Exception e){ 61 | throw new RuntimeException(e); 62 | } 63 | } 64 | 65 | 66 | } 67 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | com.GroovyExample 7 | demo 8 | 0.0.1-SNAPSHOT 9 | jar 10 | 11 | demo 12 | Demo project for Spring Boot 13 | 14 | 15 | org.springframework.boot 16 | spring-boot-starter-parent 17 | 2.0.5.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.codehaus.groovy 41 | groovy-all 42 | 2.4.10 43 | 44 | 45 | 46 | org.projectlombok 47 | lombok 48 | 1.16.8 49 | 50 | 51 | commons-lang 52 | commons-lang 53 | 2.6 54 | provided 55 | 56 | 57 | com.google.guava 58 | guava 59 | 21.0 60 | 61 | 62 | 63 | 64 | 65 | 66 | org.springframework.boot 67 | spring-boot-maven-plugin 68 | 69 | 70 | 71 | 72 | 73 | 74 | -------------------------------------------------------------------------------- /src/main/java/com/groovyexample/groovy/service/impl/GroovyScriptServiceImpl.java: -------------------------------------------------------------------------------- 1 | package com.groovyexample.groovy.service.impl; 2 | 3 | import com.groovyexample.groovy.bean.ScriptVariable; 4 | import com.groovyexample.groovy.bean.RuleEngineExecuteContext; 5 | import com.groovyexample.groovy.bean.StrategyScriptEntity; 6 | import com.groovyexample.groovy.service.EngineGroovyModuleRule; 7 | import com.groovyexample.groovy.service.GroovyScriptService; 8 | import com.groovyexample.groovy.service.StrategyScriptDataSouce; 9 | import java.util.Date; 10 | import java.util.List; 11 | import java.util.stream.Collectors; 12 | import lombok.extern.slf4j.Slf4j; 13 | import org.springframework.beans.factory.InitializingBean; 14 | import org.springframework.beans.factory.annotation.Autowired; 15 | import org.springframework.stereotype.Service; 16 | import org.springframework.util.CollectionUtils; 17 | 18 | @Slf4j 19 | @Service 20 | public class GroovyScriptServiceImpl implements GroovyScriptService, InitializingBean { 21 | 22 | @Autowired 23 | private RuleEngineGroovyModuleRuleExecutor groovyModuleRuleExecutor; 24 | @Autowired 25 | private StrategyScriptDataSouce strategyScriptDataSouce; 26 | 27 | @Override 28 | public void afterPropertiesSet() throws Exception { 29 | log.info("collection-engine start loading valid script..."); 30 | int count = loadValidScript(true); 31 | log.info("collection-engine finish load {} script", count); 32 | } 33 | 34 | @Override 35 | public Object fragmentEval(RuleEngineExecuteContext context, Integer strategyId) { 36 | EngineGroovyModuleRule engineGroovyModuleRule = groovyModuleRuleExecutor 37 | .getInstance("enginesScript_" + strategyId); 38 | return engineGroovyModuleRule 39 | .run(context.getData().get("context"), context.getData().get("result")); 40 | } 41 | 42 | @Override 43 | public boolean booleanScript(RuleEngineExecuteContext context, Integer strategyId) { 44 | return (Boolean) this.fragmentEval(context, strategyId); 45 | } 46 | 47 | @Override 48 | public void saveVariables(Integer strategyId, String script, List variables, 49 | String author) { 50 | 51 | StrategyScriptEntity strategyScriptEntity = new StrategyScriptEntity(); 52 | Date date = new Date(); 53 | if (CollectionUtils.isEmpty(variables)) { 54 | throw new IllegalArgumentException("Add script failed , script variables is empty"); 55 | } 56 | String variableStr = variables.toString(); 57 | strategyScriptEntity.setScript(script); 58 | strategyScriptEntity.setStrategyId(strategyId); 59 | strategyScriptEntity.setUpdateTime(date); 60 | strategyScriptEntity.setAuthor(author); 61 | strategyScriptEntity.setCreateTime(date); 62 | strategyScriptEntity.setVariables(variableStr); 63 | strategyScriptDataSouce.saveScript(strategyScriptEntity); 64 | } 65 | 66 | @Override 67 | public StrategyScriptEntity queryByStrategyId(Integer strategyId) { 68 | return strategyScriptDataSouce.queryByStrategyId(strategyId); 69 | } 70 | 71 | @Override 72 | public List queryByStrategyIds(List strategyIds) { 73 | return strategyScriptDataSouce.queryByStrategyIds(strategyIds); 74 | } 75 | 76 | @Override 77 | public boolean scriptTest(String scriptText) { 78 | try { 79 | groovyModuleRuleExecutor 80 | .praseAndCache("enginescript_" + Math.abs(scriptText.hashCode()), scriptText); 81 | return true; 82 | } catch (Exception ex) { 83 | log.error("testing failed", ex); 84 | throw new RuntimeException("testing failed", ex); 85 | } 86 | } 87 | 88 | @Override 89 | public void loadScript() { 90 | List list = strategyScriptDataSouce.queryAll(); 91 | list.forEach(item -> { 92 | String scriptText = item.getScript(); 93 | Integer strategyId = item.getStrategyId(); 94 | groovyModuleRuleExecutor.praseAndCache("enginesScript_" + strategyId, scriptText); 95 | }); 96 | } 97 | 98 | @Override 99 | public int loadValidScript(boolean isInit) { 100 | //TODO add some filter to get right valid scripts 101 | List scriptList = strategyScriptDataSouce.queryAll().parallelStream() 102 | .collect(Collectors.toList()); 103 | 104 | if (CollectionUtils.isEmpty(scriptList)) { 105 | log.info("invalid script"); 106 | return 0; 107 | } 108 | scriptList.parallelStream().forEach(item -> { 109 | String scriptText = item.getScript(); 110 | Integer strategyId = item.getStrategyId(); 111 | groovyModuleRuleExecutor.praseAndCache("enginesScript_" + strategyId, scriptText); 112 | }); 113 | 114 | return scriptList.size(); 115 | } 116 | 117 | } 118 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM http://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 39 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 40 | 41 | @REM set %HOME% to equivalent of $HOME 42 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 43 | 44 | @REM Execute a user defined script before this one 45 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 46 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 47 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 48 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 49 | :skipRcPre 50 | 51 | @setlocal 52 | 53 | set ERROR_CODE=0 54 | 55 | @REM To isolate internal variables from possible post scripts, we use another setlocal 56 | @setlocal 57 | 58 | @REM ==== START VALIDATION ==== 59 | if not "%JAVA_HOME%" == "" goto OkJHome 60 | 61 | echo. 62 | echo Error: JAVA_HOME not found in your environment. >&2 63 | echo Please set the JAVA_HOME variable in your environment to match the >&2 64 | echo location of your Java installation. >&2 65 | echo. 66 | goto error 67 | 68 | :OkJHome 69 | if exist "%JAVA_HOME%\bin\java.exe" goto init 70 | 71 | echo. 72 | echo Error: JAVA_HOME is set to an invalid directory. >&2 73 | echo JAVA_HOME = "%JAVA_HOME%" >&2 74 | echo Please set the JAVA_HOME variable in your environment to match the >&2 75 | echo location of your Java installation. >&2 76 | echo. 77 | goto error 78 | 79 | @REM ==== END VALIDATION ==== 80 | 81 | :init 82 | 83 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 84 | @REM Fallback to current working directory if not found. 85 | 86 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 87 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 88 | 89 | set EXEC_DIR=%CD% 90 | set WDIR=%EXEC_DIR% 91 | :findBaseDir 92 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 93 | cd .. 94 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 95 | set WDIR=%CD% 96 | goto findBaseDir 97 | 98 | :baseDirFound 99 | set MAVEN_PROJECTBASEDIR=%WDIR% 100 | cd "%EXEC_DIR%" 101 | goto endDetectBaseDir 102 | 103 | :baseDirNotFound 104 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 105 | cd "%EXEC_DIR%" 106 | 107 | :endDetectBaseDir 108 | 109 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 110 | 111 | @setlocal EnableExtensions EnableDelayedExpansion 112 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 113 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 114 | 115 | :endReadAdditionalConfig 116 | 117 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 118 | 119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 121 | 122 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 123 | if ERRORLEVEL 1 goto error 124 | goto end 125 | 126 | :error 127 | set ERROR_CODE=1 128 | 129 | :end 130 | @endlocal & set ERROR_CODE=%ERROR_CODE% 131 | 132 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 133 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 134 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 135 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 136 | :skipRcPost 137 | 138 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 139 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 140 | 141 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 142 | 143 | exit /B %ERROR_CODE% 144 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 59 | if [ -z "$JAVA_HOME" ]; then 60 | if [ -x "/usr/libexec/java_home" ]; then 61 | export JAVA_HOME="`/usr/libexec/java_home`" 62 | else 63 | export JAVA_HOME="/Library/Java/Home" 64 | fi 65 | fi 66 | ;; 67 | esac 68 | 69 | if [ -z "$JAVA_HOME" ] ; then 70 | if [ -r /etc/gentoo-release ] ; then 71 | JAVA_HOME=`java-config --jre-home` 72 | fi 73 | fi 74 | 75 | if [ -z "$M2_HOME" ] ; then 76 | ## resolve links - $0 may be a link to maven's home 77 | PRG="$0" 78 | 79 | # need this for relative symlinks 80 | while [ -h "$PRG" ] ; do 81 | ls=`ls -ld "$PRG"` 82 | link=`expr "$ls" : '.*-> \(.*\)$'` 83 | if expr "$link" : '/.*' > /dev/null; then 84 | PRG="$link" 85 | else 86 | PRG="`dirname "$PRG"`/$link" 87 | fi 88 | done 89 | 90 | saveddir=`pwd` 91 | 92 | M2_HOME=`dirname "$PRG"`/.. 93 | 94 | # make it fully qualified 95 | M2_HOME=`cd "$M2_HOME" && pwd` 96 | 97 | cd "$saveddir" 98 | # echo Using m2 at $M2_HOME 99 | fi 100 | 101 | # For Cygwin, ensure paths are in UNIX format before anything is touched 102 | if $cygwin ; then 103 | [ -n "$M2_HOME" ] && 104 | M2_HOME=`cygpath --unix "$M2_HOME"` 105 | [ -n "$JAVA_HOME" ] && 106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 107 | [ -n "$CLASSPATH" ] && 108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 109 | fi 110 | 111 | # For Migwn, ensure paths are in UNIX format before anything is touched 112 | if $mingw ; then 113 | [ -n "$M2_HOME" ] && 114 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 115 | [ -n "$JAVA_HOME" ] && 116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 117 | # TODO classpath? 118 | fi 119 | 120 | if [ -z "$JAVA_HOME" ]; then 121 | javaExecutable="`which javac`" 122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 123 | # readlink(1) is not available as standard on Solaris 10. 124 | readLink=`which readlink` 125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 126 | if $darwin ; then 127 | javaHome="`dirname \"$javaExecutable\"`" 128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 129 | else 130 | javaExecutable="`readlink -f \"$javaExecutable\"`" 131 | fi 132 | javaHome="`dirname \"$javaExecutable\"`" 133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 134 | JAVA_HOME="$javaHome" 135 | export JAVA_HOME 136 | fi 137 | fi 138 | fi 139 | 140 | if [ -z "$JAVACMD" ] ; then 141 | if [ -n "$JAVA_HOME" ] ; then 142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 143 | # IBM's JDK on AIX uses strange locations for the executables 144 | JAVACMD="$JAVA_HOME/jre/sh/java" 145 | else 146 | JAVACMD="$JAVA_HOME/bin/java" 147 | fi 148 | else 149 | JAVACMD="`which java`" 150 | fi 151 | fi 152 | 153 | if [ ! -x "$JAVACMD" ] ; then 154 | echo "Error: JAVA_HOME is not defined correctly." >&2 155 | echo " We cannot execute $JAVACMD" >&2 156 | exit 1 157 | fi 158 | 159 | if [ -z "$JAVA_HOME" ] ; then 160 | echo "Warning: JAVA_HOME environment variable is not set." 161 | fi 162 | 163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 164 | 165 | # traverses directory structure from process work directory to filesystem root 166 | # first directory with .mvn subdirectory is considered project base directory 167 | find_maven_basedir() { 168 | 169 | if [ -z "$1" ] 170 | then 171 | echo "Path not specified to find_maven_basedir" 172 | return 1 173 | fi 174 | 175 | basedir="$1" 176 | wdir="$1" 177 | while [ "$wdir" != '/' ] ; do 178 | if [ -d "$wdir"/.mvn ] ; then 179 | basedir=$wdir 180 | break 181 | fi 182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 183 | if [ -d "${wdir}" ]; then 184 | wdir=`cd "$wdir/.."; pwd` 185 | fi 186 | # end of workaround 187 | done 188 | echo "${basedir}" 189 | } 190 | 191 | # concatenates all lines of a file 192 | concat_lines() { 193 | if [ -f "$1" ]; then 194 | echo "$(tr -s '\n' ' ' < "$1")" 195 | fi 196 | } 197 | 198 | BASE_DIR=`find_maven_basedir "$(pwd)"` 199 | if [ -z "$BASE_DIR" ]; then 200 | exit 1; 201 | fi 202 | 203 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 204 | echo $MAVEN_PROJECTBASEDIR 205 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 206 | 207 | # For Cygwin, switch paths to Windows format before running java 208 | if $cygwin; then 209 | [ -n "$M2_HOME" ] && 210 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 211 | [ -n "$JAVA_HOME" ] && 212 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 213 | [ -n "$CLASSPATH" ] && 214 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 215 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 216 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 217 | fi 218 | 219 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 220 | 221 | exec "$JAVACMD" \ 222 | $MAVEN_OPTS \ 223 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 224 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 225 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 226 | --------------------------------------------------------------------------------