This is a Spring Boot project that uses the Cache2K Spring integration as described in the Cache2K documentation.

1. Change to the root directory of the project.
2. Run: ./gradlew bootRun
3. Wait until you see the message Started SpringApplicationKt in the logs
4. Open http://localhost:8080 in your browser

The demo shows a list of people with some sorting and filtering options. In the demo, the data source is very slow; fortunately there's a Use Caching? checkbox that you can click to enable the use of Cache2K. After you click it, the initial request will be slow and then all subsequent requests will be fast. If you unclick it, the cache is evicted (everything is deleted from the cache) and requests will go back to being slow.

The procedure to set up Cache2K is shown below. See also the Cache2K Spring Setup documentation which provides a more general description of the procedure.

• Add dependencies for Cache2K to your build (in build.gradle.kts); specifically these lines:

	val cache2kVersion = "1.2.2.Final"
   	implementation("org.cache2k:cache2k-api:$cache2kVersion")
   	runtimeOnly("org.cache2k:cache2k-core:$cache2kVersion")
   	implementation("org.cache2k:cache2k-spring:$cache2kVersion")  

• Add dependency for spring-boot-starter-cache to your build (in build.gradle.kts)

   	implementation("org.springframework.boot:spring-boot-starter-cache")

• Add a CachingConfig.kt class (The name of the class isn't important)
  • Annotate it with @org.springframework.context.annotation.Configuration
  • Annotate it with @org.springframework.cache.annotation.EnableCaching
  • Create a fun cacheManager(): CacheManager method annotated with @Bean and create any caches that are needed for your application. See CachingConfig.kt for examples.

Cache2K is now ready to be used in your service layer. See PersonDataService.kt for an example service that uses Cache2K.

To have the results of a service method cached automatically, use the @Cacheable annotation as shown in the code sample below. The first parameter is the name of the cache that was defined in CachingConfig.kt. The key parameter is used to define the key used to look the value up in the cache (See the Spring docs for more information on key).

  @Cacheable("allPeopleCache", key = "#root.methodName")
    fun loadPeopleDataUsingCache():PeopleData {
        return loadPeopleDataFromDatabase()
    }