Tuesday, January 24, 2017

Spring MVC - Properties Method Name Resolver Example

The following example show how to use Properties Method Name Resolver method of a Multi Action Controller using Spring Web MVC framework. MultiActionController class helps to map multiple URLs with their methods in a single controller respectively.

package com.tutorialspoint;

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

import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.multiaction.MultiActionController;

public class UserController extends MultiActionController{
 
   public ModelAndView home(HttpServletRequest request,
      HttpServletResponse response) throws Exception {
      ModelAndView model = new ModelAndView("user");
      model.addObject("message", "Home");
      return model;
   }

   public ModelAndView add(HttpServletRequest request,
      HttpServletResponse response) throws Exception {
      ModelAndView model = new ModelAndView("user");
      model.addObject("message", "Add");
      return model;
   }

   public ModelAndView remove(HttpServletRequest request,
      HttpServletResponse response) throws Exception {
      ModelAndView model = new ModelAndView("user");
      model.addObject("message", "Remove");
      return model;
   }
}
<bean class="com.tutorialspoint.UserController">
   <property name="methodNameResolver">
      <bean class="org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver">
         <property name="mappings">
            <props>
               <prop key="/user/home.htm">home</prop>
               <prop key="/user/add.htm">add</prop>
               <prop key="/user/remove.htm">update</prop>   
            </props>
         </property>
      </bean>
   </property>
</bean>
For example, using above configuration, if URI
  1. /user/home.htm is requested, DispatcherServlet will forward the request to the UserController home() method.
  2. /user/add.htm is requested, DispatcherServlet will forward the request to the UserController add() method.
  3. /user/remove.htm is requested, DispatcherServlet will forward the request to the UserController remove() method.
To start with it, let us have working Eclipse IDE in place and follow the following steps to develop a Dynamic Form based Web Application using Spring Web Framework:
StepDescription
1Create a project with a name TestWeb under a package com.tutorialspoint as explained in the Spring MVC - Hello World Example chapter.
2Create a Java classes UserController under the com.tutorialspoint package.
3Create a view file user.jsp under jsp sub-folder.
4The final step is to create the content of all the source and configuration files and export the application as explained below.
UserController.java
package com.tutorialspoint;

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

import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.multiaction.MultiActionController;

public class UserController extends MultiActionController{
 
   public ModelAndView home(HttpServletRequest request,
      HttpServletResponse response) throws Exception {
      ModelAndView model = new ModelAndView("user");
      model.addObject("message", "Home");
      return model;
   }

   public ModelAndView add(HttpServletRequest request,
      HttpServletResponse response) throws Exception {
      ModelAndView model = new ModelAndView("user");
      model.addObject("message", "Add");
      return model;
   }

   public ModelAndView remove(HttpServletRequest request,
      HttpServletResponse response) throws Exception {
      ModelAndView model = new ModelAndView("user");
      model.addObject("message", "Remove");
      return model;
   }
}
TestWeb-servlet.xml
<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:context="http://www.springframework.org/schema/context"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="
   http://www.springframework.org/schema/beans     
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
   http://www.springframework.org/schema/context 
   http://www.springframework.org/schema/context/spring-context-3.0.xsd">

   <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
      <property name="prefix" value="/WEB-INF/jsp/"/>
      <property name="suffix" value=".jsp"/>
   </bean>

   <bean class="org.springframework.web.servlet.mvc.support.ControllerClassNameHandlerMapping"> 
      <property name="caseSensitive" value="true" />
   </bean>
   <bean class="com.tutorialspoint.UserController">
      <property name="methodNameResolver">
      <bean class="org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver">
         <property name="mappings">
            <props>
               <prop key="/user/home.htm">home</prop>
               <prop key="/user/add.htm">add</prop>
               <prop key="/user/remove.htm">update</prop>   
            </props>
         </property>
      </bean>
      </property>
   </bean>  
</beans>
user.jsp
<%@ page contentType="text/html; charset=UTF-8" %>
<html>
<head>
<title>Hello World</title>
</head>
<body>
   <h2>${message}</h2>  
</body>
</html>
Once you are done with creating source and configuration files, export your application. Right click on your application and use Export > WAR File option and save your TestWeb.war file in Tomcat's webapps folder.
Now start your Tomcat server and make sure you are able to access other web pages from webapps folder using a standard browser. Now try a URL http://localhost:8080/TestWeb/user/add.htm and you should see the following result if everything is fine with your Spring Web Application:
Spring Multi Action Controller

No comments:

Post a Comment