Spring MVC接口實例

概述
前文記錄了MVC模式和Spring MVC的初步認識，如今記錄建立一個項目，配置Spring MVC，編寫接口程序。
建立項目
打開IntelliJ IDEA，點擊「File->New->Project...」，在打開的界面中左側選擇「Maven」，勾選「Create from archetype」，選中「maven-archetype-webapp」，點擊「Next」：

填寫GroupId等信息填寫完整，點擊「Next」：

配置好本機安裝的maven目錄，點擊「Next」：

設置好項目存放目錄，點擊「Finish」：

maven須要下載相應的依賴，稍後片刻，建立完成，目錄結構以下：

此時目錄結構是缺失的，須要進行完善，點擊「File->Project Structure...」，左側選中「Modules」，點擊「Sources」：

選中「main」目錄，右鍵菜單中點擊「New Folder...」，新建一個名爲「java」的文件夾：

選中「java」文件夾，點擊上方「Sources」按鈕，能夠看到「java」文件夾變色，並已被標記爲「Source Folders」文件夾：

選中「main」目錄，右鍵菜單中點擊「New Folder...」，新建一個名爲「resources」的文件夾：

選中「resources」文件夾，點擊上方「Resources」按鈕，能夠看到「resources」文件夾標識變動，並已被標記爲「Resources Folders」文件夾：

選中「src」目錄，右鍵菜單中點擊「New Folder...」，新建一個名爲「test」的文件夾，選中「test」目錄，右鍵菜單中點擊「New Folder...」，新建一個名爲「java」的文件夾：

選中「java」文件夾，點擊上方「test」按鈕，能夠看到「java」文件夾變色，並已被標記爲「Test Source Folders」文件夾：

而後建立包，選中java目錄，右鍵「New->Package」，輸入包名「com.snow.dcl.controller」，點擊「肯定」:

至此項目目錄結構就配置完整了。
配置Tomcat
Tomcat配置前文已經記錄過了，此處不作重複記錄（前文鏈接：http://www.javashuo.com/article/p-mwocxsst-cz.html）。
添加Spring MVC依賴
打開pom文件，在<dependencies>標籤中添加以下依賴：

  1 <dependency>
  2     <groupId>org.springframework</groupId>
  3     <artifactId>spring-webmvc</artifactId>
  4     <version>4.3.10.RELEASE</version>
  5 </dependency>
  6 <dependency>
  7     <groupId>javax.servlet</groupId>
  8     <artifactId>javax.servlet-api</artifactId>
  9     <version>4.0.1</version>
 10 </dependency>

基於配置的控制器實例
配置前端控制器DispatcherServlet
DispatcherServlet的核心功能是分發請求，請求會被分發給對應處理的Java類，稱爲Handle，在Spring 2.5版本之前開發一個Handle必須實現org.springframework.web.servlet.mvc.Controller接口，Controller接口必須實現ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception方法，Controller接口的實現類能夠經過該方法傳遞參數訪問對應請求的HttpServletRequest和HttpServletResponse對象，請求處理完成後，返回一個包含模型對象和視圖路徑的ModelAndView對象；在Spring 2.5版本新增了可基於註解的控制器，即不須要實現Controller接口，經過註釋類型來描述便可完成功能。
先不使用**註解**的方式進行記錄，展開項目的目錄結構，雙擊打開web.xml文件，替換爲下面內容：

  1 <?xml version="1.0" encoding="UTF-8"?>
  2 <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  3          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
  5          version="3.1">
  6 
  7     <display-name>Archetype Created Web Application</display-name>
  8 
  9     <!--welcome pages-->
 10     <welcome-file-list>
 11         <welcome-file>index.jsp</welcome-file>
 12     </welcome-file-list>
 13 
 14     <!--配置Spring MVC DispatcherServlet-->
 15     <servlet>
 16         <servlet-name>springMVC</servlet-name>
 17         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
 18         <init-param>
 19             <!--配置/WEB-INF目錄下的springmvc-servlet.xml做爲mvc的配置文件-->
 20             <param-name>contextConfigLocation</param-name>
 21             <param-value>/WEB-INF/springmvc-servlet.xml</param-value>
 22         </init-param>
 23         <load-on-startup>1</load-on-startup>
 24         <async-supported>true</async-supported>
 25     </servlet>
 26     <!--配置Spring MVC DispatcherServlet攔截全部請求-->
 27     <servlet-mapping>
 28         <servlet-name>springMVC</servlet-name>
 29         <url-pattern>/</url-pattern>
 30     </servlet-mapping>
 31 </web-app>
 32 

而後配置springmvc-servlet.xml，在WEB-INF目錄下右鍵「New->File」建立springmvc-servlet.xml，雙擊打開該文件，填寫如下內容：

  1 <?xml version="1.0" encoding="UTF-8"?>
  2  <beans xmlns="http://www.springframework.org/schema/beans"
  3         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4 
  5        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
  6 
  7     <!--配置Handle，映射"/hello"請求-->
  8     <bean name="/hello" class="com.snow.dcl.controller.HelloController"/>
  9     <!--將bean的name做爲url進行查找-->
 10     <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>
 11     <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>
 12     <!--視圖解析器-->
 13     <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>
 14 
 15 </beans>
 16 

