Raving about software, photography, crossfit and legos...

Once upon a time, I had a Servlet making expensive queries, about 3 seconds per request, using plain JDBC. Something to worry about if you already know that the servlet is placed in a high traffic website, and high means more than 10 million hits daily. Obviously without any cache mechanism in the middle the solution would be far from being acceptable to move to production.

To help to prevent this issue, Servlets can use a filter cache that would process all the incoming requests and evaluate if a cache entry is available to return or a db call should be made.

So, here is an implementation example using eh-cache web on a fictional “myServlet“:

1. How to set up the cache:

If you project is using maven, be sure to add the ehcache-web dependency:

<dependency>
<groupId>net.sf.ehcache</groupId>
<artifactId>ehcache-web</artifactId>
<version>2.0.0</version>
</dependency>

Probably you will need to add the slf4j dependency as well, if you are interested in log the cache manager messages.

<dependency>
<groupId>net.sf.ehcache</groupId>
<artifactId>ehcache-web</artifactId>
<version>2.0.0</version>
</dependency>

If you are not using maven, be sure to add the corresponding jar files to your classpath (including .jar dependencies).

then create or edit your ehcache.xml file, adding a new cache object. i.e.

<cache name="CachePageCachingFilter"
maxElementsInMemory="500"
eternal="false"
timeToIdleSeconds="300"
timeToLiveSeconds="300"  //5 minutes
overflowToDisk="true">
</cache>

the ehcache.xml, should be placed inside your classpath, i.e. /src/main/resources folder.

2. Create your cache servlet filter:

Basically, you need to create a filter that extends net.sf.ehcache.constructs.web.filter.CachingFilter class, you can see a good example of how to do this in the provided class net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter . its likely override protected String calculateKey(HttpServletRequest httpRequest) method, in order to give a specific order to your request parameters or add more information to the cache key.

3.Set up the filter:

As any other servlet filter, it must be configured in the web.xml file, first declaring it:

<filter>
<display-name>CacheFilter</display-name>
<filter-name>CacheFilter</filter-name>
<filter-class>billyto.examples.MyCacheFilter</filter-class>
<!--    <filter-class>net.sf.ehcache.constructs.web.filter.SimplePageCachingFilter</filter-class>  -->
<init-param>
<param-name>suppressStackTraces</param-name>
<param-value>false</param-value>
</init-param>
<init-param>
<param-name>cacheName</param-name>
<param-value>CachePageCachingFilter</param-value>   <!-- same name as ehcache.xml -->
</init-param>
</filter>

and then, mapping it BEFORE your servlet mapping. i.e

<filter-mapping>
<filter-name>CacheFilter</filter-name>
<url-pattern>/example/retrieve-data</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>INCLUDE</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>

<servlet>
<display-name>MyServlet</display-name>
<servlet-name>MyServlet</servlet-name>
<servlet-class>billyto.example.MyServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>MyServlet</servlet-name>
<url-pattern>/example/retrieve-data</url-pattern>
</servlet-mapping>

4. Try it.

You can include a date in your servlet response, and check if the time is changing between request(no cache) or if it remains the same (cached response).

Additionally if you need to condition the cache calling, you can also override the method:  protected void doFilter(final HttpServletRequest request, final HttpServletResponse response,final FilterChain chain) And set some logic to execute the cache, invoking super.doFilter(…) or  moving the execution to the next chain level with chain.doFilter(…)

EHCache have pretty good documentation and active forums, for more information you can go here.