Spring Boot — Caching | Code Factory

6 min readApr 23, 2020

Reference Link : Link
Donate : Link

Spring has some nice features around caching and the abstraction on the spring cache API is very much simple to use.

`1. What is caching?`

Caching is a mechanism to enhance the performance of a system. It is a temporary memory that lies between the application and the persistent database. Cache memory stores recently used data items in order to reduce the number of database hits as much as possible.

1.1. Why we need caching?

Caching of frequently used data in application is a very popular technique to increase performance of application. With caching, we store such frequently accessed data in memory to avoid hitting the costly backends every time when user requests the data. Data access from memory is always faster in comparison to fetching from storage like database, file system or other service calls.

1.2. What data should be cached?

This is mostly opinionated decision about the type of data which should reside in cache and go through cache lifecycle. It varies in different scenario and requirement on how much time we can tolerate stale data.

So caching candidates will vary on each project, still those are few examples of caching –

List of products available in an eCommerce store
Any Master data which is not frequently changed
Any frequently used database read query, where result does not change in each call at least for a specific period.

`2. Types of cache`

2.1. In-memory caching

This is the most frequently used area where caching is used extensively to increase performance of the application. In-memory caches such as Memcached and Radis are key-value stores between your application and your data storage. Since the data is held in RAM, it is much faster than typical databases where data is stored on disk.

RAM is more limited than disk, so cache invalidation algorithms such as Least Recently Used (LRU) can help invalidate ‘cold’ entries and keep ‘hot’ data in RAM. Memcached is in-momory caching where Redis is more advanced which allows us to backup and restore facility as well as it is distributed caching tool where we can manage caching in distributed clusters.

2.2. Database caching

Your database usually includes some level of caching in a default configuration, optimized for a generic use case. Tweaking these settings for specific usage patterns can further boost performance. One popular in this area is first level cache of Hibernate or any ORM frameworks.

2.3. Web server caching

Reverse proxies and caches such as Varnish can serve static and dynamic content directly. Web servers can also cache requests, returning responses without having to contact application servers. In today’s API age, this option is a viable if we want to cache API responses in web server level.

2.4. CDN caching

Caches can be located on the client side (OS or browser), server side, or in a distinct cache layer.

`3. Spring boot cache annotations`

Spring framework provides cache abstraction api for different cache providers. The usage of the API is very simple, yet very powerful. Today we will see the annotation based Java configuration on caching. Note that we can achieve similar functionality through XML configuration as well.

3.1. @EnableCaching

It enables Spring’s annotation-driven cache management capability. In spring boot project, we need to add it to the boot application class annotated with @SpringBootApplication. Spring provides one concurrent hashmap as default cache, but we can override CacheManager to register external cache providers as well easily.

3.2. @Cacheable

It is used on the method level to let spring know that the response of the method are cacheable. Spring manages the request/response of this method to the cache specified in annotation attribute. For example, @Cacheable ("cacheName1", “cacheName2”).

@Cacheable annotation has more options. Like we can specify the key of the cache from the request of the method. If nothing specified, spring uses all the class fields and use those as cache key (mostly HashCode) to maintain caching but we can override this behavior by providing key information.

@Cacheable(value="employee", key="#location")
public Employee findEmployee(Location location)@Cacheable(value="employee", key="#location.name")
public Employee findEmployee(Location location)@Cacheable(value="employee", key="T(classType).hash(location)")
public Employee findEmployee(Location location)

We can also use conditional caching as well. For example,

@Cacheable(value="employee", key="#locationName.length > 5")
public Employee findEmployee(String locationName)

3.3. @CachePut

Sometimes we need to manipulate the cacheing manually to put (update) cache before method call. This will allow us to update the cache and will also allow the method to be executed. The method will always be executed and its result placed into the cache (according to the @CachePut options).

It supports the same options as @Cacheable and should be used for cache population rather then method flow optimization.

Note that using @CachePut and @Cacheable annotations on the same method is generally discouraged because they have different behaviors. While the latter causes the method execution to be skipped by using the cache, the former forces the execution in order to execute a cache update.
This leads to unexpected behavior and with the exception of specific corner-cases (such as annotations having conditions that exclude them from each other), such declarations should be avoided.

