Spring MVC Interceptors Example

In this post, we feature a comprehensive Example on Spring MVC Interceptors. In spring, interceptors provide a powerful mechanism to intercept an HTTP request. In this tutorial, we will show how to implement the interceptors with the Spring MVC framework.

1. Introduction

1.1 Spring Framework

Want to master Spring Framework ?
Subscribe to our newsletter and download the Spring Framework Cookbook right now!
In order to help you master the leading and innovative Java framework, we have compiled a kick-ass guide with all its major features and use cases! Besides studying them online you may download the eBook in PDF format!

Thank you!

We will contact you soon.

1.2 Spring Mvc Framework

Model-View-Controller (Mvc) is a well-known design pattern for designing the GUI based applications. It mainly decouples the business logic from UI by separating the roles of Model, View, and Controller in an application. This pattern divides the application into three components to separate the internal representation of the information from the way it is being presented to the user. The three components are:

Fig. 1: Model View Controller (MVC) Overview

1.3 Spring MVC Interceptors

Similar to the filtering concepts in servlets, spring mvc provides a powerful mechanism to intercept an HTTP request. This mechanism intercepts an incoming request and is implemented in spring either by the org.springframework.web.servlet.HandlerInterceptor interface or the org.springframework.web.servlet.handler.HandlerInterceptorAdapter abstract class that provides the base implementation of the HandlerInterceptor interface.

1.3.1 HandlerInterceptor method

Spring HandlerInterceptor interface provides three callback methods to intercept an HTTP request. These methods provide flexibility to handle the pre-processing and post-processing activities. The callback methods that need to be implemented are:

Fig. 2: Spring MVC Interceptors Overview

1.3.2 Few important points

Now, open up the Eclipse IDE and let’s see how to implement the interceptors in the spring mvc framework!

2. Spring MVC Interceptors Example

Here is a step-by-step guide for implementing this functionality in the spring mvc framework.

2.1 Tools Used

We are using Eclipse Kepler SR2, JDK 8 and Maven. Having said that, we have tested the code against JDK 1.7 and it works well.

2.2 Project Structure

Firstly, let’s review the final project structure, in case you are confused about where you should create the corresponding files or folder later!

Fig. 3: Application Project Structure

2.3 Project Creation

This section will demonstrate how to create a Java-based Maven project with Eclipse. In Eclipse IDE, go to File -> New -> Maven Project.

Fig. 4: Create a Maven Project

In the New Maven Project window, it will ask you to select project location. By default, ‘Use default workspace location’ will be selected. Just click on next button to proceed.

Fig. 5: Project Details

Select the Maven Web App archetype from the list of options and click next.

Fig. 6: Archetype Selection

It will ask you to ‘Enter the group and the artifact id for the project’. We will input the details as shown in the below image. The version number will be by default: 0.0.1-SNAPSHOT.

Fig. 7: Archetype Parameters

Click on Finish and the creation of a maven project is completed. If you observe, it has downloaded the maven dependencies and a pom.xml file will be created. It will have the following code:


<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">

We can start adding the dependencies that developers want like Servlet API, Spring Mvc etc. Let’s start building the application!

3. Application Building

Below are the steps involved in developing this application.

3.1 Maven Dependencies

Here, we specify the dependencies for the spring mvc framework. The rest dependencies such as Spring Beans, Spring Core etc. will be automatically resolved by Maven. The updated file will have the following code:


<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 http://maven.apache.org/maven-v4_0_0.xsd">
	<name>SpringMvcInterceptors Maven Webapp</name>
		<!-- Servlet API Dependency -->
		<!-- Spring Framework Dependencies -->

3.2 Configuration Files

Let’s write all the configuration files involved in this application.

3.2.1 Web Deployment Descriptor

The web.xml file declares one servlet (i.e. Dispatcher Servlet) to receive all kind of the requests. Dispatcher servlet here acts as a front controller. Add the following code to it:


 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

3.2.2 Spring Configuration File

To configure the spring framework, developers need to implement a bean configuration file i.e. mvcinterceptorsdispatcher-servlet.xml which provide an interface between the basic Java class and the outside world. Add the following code to it:


<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
	<context:annotation-config />
	<context:component-scan base-package="com.spring.mvc" />
	<!-- Configuring interceptor -->
		<bean class="com.spring.mvc.interceptor.InitInterceptor" />
		<property name="prefix" value="/WEB-INF/views/" />
		<property name="suffix" value=".jsp" />

Do note:

3.3 Java Class Creation

3.3.1 Controller class

Let’s create a simple class where the @Controller annotation specifies this class as a spring controller and is responsible for handling the incoming request. Add the following code to it:


package com.spring.mvc;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.ModelAndView;
public class InitController {
	@RequestMapping(value= "/init", method= RequestMethod.GET)
	public ModelAndView initView() {
		System.out.println("Handler method is called.");
		ModelAndView modelview = new ModelAndView();
		modelview.addObject("message", "This is an example of mvc-interceptors in Spring framework .....!");
		return modelview;

3.3.2 Interceptor class

Let’s create the spring based HandlerInterceptor which will intercept the incoming request and print a message on the console. Add the following code to it:


package com.spring.mvc.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
public class InitInterceptor implements HandlerInterceptor {
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
		System.out.println("Pre-handle method is called.");
		return true;
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
		System.out.println("Post-handle method is called.");
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
		System.out.println("After completion method is called.");

4. Run the Application

As we are ready with all the changes, let us compile the project and deploy the application on the Tomcat7 server. To deploy the application on Tomat7, right-click on the project and navigate to Run as -> Run on Server.

Fig. 8: How to Deploy Application on Tomcat

Tomcat will deploy the application in its web-apps folder and shall start its execution to deploy the project so that we can go ahead and test it on the browser.

5. Project Demo

Open your favorite browser and hit the following URL to print the messages on the console.


Server name (localhost) and port (8082) may vary as per your tomcat configuration.

Fig. 9: Output Logs

That’s all for this tutorial and I hope the article served you whatever you were looking for. Happy Learning and don’t forget to share!

6. Conclusion

In this section, developers learned how to implement the interceptor’s functionality in the spring mvc framework. Developers can download the sample application as an Eclipse project in the Downloads section.

7. Download the Eclipse Project

This was an example of Spring MVC Interceptors.

You can download the full source code of this example here: SpringMvcInterceptors
Exit mobile version