Spring MVC interceptor HandleInterceptorAdapter example

Issue with HandlerInterceptor is that you need to implement all the methods but if you extend to [abstract class](https://java2blog.com/abstract-class-java/ “abstract class”) called HandlerInterceptorAdapter, you can implement only those method which you want and other methods will have default implementation.

Lets implement custom interceptor example using HandlerInterceptorAdapter class.

Spring MVC interceptor example:

I am using Spring MVC hello world example here with small changes to it.

Adding Spring MVC dependency

  4.0.0
  com.arpit.java2blog
  SpringMVCHelloWorldExample
  war
  0.0.1-SNAPSHOT
  SpringMVCHelloWorldExample Maven Webapp
  http://maven.apache.org
  
    
      junit
      junit
      3.8.1
      test
    
   
     javax.servlet
     javax.servlet-api
     3.1.0
   

    
   org.springframework
   spring-core
   ${spring.version}
  
  
   org.springframework
   spring-webmvc
   ${spring.version}
  
  
  
    SpringMVCHelloWorldExample

    
        
        org.apache.maven.plugins
        maven-compiler-plugin
        3.1
        
            ${jdk.version}
            ${jdk.version}
        
    
    

  
   
  4.2.1.RELEASE
  1.7
   

Create Controller 

Create a package named “org.arpit.java2blog.springmvc.controller”
create a controller class named “HelloWorldController.java”

package org.arpit.java2blog.springmvc.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class HelloWorldController {

 @RequestMapping("/helloworld")
 public ModelAndView hello() {
      return new ModelAndView("hello");
 }
}

Create interceptor 

package org.arpit.java2blog.springmvc.interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

public class SampleInterceptor extends HandlerInterceptorAdapter {

 @Override
 public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
   throws Exception {
  request.setAttribute("blogName", "java2blog");
  return true;
 }

 @Override
 public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
   ModelAndView modelAndView) throws Exception {
  String blogName = (String) request.getAttribute("blogName");
  // We are adding some modelAndView objects here and will use it in view jsp.
  modelAndView.addObject("blogName",blogName);
  modelAndView.addObject("authorName", "Arpit");
 }

 @Override
 public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
   throws Exception {
  String blogName = (String) request.getAttribute("blogName");
  String authorName = (String) request.getAttribute("authorName");
  System.out.println("Request URL::" + request.getRequestURL().toString());
  System.out.println("Blog name : " + blogName);
  System.out.println("Author Name : " + authorName);
 }
}

Here I am setting request attribute(blogName) in preHandle method and we are getting it in postHandle method. We are also adding two objects to modelAndView which we will use in jsp.

Create view

Modify index.jsp as below

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>







Click here to read hello message 

Create hello.jsp in /WEB-INF/ folder

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>







This is written by ${authorName} on ${blogName}

Configuring spring mvc application

    Archetype Created Web Application
     
    index.jsp
  
    
  springmvc-dispatcher
  
   org.springframework.web.servlet.DispatcherServlet
        
  1
 

 
  springmvc-dispatcher
  /
 
    

create xml file named “springmvc-dispatcher-servlet.xml” in /WEB-INF folder as below.

create xml file named “springmvc-dispatcher-servlet.xml” in /WEB-INF folder as below.

 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:beans="http://www.springframework.org/schema/beans"
 xmlns:context="http://www.springframework.org/schema/context"
 xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
  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">

It ‘s time to do maven build.

Right click on project -> Run as -> Maven build

Provide goals as clean install (given below) and click on run

Run the application

Right click on project -> run as -> run on server

Select apache tomcat and click on finish

 You will see below screen:

When you click on above link, you will get below screen

We are done with Spring MVC interceptor example. If you are still facing any issue, please comment.

Download
click to begin20KB .zip