3.4. @CacheEvict

It is used when we need to evict (remove) the cache previously loaded of master data. When CacheEvict annotated methods will be executed, it will clear the cache.

We can specify key here to remove cache, if we need to remove all the entries of the cache then we need to use allEntries=true. This option comes in handy when an entire cache region needs to be cleared out – rather then evicting each entry (which would take a long time since it is inefficient), all the entries are removed in one operation.

3.5. @Caching

This annotation is required when we need both CachePut and CacheEvict at the same time.

`4. How to register a cache engine with spring boot`

Spring boot provides integration with following cache providers. Spring boot does the auto configuration with default options if those are present in class path and we have enabled cache by @EnableCaching in the spring boot application.

JCache (JSR-107) (EhCache 3, Hazelcast, Infinispan, and others)
EhCache 2.x
Hazelcast
Infinispan
Couchbase
Redis
Caffeine
Simple cache

We can override specific cache behaviors in Spring boot by overriding the cache provider specific settings — for example-

spring.cache.infinispan.config=infinispan.xml

For details information this we can see the official spring boot documentation here

`5. Spring boot caching example`

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>2.2.0.RELEASE</version>
  <relativePath/> <!-- lookup parent from repository -->
 </parent>
 <groupId>com.codeFactory</groupId>
 <artifactId>spring-boot-caching</artifactId>
 <version>0.0.1-SNAPSHOT</version>
 <name>spring-boot-caching</name>
 <description>Demo project for Spring Boot Caching</description><properties>
  <java.version>1.8</java.version>
 </properties><dependencies>
  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
  </dependency><dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-test</artifactId>
   <scope>test</scope>
   <exclusions>
    <exclusion>
     <groupId>org.junit.vintage</groupId>
     <artifactId>junit-vintage-engine</artifactId>
    </exclusion>
   </exclusions>
  </dependency>
 </dependencies><build>
  <plugins>
   <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
   </plugin>
  </plugins>
 </build></project>

SpringBootCachingApplication.java

package com.codeFactory;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;/**
 * @author code.factory
 *
 */@SpringBootApplication
@EnableCaching
public class SpringBootCachingApplication {public static void main(String[] args) {
  SpringApplication.run(SpringBootCachingApplication.class, args);
 }}

StudentController.java

package com.codeFactory.controller;import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;import com.codeFactory.model.Student;
import com.codeFactory.service.StudentService;/**
 * @author code.factory
 *
 */@RestController
public class StudentController {@Autowired
 StudentService studentService;
 
 @GetMapping("/student/{id}")
 public Student findStudentByID(@PathVariable String id) {
  System.out.println("Student ID : " + id);
  return studentService.getStudentByID(id);
 }
}

Student.java

package com.codeFactory.model;/**
 * @author code.factory
 *
 */
public class Student {String id;
 String name;
 int age;
 
 public Student(String id, String name, int age) {
  this.id = id;
  this.name = name;
  this.age = age;
 }public String getId() {
  return id;
 }public void setId(String id) {
  this.id = id;
 }public String getName() {
  return name;
 }public void setName(String name) {
  this.name = name;
 }public int getAge() {
  return age;
 }public void setAge(int age) {
  this.age = age;
 }}

StudentService.java

package com.codeFactory.service;import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;import com.codeFactory.model.Student;/**
 * @author code.factory
 *
 */@Service
public class StudentService {@Cacheable("student")
 public Student getStudentByID(String id) {
  try {
   System.out.println("Sleep for 5 seconds.");
   Thread.sleep(5000);
  } catch (InterruptedException e) {
   e.printStackTrace();
  }
  return new Student("1", "Code Factory", 18);
 }
}

Hit Url : http://localhost:8080/student/1

You will get one JSON response of a Student object. To notice, first time, the response will take at least 5 seconds to response, then subsequent responses of the same url will be faster.

Student ID : 1
Sleep for 5 seconds.
Student ID : 1
Student ID : 1
Student ID : 1
Student ID : 1
Student ID : 2
Sleep for 5 seconds.
Student ID : 2
Student ID : 2