Add CachePut annotation (#102)

thibaultmeyer · web-flow · commit 117743d28b39 · 2023-04-07T08:43:16.000+02:00
Signed-off-by: Thibault Meyer &lt;meyer.thibault@gmail.com&gt;
diff --git a/voidframework-cache/src/main/java/dev/voidframework/cache/annotation/CachePut.java b/voidframework-cache/src/main/java/dev/voidframework/cache/annotation/CachePut.java
@@ -0,0 +1,33 @@
+package dev.voidframework.cache.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotation indicating that the result of the method will
+ * be cached regardless cache value already exists.
+ *
+ * @since 1.7.0
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface CachePut {
+
+    /**
+     * Key of the cache in which result is stored.
+     *
+     * @return Key of the cache in which result is stored
+     * @since 1.7.0
+     */
+    String key() default "{class}.{method}";
+
+    /**
+     * Retention time (in seconds).
+     *
+     * @return Retention time (in seconds)
+     * @since 1.7.0
+     */
+    int timeToLive() default -1;
+}
diff --git a/voidframework-cache/src/main/java/dev/voidframework/cache/module/CacheInterceptorPut.java b/voidframework-cache/src/main/java/dev/voidframework/cache/module/CacheInterceptorPut.java
@@ -0,0 +1,28 @@
+package dev.voidframework.cache.module;
+
+import dev.voidframework.cache.annotation.CachePut;
+import org.aopalliance.intercept.MethodInvocation;
+
+/**
+ * Intercepts method call when annotation {@link CachePut} is used.
+ *
+ * @since 1.7.0
+ */
+public final class CacheInterceptorPut extends CacheInterceptor {
+
+    @Override
+    public Object invoke(final MethodInvocation methodInvocation) throws Throwable {
+
+        if (cacheEngine == null) {
+            return methodInvocation.proceed();
+        }
+
+        final CachePut cachePut = methodInvocation.getMethod().getAnnotation(CachePut.class);
+        final String cacheKey = resolveCacheKey(methodInvocation, cachePut.key());
+
+        final Object value = methodInvocation.proceed();
+        this.cacheEngine.set(cacheKey, value, cachePut.timeToLive());
+
+        return value;
+    }
+}
diff --git a/voidframework-cache/src/main/java/dev/voidframework/cache/module/CacheModule.java b/voidframework-cache/src/main/java/dev/voidframework/cache/module/CacheModule.java
@@ -2,6 +2,7 @@
 
 import com.google.inject.AbstractModule;
 import com.google.inject.matcher.Matchers;
+import dev.voidframework.cache.annotation.CachePut;
 import dev.voidframework.cache.annotation.CacheRemove;
 import dev.voidframework.cache.annotation.CacheResult;
 import dev.voidframework.cache.engine.CacheEngine;
@@ -16,12 +17,16 @@ public final class CacheModule extends AbstractModule {
     @Override
     protected void configure() {
 
+        final CacheInterceptor cacheInterceptorPut = new CacheInterceptorPut();
         final CacheInterceptor cacheInterceptorRemove = new CacheInterceptorRemove();
         final CacheInterceptor cacheInterceptorResult = new CacheInterceptorResult();
 
+        requestInjection(cacheInterceptorPut);
         requestInjection(cacheInterceptorRemove);
         requestInjection(cacheInterceptorResult);
+
         bind(CacheEngine.class).toProvider(CacheEngineProvider.class);
+        bindInterceptor(Matchers.any(), Matchers.annotatedWith(CachePut.class), cacheInterceptorPut);
         bindInterceptor(Matchers.any(), Matchers.annotatedWith(CacheRemove.class), cacheInterceptorRemove);
         bindInterceptor(Matchers.any(), Matchers.annotatedWith(CacheResult.class), cacheInterceptorResult);
     }
