Allow customization of @CacheFor cache key playframework#1133

article-dev · Jun 19, 2017 · 811a235 · 811a235
1 parent 5e564b5
commit 811a235
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 4 deletions.
diff --git a/framework/src/play/cache/CacheFor.java b/framework/src/play/cache/CacheFor.java
@@ -17,4 +17,5 @@
 public @interface CacheFor {
     String value() default "1h";
     String id() default "";
+    Class<? extends CacheKeyGenerator> generator() default DefaultCacheKeyGenerator.class;
 }
diff --git a/framework/src/play/cache/CacheKeyGenerator.java b/framework/src/play/cache/CacheKeyGenerator.java
@@ -0,0 +1,10 @@
+package play.cache;
+
+import play.mvc.Http.Request;
+
+/**
+ * Allow custom cache key to be used by applications.
+ */
+public interface CacheKeyGenerator {
+	public String generate(Request request);
+}
diff --git a/framework/src/play/cache/DefaultCacheKeyGenerator.java b/framework/src/play/cache/DefaultCacheKeyGenerator.java
@@ -0,0 +1,13 @@
+package play.cache;
+
+import play.mvc.Http.Request;
+
+/**
+ * The Default Cache Key Generator
+ */
+public class DefaultCacheKeyGenerator implements CacheKeyGenerator {
+	@Override
+	public String generate(Request request) {
+		return "urlcache:" + request.url + request.querystring;
+	}
+}
diff --git a/framework/src/play/mvc/ActionInvoker.java b/framework/src/play/mvc/ActionInvoker.java
@@ -147,11 +147,15 @@ public static void invoke(Http.Request request, Http.Response response) {
 
                 // Check the cache (only for GET or HEAD)
                 if ((request.method.equals("GET") || request.method.equals("HEAD")) && actionMethod.isAnnotationPresent(CacheFor.class)) {
-                    cacheKey = actionMethod.getAnnotation(CacheFor.class).id();
+                    CacheFor cacheFor = actionMethod.getAnnotation(CacheFor.class);;
+                    cacheKey = cacheFor.id();
                     if ("".equals(cacheKey)) {
-                        cacheKey = "urlcache:" + request.url + request.querystring;
+                        // Generate a cache key for this request
+                        cacheKey = cacheFor.generator().newInstance().generate(request);
+                    }
+                    if(cacheKey != null && !"".equals(cacheKey)) {
+                    	actionResult = (Result) Cache.get(cacheKey);
                     }
-                    actionResult = (Result) Cache.get(cacheKey);
                 }
 
                 if (actionResult == null) {
@@ -161,7 +165,7 @@ public static void invoke(Http.Request request, Http.Response response) {
             } catch (Result result) {
                 actionResult = result;
                 // Cache it if needed
-                if (cacheKey != null) {
+                if (cacheKey != null && !"".equals(cacheKey)) {
                     Cache.set(cacheKey, actionResult, actionMethod.getAnnotation(CacheFor.class).value());
                 }
             } catch (JavaExecutionException e) {