{"id":16841,"date":"2013-05-15T10:00:25","date_gmt":"2013-05-15T07:00:25","guid":{"rendered":"http:\/\/www.javacodegeeks.com\/?p=16841"},"modified":"2013-09-04T01:11:13","modified_gmt":"2013-09-03T22:11:13","slug":"spring-mvc-tutorial","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2013\/05\/spring-mvc-tutorial.html","title":{"rendered":"Spring MVC Tutorial"},"content":{"rendered":"

1. Overview and Maven<\/h2>\n

This is a simple Spring MVC tutorial<\/strong> showing how to set up a Spring MVC project, both with Java based Configuration as well as with XML Configuration.<\/p>\n

The Maven artifacts for Spring MVC project are described in the in detail in the Spring MVC dependencies<\/a> article.<\/p>\n

2. The web.xml<\/em><\/h2>\n

This is a simple configuration of the web.xml<\/em> for a Spring MVC project:<\/p>\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<web-app xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\r\n   xmlns=\"http:\/\/java.sun.com\/xml\/ns\/javaee\" \r\n   xmlns:web=\"http:\/\/java.sun.com\/xml\/ns\/javaee\/web-app_3_0.xsd\"\r\n   xsi:schemaLocation=\"\r\n      http:\/\/java.sun.com\/xml\/ns\/javaee \r\n      http:\/\/java.sun.com\/xml\/ns\/javaee\/web-app_3_0.xsd\" \r\n   id=\"WebApp_ID\" version=\"3.0\">\r\n\r\n   <display-name>Spring MVC Java Config App<\/display-name>\r\n\r\n   <servlet>\r\n      <servlet-name>mvc<\/servlet-name>\r\n      <servlet-class>org.springframework.web.servlet.DispatcherServlet<\/servlet-class>\r\n      <load-on-startup>1<\/load-on-startup>\r\n   <\/servlet>\r\n   <servlet-mapping>\r\n      <servlet-name>mvc<\/servlet-name>\r\n      <url-pattern>\/<\/url-pattern>\r\n   <\/servlet-mapping>\r\n\r\n   <context-param>\r\n      <param-name>contextClass<\/param-name>\r\n      <param-value>\r\n         org.springframework.web.context.support.AnnotationConfigWebApplicationContext\r\n      <\/param-value>\r\n   <\/context-param>\r\n   <context-param>\r\n      <param-name>contextConfigLocation<\/param-name>\r\n      <param-value>org.baeldung.spring.web.config<\/param-value>\r\n   <\/context-param>\r\n   <listener>\r\n      <listener-class>\r\n         org.springframework.web.context.ContextLoaderListener\r\n      <\/listener-class>\r\n   <\/listener>\r\n\r\n<\/web-app><\/pre>\n
We are using Java based Configuration<\/strong>, so we\u2019re using AnnotationConfigWebApplicationContext<\/em> as the main context class \u2013 this accepts @Configuration<\/em> annotated classes as input. As such, we only need to specify the package where these configuration classes are located, via contextConfigLocation<\/em>.
 
<\/div> <\/div><\/p>\n
To keep this mechanism flexible, multiple packages are also configurable here, simply space delimited:<\/p>\n
<context-param>\r\n      <param-name>contextConfigLocation<\/param-name>\r\n      <param-value>org.baeldung.spring.web.config org.baeldung.spring.persistence.config<\/param-value>\r\n   <\/context-param><\/pre>\n
This allows more complex projects with multiple modules to manage their own Spring Configuration classes and contribute them to the overall Spring context at runtime.<\/p>\n
Finally, the Servlet is mapped to \/<\/em> \u2013 meaning it becomes the default Servlet<\/strong> of the application and it will pick up every pattern that doesn\u2019t have another exact match defined by another Servlet.<\/p>\n
3. The View Configuration<\/h2>\n
The Spring MVC Java configuration is simple \u2013 it uses the MVC configuration support introduced in Spring 3.1:<\/p>\n
@EnableWebMvc\r\n@Configuration\r\npublic class ClientWebConfig extends WebMvcConfigurerAdapter {\r\n\r\n   @Override\r\n   public void addViewControllers(ViewControllerRegistry registry) {\r\n      super.addViewControllers(registry);\r\n\r\n      registry.addViewController(\"\/sample.html\");\r\n   }\r\n\r\n   @Bean\r\n   public ViewResolver viewResolver() {\r\n      InternalResourceViewResolver bean = new InternalResourceViewResolver();\r\n\r\n      bean.setViewClass(JstlView.class);\r\n      bean.setPrefix(\"\/WEB-INF\/view\/\");\r\n      bean.setSuffix(\".jsp\");\r\n\r\n      return bean;\r\n   }\r\n}<\/pre>\n
Very important here is that we can register view controllers that create a direct mapping between the URL and the view name \u2013 no need for any Controller<\/strong> between the two now that we\u2019re using Java configuration.<\/p>\n
4. The JSP Views<\/h2>\n
We defined above a basic view controller \u2013 sample.html<\/em> \u2013 the corresponding jsp resource is:<\/p>\n
<html>\r\n   <head><\/head>\r\n\r\n   <body>\r\n      <h1>This is the body of the sample view<\/h1>\t\r\n   <\/body>\r\n<\/html><\/pre>\n
The JSP based view files are located under the \/WEB-INF<\/em> folder of the project, so they\u2019re only accessible to the Spring infrastructure and not by direct URL access.<\/p>\n
5. Conclusion<\/h2>\n
In this example we configured a simple and functional Spring MVC project, using Java configuration. The implementation of this simple Spring MVC tutorial can be found in the github project<\/a> \u2013 this is an Eclipse based project, so it should be easy to import and run as it is.<\/p>\n
When the project runs locally, the sample.html<\/em> can be accessed at:<\/p>\n