Spring 3.x - Spring MVC

Spring MVC Guy Nir January 2012

About Spring MVC Architecture and design Handler mapping Controllers View resolvers Annotation driven Summary Agenda Spring MVC

Top-level project at Spring framework Acknowledged that web is a crucial part of JEE world. Provide first-class support for web technologies Markup generators (JSP, Velocity, Freemarker, etc …) REST support. Integrates web and Spring core. About Spring MVC

Introduced with Spring 1.0 (August 2003) Led by Rod Johnson and Juergen Hoeller Introduced due the poor design of other frameworks Struts Jakarta About History Spring MVC

Spring MVC Architecture and design Servlet Application Context Spring MVC

Open-close principle [1] Open for extension, closed for modification. Convention over configuration. [2] Model-View-Controller (MVC) driven. [3] Clear separation of concerns. Architecture and design Design guidelines Spring MVC [1] Bob Martin, The Open-Closed Principle [2] Convention over configuration [3] Model View Controller – GoF design pattern

Tightly coupled with HTTP Servlet API. Request-based model. Takes a strategy approach. [4] All activity surrounds the DispatcherServlet. Architecture and design Design guidelines - continued Spring MVC [4] Strategy – GoF design pattern

Architecture and design web.xml Spring MVC 1 <web-app> 2 3 <servlet> 4 <servlet-name> petshop </servlet-name> 5 <servlet-class> 6 org.springframework.web.servlet.DispatcherServlet 7 </servlet-class> 8 <load-on-startup>1</load-on-startup> 9 </servlet> 10 11 <servlet-mapping> 12 <servlet-name> petshop </servlet-name> 13 <url-pattern>*.do</url-pattern> 14 </servlet-mapping> 15 16 </web-app> Servlet name

Architecture and design Application context lookup Spring MVC <servlet-name> /WEB-INF/ <servlet-name> - servlet.xml petshop /WEB-INF/ petshop- servlet.xml

Architecture and design Spring MVC approach Spring MVC

Spring MVC Architecture and design Dispatcher Servlet Incoming request Outgoing response Controller (Bean) Delegate Rendered response View renderer Model (JavaBean) 1 2 3 4 (?) 5 (?) 6 Application context

Spring MVC Architecture and design Dispatcher Servlet Controller View renderer

Dispatcher servlet flow Spring MVC Incoming HTTP request Set locale Simple controller adapter Annotation-based adapter Another servlet adapter Interceptors (postHandle) Interceptors (preHandle) Handler adapter View renderer Locale View Themes Security authorization Exception handler

Dispatcher servlet flow Spring MVC Incoming HTTP request Set locale Simple controller adapter Annotation-based adapter Another servlet adapter Interceptors (postHandle) Interceptors (preHandle) Handler adapter View renderer Exception handler Locale View Themes Security authorization Controller View

Dispatcher servlet flow Spring MVC Interceptors (postHandle) Incoming HTTP request Simple controller adapter Annotation-based adapter Another servlet adapter Handler adapter View renderer Exception handler Interceptors (preHandle) public interface HandlerInterceptor { public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // Pre-processing callback. } }

Dispatcher servlet flow Spring MVC Interceptors (preHandle) Interceptors (postHandle) Incoming HTTP request View renderer Exception handler Handler adapter Simple controller adapter Annotation-based adapter Another servlet adapter

Dispatcher servlet flow Spring MVC Interceptors (preHandle) Incoming HTTP request Simple controller adapter Annotation-based adapter Another servlet adapter Handler adapter View renderer Exception handler public interface HandlerInterceptor { public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView ) throws Exception { // Post-processing callback. } } Interceptors (postHandle)

Dispatcher servlet flow Spring MVC Interceptors (postHandle) Interceptors (preHandle) Incoming HTTP request Simple controller adapter Annotation-based adapter Another servlet adapter Handler adapter Exception handler View renderer Locate current locale Render the appropriate view ResourceBundleViewResolver UrlBasedViewResolver FreeMarkerViewResolver VelocityLayoutViewResolver JasperReportsViewResolver InternalResourceViewResolver XsltViewResolver TilesViewResolver XmlViewResolver BeanNameViewResolver

Dispatcher servlet flow Spring MVC View renderer Interceptors (postHandle) Interceptors (preHandle) Incoming HTTP request Simple controller adapter Annotation-based adapter Another servlet adapter Handler adapter Exception handler DefaultHandlerExceptionResolver

Maps between an incoming request and the appropriate controller. Handler mapping Spring MVC Incoming HTTP request Handler adapter Controller bean-name mapping Controller class-name mapping Static mapping Based on annotations [GET] http://host.com/services/userInfo.do Handlers from application context

Dispatcher servlet: Search for all beans derived from org.springframework.web.servlet.HandlerMapping Traverse all handlers. For each handler: Check if handler can resolve request to a controller. Delegate control to the controller. Handler mapping Spring MVC

Handler mapping Spring MVC 1 <? xml version = "1.0" encoding = "UTF-8" ?> 2 3 < beans > 4 5  6 < bean class = "org.springframework...ControllerClassNameHandlerMapping" /> 7 8  9 < bean class = "org.springframework.web.servlet.handler.SimpleUrlHandlerMapping" > 10 < property name = "mappings" > 11 < value > 12 /info.do=personalInformationController 13 </ value > 14 </ property > 15 </ bean > 16 17 < bean id = "personalInformationController“ 18 class = "com.cisco.mvc.controllers.PersonalInformationController" /> 19 20 </ beans >

Controllers Spring MVC public interface Controller { public ModelAndView handleRequest( HttpServletRequest request, HttpServletResponse response) throws Exception; } View: Object ? Model: Key/Value map Model + View

Controllers Spring MVC 1 public class LoginController implements Controller { 2 3 @Override 4 public ModelAndView handleRequest(HttpServletRequest request , 5 HttpServletResponse response) 6 throws Exception { 7 String username = request.getParameter( "j_username" ); 8 String password = request.getParameter( "j_password" ); 9 if (!validateUser(username, password)) { 10 return new ModelAndView( "invalidUsername.jsp", "uname", username ); 11 } else { 12 return new ModelAndView( "portal.jsp" ); 13 } 14 } 15 16 private boolean validateUser(String username, String password) { 17 // Validate user ... 18 } 19 }

Controllers Spring MVC 1 public class LoginController implements Controller { 2 3 @Override 4 public ModelAndView handleRequest(HttpServletRequest request , 5 HttpServletResponse response) 6 throws Exception { 7 String username = request.getParameter( "j_username" ); 8 String password = request.getParameter( "j_password" ); 9 if (!validateUser(username, password)) { 10 int retryCount = Integer.parseInt(request.getParameter( "retries" )); 11 Map<String, Object> model = new Map<String, Object>(); 12 model.put( "uname" , username); 13 model.put( “retryCount“, retryCount + 1); 14 15 return new ModelAndView( "invalidUsername.jsp", model); 16 } else { 17 return new ModelAndView( "portal.jsp" ); 18 } 19 } 20 }

Controllers Spring MVC << interface >> Controller MyController Handle incoming requests

Controllers Spring MVC << interface >> Controller << abstract>> AbstractController MyController supportedMethods (GET, POST, …) requireSession (true/false) synchronize (true/false) Cache control public ModelAndView handleRequest( HttpServletRequest request , HttpServletResponse response) throws Exception { ... }

Controllers Spring MVC << interface >> Controller << abstract>> AbstractController MyController << abstract>> AbstractUrlViewController Resolve controller based on URL public ModelAndView handleRequestInt( HttpServletRequest request , HttpServletResponse response) throws Exception { ... }

Resolve a view object to actual rendered output. Isolate application logic from underlying view implementation. Each view is identified by a discrete object (e.g.: name). Each view is resolved to a different renderer. View resolvers Spring MVC

View resolvers Spring MVC View resolver XmlViewResolver ResourceBundleViewResolver FreeMarkerViewResolver UrlBasedViewResolver View: “ login” View handlers

View resolvers Spring MVC <? xml version = "1.0" encoding = "UTF-8" ?> < beans > < bean id = "viewResolver" class = "org.springframework.web.servlet.view.UrlBasedViewResolver" > < property name = "prefix" value = "/WEB-INF/pages/" /> < property name = "suffix" value = ".jsp" /> </ bean > </ beans > View: “login” /WEB-INF/pages/ login .jsp

Allow us to specify all mapping and handling via annotations. Annotation driven Spring MVC

Annotation driven Basic request mapping Spring MVC 1 @Controller 2 public class CalcController { 3 4 // [GET] http://host.com/example/ calculate?first=NNN&second=MMM 5 @RequestMapping ( "/calculate" ) 6 public String calculate(HttpServletRequest request) { 7 String first = request.getParameter( "first" ); 8 String second = request.getParameter( "second" ); 9 10 int firstInt = Integer. parseInt(first); 11 int secondInt = Integer. parseInt(second); 12 13 return Integer. toString(firstInt + secondInt); 14 } 15 }

Annotation driven Selecting method type Spring MVC 1 @Controller 2 public class CalcController { 3 4 // [POST] http://host.com/example/ calculate?first=NNN&second=MMM 5 @RequestMapping (value = "/calculate", method = RequestMethod.POST) 6 public String calculate(HttpServletRequest request) { 7 String first = request.getParameter( "first" ); 8 String second = request.getParameter( "second" ); 9 10 int firstInt = Integer. parseInt(first); 11 int secondInt = Integer. parseInt(second); 12 13 return Integer. toString(firstInt + secondInt); 14 } 15 }

Annotation driven Accessing request parameters Spring MVC 1 @Controller 2 public class CalcController { 3 4 // [POST] http://host.com/example/ calculate?first=NNN&second=MMM 5 @RequestMapping (value = "/calculate", method = RequestMethod.POST) 6 public String calculate(@RequestParam( "first" ) int first, 7 @RequestParam( “second" ) int second) { 8 return Integer. toString(first + second); 9 } 10 }

Annotation driven Multiple handlers per controller Spring MVC 1 @Controller 2 public class CalcController { 3 4 // [POST] http://host.com/example/ calculate/add?first=NNN&second=MMM 5 @RequestMapping (value = "/calculate/add", method = RequestMethod.POST) 6 public String calculate(@RequestParam( "first" ) int first, 7 @RequestParam( “second" ) int second) { 8 return Integer. toString(first + second); 9 } 4 // [POST] http://host.com/example/ calculate/sub?first=NNN&second=MMM 5 @RequestMapping (value = "/calculate/sub", method = RequestMethod.GET) 6 public String calculate(@RequestParam( "first" ) int first, 7 @RequestParam( “second" ) int second) { 8 return Integer. toString(first - second); 9 } 10 }

Annotation driven URI template Spring MVC 1 @Controller 2 public class WeatherController { 3 4 // [GET] http://host.com /weather/972/TelAviv 5 @RequestMapping (value = "/weather/{countryCode}/{cityName}" ) 6 public ModelAndView getWeather( @PathVariable ( "countryCode" ) int countryCode, 7 @PathVariable ( "cityName" ) String cityName) { 8 ModelAndView mav = new ModelAndView(); 9 // Fill in model the relevant information. 10 // Select a view appropriate for country. 11 return mav; 12 } 13 }

Annotation driven Exception handling Spring MVC 1 @Controller 2 public class WeatherController { 3 4 @ExceptionHandler (IllegalArgumentException. class ) 5 public String handleException(IllegalArgumentException ex, 6 HttpServletResponse response) { 7 return ex.getMessage(); 8 } 9 }

Annotation driven File upload example Spring MVC @Controller public class FileUploadController { @RequestMapping (value = "/uploadFile" , method = RequestMethod. POST ) public String handleFormUpload( @RequestParam ( "name" ) String filename, @RequestParam ( "file" ) MultipartFile file) { if (success) { return "redirect:uploadSuccess" ; } else { return "redirect:uploadFailure" ; } } }

Annotation driven Cookies Spring MVC @Controller public class FileUploadController { @RequestMapping (“/portal” ) public String enterPortal( @CookieValue ( “lastVisited“ ) Date lastVisited) { } @RequestMapping (“/console” ) public String enterPortal( @CookieValue (value = “lastVisited“, required = “true” ) Date lastVisited) { } }

Annotation driven Session attributes Spring MVC 1 @Controller 2 @SessionAttributes ( "userid" ) 3 public class PersonalInformationController { 4 5 @RequestMapping ( "/loginCheck" ) 6 public String checkUserLoggedIn( @ModelAttribute ( "userid" ) int id) { 7 // ... 8 } 9 }

Annotation driven Application context configuration Spring MVC 1 <? xml version = "1.0" encoding = "UTF-8" ?> 2 3 < beans > 4 5  6 < context:annotation-config /> 7 8  9 < context:component-scan base-package = "com.cisco.mvc" /> 10 11  12 < mvc:annotation-driven /> 13 14 < mvc:interceptors > 15 </ mvc:interceptors > 16 17 </ beans >

Annotation driven Application context configuration - continued Spring MVC 1 <? xml version = "1.0" encoding = "UTF-8" ?> 2 3 < beans > 4 5 < mvc:interceptors > 6 < bean class = "com.cisco.mvc.interceptors.SecurityInterceptor" /> 7 </ mvc:interceptors > 8 9 < mvc:resources mapping = "/static/**" location = "/pages/" /> 10 11 < mvc:view-controller path = "/" view-name = “homePage" /> 12 13 </ beans >

Spring MVC provide a clear separation between a model, view and controller Provide both XML-based and annotation-based approaches. Enriched by Spring application context. Provide a broad range of pre-configured facilities. Takes convention over configuration approach. Uses open-close principle. Summary Spring MVC

Spring MVC reference guide: http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/mvc.html Summary References Spring MVC

Spring 3.x - Spring MVC

More Related Content

What's hot

Viewers also liked

Similar to Spring 3.x - Spring MVC

Recently uploaded

Spring 3.x - Spring MVC