├── .gitignore ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── README.md ├── go ├── go_debug ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── main ├── java │ └── com │ │ └── marcuseisele │ │ └── example │ │ └── twolayercache │ │ ├── TwolayercacheApplication.java │ │ ├── aop │ │ ├── TwoLayerRedisCacheable.java │ │ └── TwoLayerRedisCacheableAspect.java │ │ ├── config │ │ ├── CacheConfigurationProperties.java │ │ ├── TwoLayerRedisCacheLocalConfig.java │ │ └── TwoLayerRedisConfiguration.java │ │ ├── example │ │ ├── ExampleController.java │ │ └── OrderService.java │ │ └── model │ │ ├── AnotherDTO.java │ │ └── Order.java └── resources │ └── application.properties └── test └── java └── com └── marcuseisele └── example └── twolayercache └── TwolayercacheApplicationTests.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/ -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eiselems/spring-redis-two-layer-cache/d75c59d167d5c12c373462c4c369c8095bae0b7d/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.5.4/apache-maven-3.5.4-bin.zip 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # spring-redis-two-layer-cache 2 | 3 | A Cache which instead of evicting an entry on expiration keeps it until it is able to get new Data. 4 | 5 | Technically this is done via Spring AOP. 6 | We create an Around Advice which is guarding our real invocation. 7 | 8 | It was created as a drop-in replacement for @Cacheable. 9 | 10 | ## Usage 11 | 12 | The usage is pretty similar to @Cacheable known from the Spring Cache Abstraction. 13 | 14 | ```java 15 | @Service 16 | public class OrderService { 17 | 18 | @TwoLayerRedisCacheable(firstLayerTtl = 1L, secondLayerTtl = 5L, key = "'orders_'.concat(#id).concat(#another)") 19 | public Order getOrder(int id, String other, String another) { 20 | Order order = getOrderViaHTTP(id); 21 | return order; 22 | } 23 | } 24 | ``` 25 | -------------------------------------------------------------------------------- /go: -------------------------------------------------------------------------------- 1 | mvn clean spring-boot:run 2 | -------------------------------------------------------------------------------- /go_debug: -------------------------------------------------------------------------------- 1 | mvn spring-boot:run -Drun.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005" 2 | -------------------------------------------------------------------------------- /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 Mingw, 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 | ########################################################################################## 204 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 205 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 206 | ########################################################################################## 207 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 208 | if [ "$MVNW_VERBOSE" = true ]; then 209 | echo "Found .mvn/wrapper/maven-wrapper.jar" 210 | fi 211 | else 212 | if [ "$MVNW_VERBOSE" = true ]; then 213 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 214 | fi 215 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 216 | while IFS="=" read key value; do 217 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 218 | esac 219 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 220 | if [ "$MVNW_VERBOSE" = true ]; then 221 | echo "Downloading from: $jarUrl" 222 | fi 223 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 224 | 225 | if command -v wget > /dev/null; then 226 | if [ "$MVNW_VERBOSE" = true ]; then 227 | echo "Found wget ... using wget" 228 | fi 229 | wget "$jarUrl" -O "$wrapperJarPath" 230 | elif command -v curl > /dev/null; then 231 | if [ "$MVNW_VERBOSE" = true ]; then 232 | echo "Found curl ... using curl" 233 | fi 234 | curl -o "$wrapperJarPath" "$jarUrl" 235 | else 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Falling back to using Java to download" 238 | fi 239 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 240 | if [ -e "$javaClass" ]; then 241 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 242 | if [ "$MVNW_VERBOSE" = true ]; then 243 | echo " - Compiling MavenWrapperDownloader.java ..." 244 | fi 245 | # Compiling the Java class 246 | ("$JAVA_HOME/bin/javac" "$javaClass") 247 | fi 248 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 249 | # Running the downloader 250 | if [ "$MVNW_VERBOSE" = true ]; then 251 | echo " - Running MavenWrapperDownloader.java ..." 252 | fi 253 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 254 | fi 255 | fi 256 | fi 257 | fi 258 | ########################################################################################## 259 | # End of extension 260 | ########################################################################################## 261 | 262 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 263 | if [ "$MVNW_VERBOSE" = true ]; then 264 | echo $MAVEN_PROJECTBASEDIR 265 | fi 266 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 267 | 268 | # For Cygwin, switch paths to Windows format before running java 269 | if $cygwin; then 270 | [ -n "$M2_HOME" ] && 271 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 272 | [ -n "$JAVA_HOME" ] && 273 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 274 | [ -n "$CLASSPATH" ] && 275 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 276 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 277 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 278 | fi 279 | 280 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 281 | 282 | exec "$JAVACMD" \ 283 | $MAVEN_OPTS \ 284 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 285 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 286 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 287 | -------------------------------------------------------------------------------- /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 set title of command window 39 | title %0 40 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 124 | FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO ( 125 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | echo Found %WRAPPER_JAR% 132 | ) else ( 133 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 134 | echo Downloading from: %DOWNLOAD_URL% 135 | powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')" 136 | echo Finished downloading %WRAPPER_JAR% 137 | ) 138 | @REM End of extension 139 | 140 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 141 | if ERRORLEVEL 1 goto error 142 | goto end 143 | 144 | :error 145 | set ERROR_CODE=1 146 | 147 | :end 148 | @endlocal & set ERROR_CODE=%ERROR_CODE% 149 | 150 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 151 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 152 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 153 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 154 | :skipRcPost 155 | 156 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 157 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 158 | 159 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 160 | 161 | exit /B %ERROR_CODE% 162 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 1.5.17.RELEASE 9 | 10 | 11 | com.marcuseisele.example 12 | redis-twolayercache 13 | 0.0.1-SNAPSHOT 14 | twolayercache 15 | Demo project for a two layer Cache based on Redis 16 | 17 | 18 | 1.8 19 | 20 | 21 | 22 | 23 | org.springframework.boot 24 | spring-boot-starter-aop 25 | 26 | 27 | org.springframework.boot 28 | spring-boot-starter-data-redis 29 | 30 | 31 | 32 | org.projectlombok 33 | lombok 34 | true 35 | 36 | 37 | org.springframework.boot 38 | spring-boot-starter-test 39 | test 40 | 41 | 42 | org.springframework.boot 43 | spring-boot-starter-web 44 | 45 | 46 | 47 | 48 | 49 | 50 | org.springframework.boot 51 | spring-boot-maven-plugin 52 | 53 | 54 | 55 | 56 | 57 | -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/TwolayercacheApplication.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | import org.springframework.context.annotation.EnableAspectJAutoProxy; 6 | 7 | @SpringBootApplication 8 | @EnableAspectJAutoProxy 9 | public class TwolayercacheApplication { 10 | 11 | public static void main(String[] args) { 12 | SpringApplication.run(TwolayercacheApplication.class, args); 13 | } 14 | 15 | } 16 | 17 | -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/aop/TwoLayerRedisCacheable.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache.aop; 2 | 3 | import java.lang.annotation.ElementType; 4 | import java.lang.annotation.Retention; 5 | import java.lang.annotation.RetentionPolicy; 6 | import java.lang.annotation.Target; 7 | 8 | @Target(ElementType.METHOD) 9 | @Retention(RetentionPolicy.RUNTIME) 10 | public @interface TwoLayerRedisCacheable { 11 | 12 | long firstLayerTtl() default 10L; 13 | long secondLayerTtl() default 60L; 14 | String key(); 15 | } -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/aop/TwoLayerRedisCacheableAspect.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache.aop; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import org.aspectj.lang.ProceedingJoinPoint; 5 | import org.aspectj.lang.annotation.Around; 6 | import org.aspectj.lang.annotation.Aspect; 7 | import org.aspectj.lang.annotation.Pointcut; 8 | import org.aspectj.lang.reflect.CodeSignature; 9 | import org.springframework.data.redis.core.RedisTemplate; 10 | import org.springframework.expression.Expression; 11 | import org.springframework.expression.ExpressionParser; 12 | import org.springframework.expression.spel.standard.SpelExpressionParser; 13 | import org.springframework.expression.spel.support.StandardEvaluationContext; 14 | import org.springframework.stereotype.Component; 15 | 16 | import java.util.Map; 17 | import java.util.concurrent.TimeUnit; 18 | 19 | @Aspect 20 | @Component 21 | @Slf4j //Lombok annotation for getting a Slf4j logger accessible via e.g. log.info("someText"); 22 | public class TwoLayerRedisCacheableAspect { 23 | 24 | private static final ExpressionParser expressionParser = new SpelExpressionParser(); 25 | 26 | private RedisTemplate redisTemplate; 27 | 28 | public TwoLayerRedisCacheableAspect(RedisTemplate redisTemplate) { 29 | this.redisTemplate = redisTemplate; 30 | } 31 | 32 | @Pointcut("@annotation(twoLayerRedisCacheable)") 33 | public void TwoLayerRedisCacheablePointcut(TwoLayerRedisCacheable twoLayerRedisCacheable) { 34 | } 35 | 36 | private StandardEvaluationContext getContextContainingArguments(ProceedingJoinPoint joinPoint) { 37 | StandardEvaluationContext context = new StandardEvaluationContext(); 38 | 39 | CodeSignature codeSignature = (CodeSignature) joinPoint.getSignature(); 40 | String[] parameterNames = codeSignature.getParameterNames(); 41 | Object[] args = joinPoint.getArgs(); 42 | 43 | for (int i = 0; i < parameterNames.length; i++) { 44 | context.setVariable(parameterNames[i], args[i]); 45 | } 46 | return context; 47 | } 48 | 49 | private String getCacheKeyFromAnnotationKeyValue(StandardEvaluationContext context, String key){ 50 | Expression expression = expressionParser.parseExpression(key); 51 | return (String) expression.getValue(context); 52 | } 53 | 54 | @Around("TwoLayerRedisCacheablePointcut(twoLayerRedisCacheable)") 55 | public Object cacheTwoLayered(ProceedingJoinPoint joinPoint, TwoLayerRedisCacheable twoLayerRedisCacheable) throws Throwable { 56 | long firstLayerTtl = twoLayerRedisCacheable.firstLayerTtl(); 57 | long secondLayerTtl = twoLayerRedisCacheable.secondLayerTtl(); 58 | String key = twoLayerRedisCacheable.key(); 59 | 60 | 61 | StandardEvaluationContext context = getContextContainingArguments(joinPoint); 62 | String cacheKey = getCacheKeyFromAnnotationKeyValue(context, key); 63 | log.info("### Cache key: {}", cacheKey); 64 | 65 | long start = System.currentTimeMillis(); 66 | 67 | Object result; 68 | if (redisTemplate.hasKey(cacheKey)) { 69 | result = redisTemplate.opsForValue().get(cacheKey); 70 | log.info("Reading from cache ..." + result.toString()); 71 | 72 | if (redisTemplate.getExpire(cacheKey, TimeUnit.MINUTES) < secondLayerTtl) { 73 | log.info("Entry passed firstLevel period - trying to refresh it"); 74 | try { 75 | result = joinPoint.proceed(); 76 | redisTemplate.opsForValue().set(cacheKey, result, secondLayerTtl + firstLayerTtl, TimeUnit.MINUTES); 77 | log.info("Fetch was successful - new value was saved and is getting returned"); 78 | } catch (Exception e) { 79 | log.warn("An error occured while trying to refresh the value - extending the existing one", e); 80 | redisTemplate.opsForValue().getOperations().expire(cacheKey, secondLayerTtl + firstLayerTtl, TimeUnit.MINUTES); 81 | } 82 | 83 | } 84 | } else { 85 | result = joinPoint.proceed(); 86 | log.info("Cache miss: Called original method"); 87 | redisTemplate.opsForValue().set(cacheKey, result, firstLayerTtl + secondLayerTtl, TimeUnit.MINUTES); 88 | } 89 | 90 | long executionTime = System.currentTimeMillis() - start; 91 | log.info("{} executed in {} ms", joinPoint.getSignature(), executionTime); 92 | log.info("Result: {}", result); 93 | return result; 94 | } 95 | } -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/config/CacheConfigurationProperties.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache.config; 2 | 3 | import lombok.Data; 4 | import org.springframework.boot.context.properties.ConfigurationProperties; 5 | 6 | import java.util.Map; 7 | 8 | @ConfigurationProperties(prefix = "cache") 9 | @Data 10 | public class CacheConfigurationProperties { 11 | private int redisPort = 6379; 12 | private String redisHost = "localhost"; 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/config/TwoLayerRedisCacheLocalConfig.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache.config; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 5 | import org.springframework.cache.CacheManager; 6 | import org.springframework.cache.annotation.CachingConfigurerSupport; 7 | import org.springframework.cache.annotation.EnableCaching; 8 | import org.springframework.context.annotation.Bean; 9 | import org.springframework.context.annotation.Configuration; 10 | import org.springframework.data.redis.cache.RedisCacheManager; 11 | import org.springframework.data.redis.connection.RedisConnectionFactory; 12 | import org.springframework.data.redis.connection.jedis.JedisConnectionFactory; 13 | import org.springframework.data.redis.core.RedisTemplate; 14 | 15 | @Configuration 16 | @EnableCaching 17 | @EnableConfigurationProperties(CacheConfigurationProperties.class) 18 | //@Profile("local") this is disabled for the example application 19 | @Slf4j 20 | //Pretty sure this is not even necessary, leaving this here since our cloud configuration is using an equivalent 21 | //config and I want to keep it similar to the "REAL" thing 22 | public class TwoLayerRedisCacheLocalConfig extends CachingConfigurerSupport { 23 | 24 | @Bean 25 | public JedisConnectionFactory redisConnectionFactory(CacheConfigurationProperties properties) { 26 | JedisConnectionFactory redisConnectionFactory = new JedisConnectionFactory(); 27 | redisConnectionFactory.setHostName(properties.getRedisHost()); 28 | redisConnectionFactory.setPort(properties.getRedisPort()); 29 | return redisConnectionFactory; 30 | } 31 | 32 | @Bean 33 | public RedisTemplate redisTemplate(RedisConnectionFactory cf) { 34 | RedisTemplate redisTemplate = new RedisTemplate<>(); 35 | redisTemplate.setConnectionFactory(cf); 36 | return redisTemplate; 37 | } 38 | 39 | @Bean 40 | public CacheManager cacheManager(RedisTemplate redisTemplate) { 41 | return new RedisCacheManager(redisTemplate); 42 | } 43 | } -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/config/TwoLayerRedisConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache.config; 2 | 3 | import org.springframework.context.annotation.Configuration; 4 | import org.springframework.context.annotation.EnableAspectJAutoProxy; 5 | 6 | @Configuration 7 | @EnableAspectJAutoProxy(proxyTargetClass = true) 8 | public class TwoLayerRedisConfiguration { 9 | 10 | } -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/example/ExampleController.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache.example; 2 | 3 | import com.marcuseisele.example.twolayercache.model.AnotherDTO; 4 | import com.marcuseisele.example.twolayercache.model.Order; 5 | import lombok.AllArgsConstructor; 6 | import org.springframework.web.bind.annotation.GetMapping; 7 | import org.springframework.web.bind.annotation.RestController; 8 | 9 | @RestController 10 | @AllArgsConstructor 11 | public class ExampleController { 12 | 13 | private OrderService orderService; 14 | 15 | 16 | @GetMapping(value = "/") 17 | public Order getOrder() { 18 | //hardcoded to make call easier 19 | int orderNumber = 42; 20 | return orderService.getOrder(orderNumber, "Test", "CacheSuffix"); 21 | } 22 | 23 | @GetMapping(value = "/another") 24 | public AnotherDTO getAnother() { 25 | //hardcoded to make call easier 26 | int orderNumber = 42; 27 | return orderService.getAnother(orderNumber, "Test", "CacheSuffix"); 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/example/OrderService.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache.example; 2 | 3 | import com.marcuseisele.example.twolayercache.aop.TwoLayerRedisCacheable; 4 | import com.marcuseisele.example.twolayercache.model.AnotherDTO; 5 | import com.marcuseisele.example.twolayercache.model.Order; 6 | import org.springframework.stereotype.Service; 7 | 8 | @Service 9 | public class OrderService { 10 | 11 | @TwoLayerRedisCacheable(firstLayerTtl = 1L, secondLayerTtl = 5L, key = "'orders_'.concat(#id).concat(#another)") 12 | public Order getOrder(int id, String other, String another) { 13 | //in reality this call is really expensive and error-prone - trust me! 14 | try { 15 | Thread.sleep(1000); 16 | } catch (InterruptedException e) { 17 | e.printStackTrace(); 18 | } 19 | return new Order(id, Math.round(Math.random() * 100000)); 20 | } 21 | 22 | @TwoLayerRedisCacheable(firstLayerTtl = 2L, secondLayerTtl = 10L, key = "'another_'.concat(#id).concat(#another)") 23 | public AnotherDTO getAnother(int id, String other, String another) { 24 | try { 25 | Thread.sleep(1000); 26 | } catch (InterruptedException e) { 27 | e.printStackTrace(); 28 | } 29 | return new AnotherDTO(id, other, another); 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/model/AnotherDTO.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache.model; 2 | 3 | import lombok.AllArgsConstructor; 4 | import lombok.Data; 5 | 6 | import java.io.Serializable; 7 | 8 | @Data 9 | @AllArgsConstructor 10 | public class AnotherDTO implements Serializable { 11 | 12 | private static final long serialVersionUID = 6076109187134928213L; 13 | 14 | private int id; 15 | private String someThing; 16 | private String anotherThing; 17 | } -------------------------------------------------------------------------------- /src/main/java/com/marcuseisele/example/twolayercache/model/Order.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache.model; 2 | 3 | import lombok.AllArgsConstructor; 4 | import lombok.Data; 5 | 6 | import java.io.Serializable; 7 | 8 | @Data 9 | @AllArgsConstructor 10 | public class Order implements Serializable { 11 | 12 | private static final long serialVersionUID = -3281088656501163895L; 13 | private int id; 14 | 15 | private long orderNumber; 16 | } 17 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eiselems/spring-redis-two-layer-cache/d75c59d167d5c12c373462c4c369c8095bae0b7d/src/main/resources/application.properties -------------------------------------------------------------------------------- /src/test/java/com/marcuseisele/example/twolayercache/TwolayercacheApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.marcuseisele.example.twolayercache; 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 TwolayercacheApplicationTests { 11 | 12 | @Test 13 | public void contextLoads() { 14 | } 15 | 16 | } 17 | 18 | --------------------------------------------------------------------------------