配置文件內容含義：
1.首先聲明瞭HelloController業務控制器類，並將其映射到/hello請求。
2.配置了處理映射器BeanNameUrlHandlerMapping，以Bean的名稱做爲url進行查找。
3.配置了處理器適配器SimpleControllerHandlerAdapter，對HelloController類的handleRequest方法進行調用。
4.配置視圖解析器InternalResourceViewResolver解析視圖，將view呈現給用戶。

注意：Spring 4.0版本以後，處理映射器、處理器適配器、視圖解析器不須要進行配置，Spring會提供默認配置進行使用，此處進行配置是爲了理解原理。
在「com.snow.dcl.controller」包下右鍵「New->Java Class」，建立一個名爲「HelloController」的類，編寫以下代碼：

  1 public class HelloController implements Controller {
  2 
  3     @Override
  4     public ModelAndView handleRequest(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) {
  5         ModelAndView modelAndView = new ModelAndView();
  6         modelAndView.addObject("message", "Hello!");
  7         modelAndView.setViewName("/WEB-INF/content/welcome.jsp");
  8         return modelAndView;
  9     }
 10 
 11 }
 12 

HelloController是實現了Controller接口的控制器，處理請求動做；handleRequest是必須實現的方法，該方法的參數對應請求的HttpServletRequest和HttpServletResponse，必須返回一個包含視圖名或視圖名和模型的ModelAndView對象，此處返回的模型中包含message字符串對象，返回的視圖路徑/WEB-INF/content/welcome.jsp，即請求被轉發到welcome.jsp。
選中WEB-INF目錄，右鍵「New->Directory」，命名爲「content」，而後一樣方式在該目錄中建立welcome.jsp，文件中編寫以下代碼：

  1 <%@ page contentType="text/html;charset=UTF-8" language="java" %>
  2 <html>
  3 <head>
  4     <meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
  5     <title>welcome</title>
  6 </head>
  7 <body>
  8 ${requestScope.message}
  9 </body>
 10 </html>

此處使用JSP的EL表達式${requestScope.message}來獲取HelloController的ModelAndView對象中message的值並顯示在瀏覽器中。
測試
啓動TomcatServer，啓動完成後，打開瀏覽器輸入：（ http://localhost:8080/hello），訪問成功。
基於註解的控制器實例
Spring 2.5版本後，增長了基於註解的控制器，即不須要實現Controller接口，經過註解便可實現功能。
修改HelloController類
打開HelloController類文件，代碼修改以下：

  1 @Controller
  2 public class HelloController {
  3 
  4     @RequestMapping(value = "/hello")
  5     public ModelAndView hello() {
  6         ModelAndView modelAndView = new ModelAndView();
  7         modelAndView.addObject("message", "Hello!");
  8         modelAndView.setViewName("/WEB-INF/content/welcome.jsp");
  9         return modelAndView;
 10     }
 11 
 12 }
 13 

HelloController是一個基於註解的控制器，使用@Controller註解標示，@RequestMapping註解用來映射一個請求和請求的方法，value = "/hello"表示請求由hello方法進行處理，方法返回一個包含視圖名或視圖名和模型的ModelAndView對象。
修改Spring MVC的配置文件
打開springmvc-servlet.xml，內容修改以下：

  1 <?xml version="1.0" encoding="UTF-8"?>
  2  <beans xmlns="http://www.springframework.org/schema/beans"
  3         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4         xmlns:context="http://www.springframework.org/schema/context"
  5         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">
  6 
  7     <!--spring能夠自動掃描base-package設置的包或子包下的java類，若是掃描到有spring相關注解的類，則註冊爲spring的bean-->
  8      <context:component-scan base-package="com.snow.dcl.controller"/>
  9      <!--配置annotation類型的映射處理器-->
 10      <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"/>
 11      <!--配置annotation類型的處理器適配器-->
 12      <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"/>
 13      <!--視圖解析器-->
 14      <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>
 15 
 16 </beans>
 17 

Spring的掃描機制會自動掃描com.snow.dcl.controller包下使用了@Controller註解的控制器類，配置的RequestMappingHandlerMapping映射處理器處理會根據請求查找映射，配置的RequestMappingHandlerAdapter來完成對@RequestMapping註解的方法的調用，配置的InternalResourceViewResolver解析視圖呈現給用戶。
注意：Spring 4.0版本以後，處理映射器、處理器適配器會有跟簡單的方式進行配置，此處進行配置是爲了理解原理。
測試
啓動TomcatServer，啓動完成後，打開瀏覽器輸入：（http://localhost:8080/hello），訪問成功。