Caching method results with JCache

#javaee sunday, december 24, 2017

In JCache there is a handy functionality that transparently caches the result of methods. You can annotate methods of managed beans with @CacheResult and the result of the first call will be returned again without calling the actual method a second time.

import javax.cache.annotation.CacheResult;
// ...

public class Calculator {

    @CacheResult
    public String calculate() {
        // do some heavy lifting...
        LockSupport.parkNanos(2_000_000_000L);

        return "Hi Duke, it's " + Instant.now();
    }
}

If the bean is injected and the method calculate called, the result will be cached after the first call. Per default this mechanism doesn’t cache and return exceptions.

We can include the calculator in a JAX-RS resource as follows:

@Path("calculation")
public class CalculationResource {

    @Inject
    Calculator calculator;

    @GET
    public String calculation() {
        return calculator.calculate();
    }
}

Calling that HTTP resource will return the same value for all subsequent invocations.

For this example to run in Java EE application servers we for now have to declare the interceptor that is responsible for caching the result. This is due to JCache not being included in the EE umbrella. Therefore this small configuration overhead needs to be done for now.

If you want to run this example in WildFly specify the interceptor in the beans.xml:

<interceptors>
    <class>org.infinispan.jcache.annotation.CacheResultInterceptor</class>
</interceptors>

WildFly uses Infinispan that needs to be added in the pom.xml in the correct version as well.

<dependency>
    <groupId>javax.cache</groupId>
    <artifactId>cache-api</artifactId>
    <version>1.0.0</version>
</dependency>
<dependency>
    <groupId>org.infinispan</groupId>
    <artifactId>infinispan-jcache</artifactId>
    <version>8.2.4.Final</version>
</dependency>

This post was reposted from my newsletter issue 011

Found the post useful? Subscribe to my newsletter for more free content, tips and tricks on IT & Java: