compelet the compile api

src/main/java/com/googlecode/aviator/AviatorEvaluator.java

@@ -472,6 +472,19 @@ public static Expression getCachedExpression(final String expression) {
     return getInstance().getCachedExpression(expression);
   }
 
+  /**
+   * Compile a text expression to Expression object and cache it with the specified cache key
+   *
+   * @param cacheKey cache key
+   * @param expression text expression
+   * @param cached Whether to cache the compiled result,make true to cache it.
+   * @return
+   */
+  public static Expression compile(final String cacheKey, final String expression,
+      final boolean cached) {
+    return getInstance().compile(cacheKey, expression, cached);
+  }
+
 
   /**
    * Compile a text expression to Expression object
@@ -519,6 +532,19 @@ public static Object exec(final String expression, final Object... values) {
     return getInstance().exec(expression, values);
   }
 
+  /**
+   * Execute a text expression with environment
+   *
+   * @param cacheKey unique key for caching
+   * @param expression text expression
+   * @param env Binding variable environment
+   * @param cached Whether to cache the compiled result,make true to cache it.
+   */
+  public static Object execute(final String cacheKey, final String expression,
+      final Map<String, Object> env, final boolean cached) {
+    return getInstance().execute(cacheKey, expression, env, cached);
+  }
+
 
   /**
    * Execute a text expression with environment

src/main/java/com/googlecode/aviator/AviatorEvaluatorInstance.java

@@ -284,8 +284,8 @@ public void setEnvProcessor(final EnvProcessor envProcessor) {
   /**
    * Compile a script file into expression.
    *
-   * @param file the script file path
-   * @param cached whether to cached the compiled result with key is script file's absolute path.
+   * @param path the script file path
+   * @param cached whether to cache the compiled result with key is script file's absolute path.
    * @since 5.0.0
    * @return the compiled expression instance.
    */
@@ -356,10 +356,9 @@ private File tryFindFileFromClassLoader(final String path, final ClassLoader con
   }
 
   /**
-   * Loads a script from path and return it's exports.
+   * Loads a script from path and return its exports.
    *
-   * @param path
-   * @param args arguments to execute the script.
+   * @param path the script file path
    * @throws IOException
    * @return the exports map.
    * @since 5.0.0
@@ -389,10 +388,9 @@ private Map<String, Object> executeModule(final Expression exp, final String abP
 
 
   /**
-   * Loads a script from path and return it's exports with module caching.
+   * Loads a script from path and return its exports with module caching.
    *
-   * @param path
-   * @param args arguments to execute the script.
+   * @param path the script file path
    * @throws IOException
    * @return the exports map
    * @since 5.0.0
@@ -902,7 +900,7 @@ private void loadModule() {
   }
 
   /**
-   * Set a alias name for function specified by name
+   * Set alias name for function specified by name
    *
    * @param name the origin function name
    * @param aliasName the alias function name
@@ -1304,7 +1302,7 @@ public AviatorFunction getFunction(final String name) {
    * Retrieve an aviator function by name,throw exception if not found or null.It's not thread-safe.
    *
    * @param name
-   * @param symbolTablee
+   * @param symbolTable
    * @return
    */
   public AviatorFunction getFunction(final String name, final SymbolTable symbolTable) {
@@ -1655,17 +1653,17 @@ public Object exec(final String expression, final Object... values) {
     }
   }
 
-
   /**
    * Execute a text expression with environment
    *
+   * @param cacheKey unique key for caching
    * @param expression text expression
    * @param env Binding variable environment
    * @param cached Whether to cache the compiled result,make true to cache it.
    */
-  public Object execute(final String expression, final Map<String, Object> env,
-      final boolean cached) {
-    Expression compiledExpression = compile(expression, cached);
+  public Object execute(final String cacheKey, final String expression,
+      final Map<String, Object> env, final boolean cached) {
+    Expression compiledExpression = compile(cacheKey, expression, cached);
     if (compiledExpression != null) {
       return compiledExpression.execute(env);
     } else {
@@ -1674,6 +1672,19 @@ public Object execute(final String expression, final Map<String, Object> env,
   }
 
 
+  /**
+   * Execute a text expression with environment
+   *
+   * @param expression text expression
+   * @param env Binding variable environment
+   * @param cached Whether to cache the compiled result,make true to cache it.
+   */
+  public Object execute(final String expression, final Map<String, Object> env,
+      final boolean cached) {
+    return execute(expression, expression, env, cached);
+  }
+
+
   /**
    * Execute a text expression without caching
    *

src/test/java/com/googlecode/aviator/AviatorEvaluatorInstanceUnitTest.java

@@ -640,6 +640,17 @@ public void evaluatorWithCache() {
     assertEquals("hello world", this.instance.execute("a+b", env, true));
   }
 
+  @Test
+  public void evaluatorWithSpecifiedCacheKey() {
+    Map<String, Object> env = new HashMap<>();
+    env.put("a", "hello");
+    env.put("b", " world");
+    assertEquals("hello world", this.instance.execute("key", "a + b", env, true));
+    final Expression expression = this.instance.getCachedExpressionByKey("key");
+    assertNotNull(expression);
+    assertEquals("hello world", expression.execute(env));
+  }
+
 
   @Test(expected = UnsupportedFeatureException.class)
   public void testDisableAssignment() {

src/test/java/com/googlecode/aviator/AviatorEvaluatorUnitTest.java

@@ -24,6 +24,7 @@
 import java.math.MathContext;
 import java.util.HashMap;
 import java.util.Map;
+import com.googlecode.aviator.utils.Utils;
 import org.junit.Test;
 import com.googlecode.aviator.exception.CompileExpressionErrorException;
 
@@ -126,6 +127,18 @@ public void testExecIllegalArguments() {
     AviatorEvaluator.exec("a-b+c", 1, 2);
   }
 
+  @Test
+  public void testCompileCacheWithSpecifiedCacheKey() {
+    String expression = "1+3";
+    Expression exp1 = AviatorEvaluator.compile(Utils.md5sum(expression), expression, true);
+    Expression exp2 = AviatorEvaluator.compile(Utils.md5sum(expression), expression, true);
+    assertNotNull(exp1);
+    assertNotNull(exp2);
+    assertSame(exp1, exp2);
+
+    assertEquals(4, exp1.execute(null));
+    assertEquals(4, exp2.execute(null));
+  }
 
   @Test
   public void testCompileCache() {
@@ -177,6 +190,17 @@ public void evaluatorWithCache() {
     assertEquals("hello world", AviatorEvaluator.execute("a+b", env, true));
   }
 
+  @Test
+  public void evaluatorWithSpecifiedCacheKey() {
+    Map<String, Object> env = new HashMap<>();
+    env.put("a", "hello");
+    env.put("b", " world");
+    assertEquals("hello world", AviatorEvaluator.execute("key", "a + b", env, true));
+    final Expression expression = AviatorEvaluator.getInstance().getCachedExpressionByKey("key");
+    assertNotNull(expression);
+    assertEquals("hello world", expression.execute(env));
+  }
+
 
   @Test(expected = CompileExpressionErrorException.class)
   public void compileBlankExpression1() {