Unexpected exceptions or errors can be thrown anytime during the execution of a program. In the previous post, we have already seen how the @ExceptionHandler annotation can only be applied to a single controller but what if developers want to handle the exception globally i.e. across multiple controllers. Thus, in this tutorial, we will show how to do the exception handling in Spring MVC framework by using the @ControllerAdvice annotation.
1. Introduction
1.1 Spring Framework
- Spring is an open-source framework created to address the complexity of an enterprise application development
- One of the chief advantages of the Spring framework is its layered architecture, which allows a developer to be selective about which of its components they can use while providing a cohesive framework for
J2EEapplication development - Spring framework provides support and integration to various technologies for e.g.:
- Support for Transaction Management
- Support for interaction with the different databases
- Integration with the Object Relationship frameworks for e.g. Hibernate, iBatis etc
- Support for Dependency Injection which means all the required dependencies will be resolved with the help of containers
- Support for
RESTstyle web-services
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:
- Model (M): Model’s responsibility is to manage the application’s data, business logic, and the business rules. It is a
POJOclass which encapsulates the application data given by the controller - View (V): A view is an output representation of the information, such as displaying information or reports to the user either as a text-form or as charts. Views are usually the
JSPtemplates written with Java Standard Tag Library (JSTL) - Controller (C): Controller’s responsibility is to invoke the Models to perform the business logic and then update the view based on the model’s output. In the spring framework, the controller part is played by the Dispatcher Servlet
Now, open up the Eclipse IDE and let’s see how to implement the @ControllerAdvice annotation in the spring mvc framework!
2. Spring MVC @ControllerAdvice Annotation Example
Here is a step-by-step guide for implementing this tutorial 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!
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.
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.
Select the Maven Web App archetype from the list of options and click next.
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.
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:
pom.xml
<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"> <modelVersion>4.0.0</modelVersion> <groupId>com.spring.mvc</groupId> <artifactId>SpringMvcControllerAdviceAnnotation</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>war</packaging> </project>
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:
pom.xml
<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"> <modelVersion>4.0.0</modelVersion> <groupId>com.spring.mvc</groupId> <artifactId>SpringMvcControllerAdviceAnnotation</artifactId> <packaging>war</packaging> <version>0.0.1-SNAPSHOT</version> <name>SpringMvcControllerAdviceAnnotation Maven Webapp</name> <url>http://maven.apache.org</url> <dependencies> <!-- Servlet API Dependency --> <dependency> <groupId>javax.servlet</groupId> <artifactId>servlet-api</artifactId> <version>3.0-alpha-1</version> </dependency> <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>5.0.8.RELEASE</version> </dependency> <!-- https://mvnrepository.com/artifact/javax.servlet/jstl --> <dependency> <groupId>javax.servlet</groupId> <artifactId>jstl</artifactId> <version>1.2</version> </dependency> </dependencies> <build> <finalName>SpringMvcControllerAdviceAnnotation</finalName> </build> </project>
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:
web.xml
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd" > <web-app> <display-name>SpringMvcControllerAdviceAnnotation</display-name> <servlet> <servlet-name>controlleradvicedispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>controlleradvicedispatcher</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> </web-app>
3.2.2 Spring Configuration File
To configure the spring framework, developers need to implement a bean configuration file i.e. controlleradvicedispatcher-servlet.xml which provide an interface between the basic Java class and the outside world. Add the following code to it:
controlleradvicedispatcher-servlet.xml
<?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"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="
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:component-scan base-package="com.spring.mvc.demo" />
<context:component-scan base-package="com.spring.mvc.demo.exception" />
<context:component-scan base-package="com.spring.mvc.demo.exception.advice" />
<context:annotation-config />
<!-- For resolving the view name and invoking the particular view page for
the user -->
<bean id="viewResolver"
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/" />
<property name="suffix" value=".jsp" />
</bean>
</beans>
Do note:
- This file is loaded by the spring’s Dispatcher Servlet which receives all the requests coming into the application and dispatches them to the controller for processing
- This file has the
InternalResourceViewResolverbean declaration that tells the framework how to find the physicalJSPfiles according to the logical view names returned by the controllers, by attaching the prefix and the suffix to a view name
3.3 Java Class Creation
Let’s write the Java classes involved in this application.
3.3.1 Custom Exception Class
Let’s create a simple custom exception class. In this class, we have defined the “error code” and “error message” member variables for specifying the user-defined error messages. Add the following code to the MyException.java class:
MyException.java
package com.spring.mvc.demo.exception;
import org.springframework.stereotype.Component;
@Component
public class MyException extends RuntimeException {
private static final long serialVersionUID = 1L;
private String errCode;
private String errMsg;
public MyException() { }
public MyException(String errCode, String errMsg) {
this.errCode = errCode;
this.errMsg = errMsg;
}
public String getErrCode() {
return errCode;
}
public void setErrCode(String errCode) {
this.errCode = errCode;
}
public String getErrMsg() {
return errMsg;
}
public void setErrMsg(String errMsg) {
this.errMsg = errMsg;
}
}
3.3.2 Global Exception Handler Class
Let’s create a simple exception handler class where the @ControllerAdvice annotation is used to handle the exceptions that are thrown from any spring controller defined in the application. The @ExceptionHandler annotation is used to annotate the method(s) for handling the exceptions raised during the execution of the controller methods. Add the following code to the ExceptionControllerAdvice.java class:
ExceptionControllerAdvice.java
package com.spring.mvc.demo.exception.advice;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;
import com.spring.mvc.demo.exception.MyException;
@ControllerAdvice
public class ExceptionControllerAdvice {
@ExceptionHandler(MyException.class)
public ModelAndView handleMyException(MyException mex) {
ModelAndView model = new ModelAndView();
model.addObject("errCode", mex.getErrCode());
model.addObject("errMsg", mex.getErrMsg());
model.setViewName("error/generic_error");
return model;
}
@ExceptionHandler(Exception.class)
public ModelAndView handleException(Exception ex) {
ModelAndView model = new ModelAndView();
model.addObject("errMsg", "This is a 'Exception.class' message.");
model.setViewName("error/generic_error");
return model;
}
}
3.3.3 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 requests. In here,
- If the user provides a
/errorrequest, the controller method will throw theMyException, and theExceptionControllerAdvice.handleMyException()method will be invoked to handle the exception - If the user provides a
/io-errorrequest, the controller method throw theIOException, and theExceptionControllerAdvice.handleException()method will be invoked to handle the exception
Add the following code to the ExceptionCtrl.java class:
ExceptionCtrl.java
package com.spring.mvc.demo;
import java.io.IOException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.ModelAndView;
import com.spring.mvc.demo.exception.MyException;
@Controller
public class ExceptionCtrl {
@RequestMapping(value= "/exception/{type}", method= RequestMethod.GET)
public String exception(@PathVariable(name="type") String exception) throws IOException {
if (exception.equalsIgnoreCase("error")) {
throw new MyException("A1001", "This is a custom exception message.");
} else if (exception.equalsIgnoreCase("io-error")) {
throw new IOException();
} else {
return "success";
}
}
}
3.4 Index View
It’s time to create the index page of the tutorial that will invoke the controller method on the user click. So let us write a simple result view in SpringMvcControllerAdviceAnnotation/src/main/webapp/ folder. Add the following code to it:
index.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title>Index</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" href="https://examples.javacodegeeks.com/wp-content/litespeed/localres/aHR0cHM6Ly9tYXhjZG4uYm9vdHN0cmFwY2RuLmNvbS8=bootstrap/4.1.3/css/bootstrap.min.css"> </head> <body> <div class="container"> <h2 align="center" class="text-primary">Spring MVC @ControllerAdvice Example</h2> <hr /> <div id="errlinks"> <span id="errlink1"> <a href="<%=request.getContextPath() %>/exception/error" class="btn btn-default">Error</a> </span> <div> </div> <span id="errlink2"> <a href="<%=request.getContextPath() %>/exception/io-error" class="btn btn-default">I/O Error</a> </span> </div> </div> </body> </html>
3.5 JSP View
Spring Mvc supports many types of views for different presentation technologies. These include – JSP, HTML, XML etc. So let us write a simple result view in SpringMvcControllerAdviceAnnotation/src/main/webapp/WEB-INF/views/error/ folder.
3.5.1 Error Page
This is the output page of the tutorial which will display the error code and messages based on the exception that occurs in the controller methods. Add the following code to it:
generic_error.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
<%@ page isELIgnored="false" %>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Exception</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="https://examples.javacodegeeks.com/wp-content/litespeed/localres/aHR0cHM6Ly9tYXhjZG4uYm9vdHN0cmFwY2RuLmNvbS8=bootstrap/4.1.3/css/bootstrap.min.css">
</head>
<body>
<div class="container">
<h2 align="center" class="text-primary">Spring MVC @ControllerAdvice Example</h2>
<hr />
<!-- Error Code -->
<div id="errorcode">
<c:if test="${not empty errCode}">
<h3 class="text-info">${errCode} : My Error</h3>
</c:if>
<c:if test="${empty errCode}">
<h3 class="text-info">Input/Output Error</h3>
</c:if>
</div>
<!-- Error Message -->
<div id="errormessage">
<c:if test="${not empty errMsg}">
<h4 class="text-danger">${errMsg}</h4>
</c:if>
</div>
</div>
</body>
</html>
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.
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 display the application’s index page.
http://localhost:8082/SpringMvcControllerAdviceAnnotation/
Server name (localhost) and port (8082) may vary as per your tomcat configuration.
A user can click on the Error link to display the custom exception message as shown in Fig. 9.
A user can click on the I/O Error link to display the IO exception message as shown in Fig. 10.
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 @ControllerAdvice annotation 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 @ControllerAdvice Annotation.
You can download the full source code of this example here: SpringMvcControllerAdviceAnnotation
