資訊專欄INFORMATION COLUMN
摘要：的框架用于解決上述提到的問題，基于模型，可以幫助開發人員構建靈活易擴展的應用。在這一章中，將專注于構建該應用的層，創建控制器和顯示，以及處理用戶注冊的表單。類有兩個靜態接口，代表兩種模擬服務的方式獨立測試和集成測試。
主要內容
將web請求映射到Spring控制器
綁定form參數
驗證表單提交的參數
寫在前面：關于Java Web，首先推薦一篇文章——寫給java web一年左右工作經驗的人，這篇文章的作者用精練的話語勾勒除了各種Java框架的緣由和最基本的原理。我們在學習Spring的過程中也要切記，不僅要知道怎么做？還要深究背后的思考和權衡。
對于很多Java程序員來說，他們的主要工作就是開發Web應用，如果你也在做這樣的工作，那么你一定會了解到構建這類系統所面臨的挑戰，例如狀態管理、工作流和參數驗證等。HTTP協議的無狀態性使得這些任務極具挑戰性。
Spring的web框架用于解決上述提到的問題，基于Model-View-Controller（MVC）模型，Spring MVC可以幫助開發人員構建靈活易擴展的Web
應用。
這一章將涉及Spring MVC框架的主要知識，由于基于注解開發是目前Spring社區的潮流，因此我們將側重介紹如何使用注解創建控制器，進而處理各類web請求和表單提交。在深入介紹各個專題之前，首先從一個比較高的層面觀察和理解下Spring MVC的工作原理。
5.1 Spring MVC入門 5.1.1 request的處理過程用戶每次點擊瀏覽器界面的一個按鈕，都發出一個web請求（request）。一個web請求的工作就像一個快遞員，負責將信息從一個地方運送到另一個地方。
從web請求離開瀏覽器（1）到返回響應，中間經歷了幾個節點，在每個節點都進行一些操作用于交換信息。下圖展示了Spring MVC應用中web請求會遇到的幾個節點。
請求旅行的第一站是Spring的DispatcherServlet，和大多數Javaweb應用相同，Spring MVC通過一個多帶帶的前端控制器過濾分發請求。當Web應用委托一個servlet將請求分發給應用的其他組件時，這個servlert稱為前端控制器（front controller）。在Spring MVC中，DispatcherServlet就是前端控制器。
DispatcherServlet的任務是將請求發送給某個Spring控制器。控制器（controller）是Spring應用中處理請求的組件。一般在一個應用中會有多個控制器，DispatcherServlet來決定把請求發給哪個控制器處理。DispatcherServlet會維護一個或者多個處理器映射（2），用于指出request的下一站——根據請求攜帶的URL做決定。
一旦選好了控制器，DispatcherServlet會把請求發送給指定的控制器（3），控制器中的處理方法負責從請求中取得用戶提交的信息，然后委托給對應的業務邏輯組件（service objects）處理。
控制器的處理結果包含一些需要傳回給用戶或者顯示在瀏覽器中的信息。這些信息存放在模型（model）中，但是直接把原始信息返回給用戶非常低效——最好格式化成用戶友好的格式，例如HTML或者JSON格式。為了生成HTML格式的文件，需要把這些信息傳給指定的視圖（view），一般而言是JSP。
控制器的最后一個任務就是將數據打包在模型中，然后指定一個視圖的邏輯名稱（由該視圖名稱解析HTML格式的輸出），然后將請求和模型、視圖名稱一起發送回DispatcherServlet（4）。
注意，控制器并不負責指定具體的視圖，返回給DispatcherServlet的視圖名稱也不會指定具體的JSP頁面（或者其他類型的頁面）；控制器返回的僅僅是視圖的邏輯名稱，DispatcherServlet用這個名稱查找對應的視圖解析器（5），負責將邏輯名稱轉換成對應的頁面實現，可能是JSP也可能不是。
現在DispatcherServlet就已經知道將由哪個視圖渲染結果，至此一個請求的處理就基本完成了。最后一步就是視圖的實現（6），最經典的是JSP。視圖會使用模型數據填充到視圖實現中，然后將結果放在HTTP響應對象中（7）。
5.1.2 設置Spring MVC如上一小節的圖展示的，看起來需要填寫很多配置信息。幸運地是，Spring的最新版本提供了很多容易配置的選項，降低了Spring MVC的學習門檻。這里我們先簡單配置一個Spring MVC應用，作為這一章將會不斷完善的例子。
CONFIGURING DISPATCHERSERVLETDispatcherServlet是Spring MVC的核心，每當應用接受一個HTTP請求，由DispatcherServlet負責將請求分發給應用的其他組件。
在舊版本中，DispatcherServlet之類的servlet一般在web.xml文件中配置，該文件一般會打包進最后的war包種；但是Spring 3引入了注解，我們在這一章將展示如何基于注解配置Spring MVC。
既然不適用web.xml文件，你需要在servlet容器中使用Java配置DispatcherServlet，具體的代碼列舉如下：
package org.test.spittr.config;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
public class SpittrWebAppInitializer
extends AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class[] getRootConfigClasses() { //根容器
return new Class[] { RootConfig.class };
}
@Override
protected Class[] getServletConfigClasses() { //Spring mvc容器
return new Class[] { WebConfig.class };
}
@Override
protected String[] getServletMappings() { //DispatcherServlet映射,從"/"開始
return new String[] { "/" };
}
}
spitter這個單詞是我們應用的名稱，SpittrWebAppInitializer類是整個應用的總配置類。
AbstractAnnotationConfigDispatcherServletInitializer這個類負責配置DispatcherServlet、初始化Spring MVC容器和Spring容器。getRootConfigClasses()方法用于獲取Spring應用容器的配置文件，這里我們給定預先定義的RootConfig.class；getServletConfigClasses負責獲取Spring MVC應用容器，這里傳入預先定義好的WebConfig.class；getServletMappings()方法負責指定需要由DispatcherServlet映射的路徑，這里給定的是"/"，意思是由DispatcherServlet處理所有向該應用發起的請求。
A TALE OF TWO APPLICATION CONTEXT當DispatcherServlet啟動時，會創建一個Spring MVC應用容器并開始加載配置文件中定義好的beans。通過getServletConfigClasses()方法，可以獲取由DispatcherServlet加載的定義在WebConfig.class中的beans。
在Spring Web應用中，還有另一個Spring應用容器，這個容器由ContextLoaderListener創建。
我們希望DispatcherServlet僅加載web組件之類的beans，例如controllers（控制器）、view resolvers（視圖解析器）和處理器映射（handler mappings）；而希望ContextLoaderListener加載應用中的其他類型的beans——例如業務邏輯組件、數據庫操作組件等等。
實際上，AbstractAnnotationConfigDispatcherServletInitializer創建了DispatcherServlet和ContextLoaderListener：getServletConfigClasses()返回的配置類定義了Spring MVC應用容器中的beans；getRootConfigClasses()返回的配置類定義了Spring應用根容器中的beans。【書中沒有說的】：Spring MVC容器是根容器的子容器，子容器可以看到根容器中定義的beans，反之不行。
注意：通過AbstractAnnotationConfigDispatcherServletInitializer配置DispatcherServlet僅僅是傳統的web.xml文件方式的另一個可選項。盡管你也可以使用AbstractAnnotationConfigDispatcherServletInitializer的一個子類引入web.xml文件來配置，但這沒有必要。
這種方式配置DispatcherServlet需要支持Servlert 3.0的容器，例如Apache Tomcat 7或者更高版本的。
ENABLING SPRING MVC正如可以通過多種方式配置DispatcherServlet一樣，也可以通過多種方式啟動Spring MVC特性。原來我們一般在xml文件中使用
這里我們仍然使用JavaConfig配置，最簡單的Spring MVC配置類代碼如下：
package org.test.spittr.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
@Configuration
@EnableWebMvc
public class WebConfig {
}
@Configuration表示這是Java配置類；@EnableWebMvc注解用于啟動Spring MVC特性。
僅僅這些代碼就可以啟動Spring MVC了，雖然它換缺了一些必要的組件：
沒有配置視圖解析器。這種情況下，Spring會使用BeanNameViewResolver，這個視圖解析器通過查找ID與邏輯視圖名稱匹配且實現了View接口的beans。
沒有啟動Component-scanning。
DispatcherServlet作為默認的servlet，將負責處理所有的請求，包括對靜態資源的請求，例如圖片和CSS文件等。
因此，我們還需要在配置文件中增加一些配置，使得這個應用可以完成最簡單的功能，代碼如下：
package org.test.spittr.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.ViewResolver;
import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.view.InternalResourceViewResolver;
@Configuration
@EnableWebMvc
@ComponentScan("org.test.spittr.web")
public class WebConfig extends WebMvcConfigurerAdapter{
@Bean
public ViewResolver viewResolver() { //配置JSP視圖解析器
InternalResourceViewResolver resolver = new InternalResourceViewResolver();
resolver.setPrefix("/WEB-INF/views/");
resolver.setSuffix(".jsp");
//可以在JSP頁面中通過${}訪問beans
resolver.setExposeContextBeansAsAttributes(true);
return resolver;
}
@Override
public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
configurer.enable(); //配置靜態文件處理
}
}
首先，通過@ComponentScan("org.test.spittr.web")注解指定bean的自動發現機制作用的范圍，待會會看到，被@Controller等注解修飾的web的bean將被發現并加載到spring mvc應用容器。這樣就不需要在配置類中顯式定義任何控制器bean了。
然后，你通過@Bean注解添加一個ViewResolverbean，具體來說是InternalResourceViewResolver。后面我們會專門探討視圖解析器，這里的三個函數的含義依次是：setPrefix()方法用于設置視圖路徑的前綴；setSuffix()用于設置視圖路徑的后綴，即如果給定一個邏輯視圖名稱——"home"，則會被解析成"/WEB-INF/views/home.jsp"； setExposeContextBeansAsAttributes(true)使得可以在JSP頁面中通過${ }訪問容器中的bean。
最后，WebConfig繼承了WebMvcConfigurerAdapter類，然后覆蓋了其提供的configureDefaultServletHandling()方法，通過調用configer.enable()，DispatcherServlet將會把針對靜態資源的請求轉交給servlert容器的default servlet處理。
RootConfig的配置就非常簡單了，唯一需要注意的是，它在設置掃描機制的時候，將之前WebConfig設置過的那個包排除了；也就是說，這兩個掃描機制作用的范圍正交。RootConfig的代碼如下：
package org.test.spittr.config;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
@Configuration
@ComponentScan(basePackages = {"org.test.spittr"},
excludeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION, value = EnableWebMvc.class)})
public class RootConfig {
}
5.1.3 Spittr應用簡介
這一章要用的例子應用，從Twitter獲取了一些靈感，因此最開始叫Spitter；然后又借鑒了最近比較流行的網站Flickr，因此我們也把e去掉，最終形成Spittr這個名字。這也有利于區分領域名稱（類似于twitter，這里用spring實現，因此叫spitter）和應用名稱。
Spittr應用有兩個關鍵的領域概念：spitters（應用的用戶）和spittles（用戶發布的狀態更新）。在這一章中，將專注于構建該應用的web層，創建控制器和顯示spittles，以及處理用戶注冊的表單。
基礎已經打好了，你已經配置好了DispatcherServlet，啟動了Spring MVC特性等，接下來看看如何編寫Spring MVC控制器。
5.2 編寫簡單的控制器在Spring MVC應用中，控制器類就是含有被@RequestMapping注解修飾的方法的類，其中該注解用于指出這些方法要處理的請求類型。
我們從最簡單的請求"/"開始，用于渲染該應用的主頁，HomeController的代碼列舉如下：
package org.test.spittr.web;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Controller
public class HomeController {
@RequestMapping(value = "/", method = RequestMethod.GET)
public String home() {
return "home";
}
}
@Controller是一個模式化的注解，它的作用跟@Component一樣；Component-scanning機制會自動發現該控制器，并在Spring容器中創建對應的bean。
HomeController中的home()方法用于處理http://localhost:8080/這個URL對應的"/"請求，且僅處理GET方法，方法的內容是返回一個邏輯名稱為"home"的視圖。DispatcherServlet將會讓視圖解析器通過這個邏輯名稱解析出真正的視圖。
根據之前配置的InternalResourceViewResolver，最后解析成/WEB-INF/views/home.jsp，home.jsp的內容列舉如下：
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" session="false" %>
Spittr
Welcome to Spittr
">Spittles
">Register
啟動應用，然后訪問http://localhost:8080/，Spittr應用的主頁如下圖所示：
控制器的測試通過Mockito框架進行，首先在pom文件中引入需要的依賴庫：
org.springframework spring-test org.mockito mockito-all ${mockito.version} junit junit ${junit.version}
然后，對應的單元測試用例HomeControllerTest的代碼如下所示：
package org.test.spittr.web;
import org.junit.Before;import org.junit.Test;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;
public class HomeControllerTest {
MockMvc mockMvc;
@Before
public void setupMock() {
HomeController controller = new HomeController();
mockMvc = standaloneSetup(controller).build();
}
@Test
public void testHomePage() throws Exception {
mockMvc.perform(get("/"))
.andExpect(view().name("home"));
}
}
首先stanaloneSetup()方法通過HomeController的實例模擬出一個web服務，然后使用perform執行對應的GET請求，并檢查返回的視圖的名稱。MockMvcBuilders類有兩個靜態接口，代表兩種模擬web服務的方式：獨立測試和集成測試。上面這段代碼是獨立測試，我們也嘗試了集成測試的方式，最終代碼如下：
package org.test.spittr.web;
import org.junit.Before;import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.ContextHierarchy;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.web.context.WebApplicationContext;
import org.test.spittr.config.RootConfig;
import org.test.spittr.config.WebConfig;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;
@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration(value = "src/main/webapp")
@ContextHierarchy({
@ContextConfiguration(name = "parent", classes = RootConfig.class),
@ContextConfiguration(name = "child", classes = WebConfig.class)})
public class HomeControllerTest {
@Autowired
private WebApplicationContext context;
MockMvc mockMvc;
@Before
public void setupMock() {
//HomeController controller = new HomeController();
//mockMvc = standaloneSetup(controller).build();
mockMvc = webAppContextSetup(context).build();
}
@Test
public void testHomePage() throws Exception {
mockMvc.perform(get("/"))
.andExpect(view().name("home"));
}
}
5.2.2 定義類級別的請求處理
上面一節對之前的HomeController進行了簡單的測試，現在可以對它進行進一步的完善：將@RequestMapping從修飾函數改成修飾類，代碼如下：
package org.test.spittr.web;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Controller
@RequestMapping(value = "/")
public class HomeController {
@RequestMapping(method = RequestMethod.GET)
public String home() {
return "home";
}
}
在新的HomeController中，"/"被移動到類級別的@RequestMapping中，而定義HTTP方法的@RequestMapping仍然用于修飾home()方法。RequestMapping注解可以接受字符串數組，即可以同時映射多個路徑，因此我們還可以按照下面這種方式修改：
@Controller
@RequestMapping({"/", "/homepage"})
public class HomeController {
}
}
5.2.3 給視圖傳入模型數據
對于DispatcherServlet傳來的請求，控制器通常不會實現具體的業務邏輯，而是調用業務層的接口，并且將業務層服務返回的數據放在模型對象中返回給DispatcherServlet。
在Spittr應用中，需要一個頁面顯示最近的spittles列表。首先需要定義數據庫存取接口，這里不需要提供具體實現，只需要用Mokito框架填充模擬測試數據即可。SpittleRepository接口的代碼列舉如下：
package org.test.spittr.data;
import java.util.List;
public interface SpittleRepository {
List findSpittles(long max, int count);
}
SpittleRepository接口中的findSpittles()方法有兩個參數：max表示要返回的Spittle對象的最大ID；count表示指定需要返回的Spittle對象數量。為了返回20個最近發表的Spittle對象，則使用List
package org.test.spittr.data;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import java.util.Date;
public class Spittle {
private final Long id;
private final String message;
private final Date time;
private Double latitude;
private Double longitude;
public Spittle(String message, Date time) {
this(message, time, null, null);
}
public Spittle(String message,Date time, Double latitude, Double longitude) {
this.id = null;
this.time = time;
this.latitude = latitude;
this.longitude = longitude;
this.message = message;
}
public Long getId() {
return id;
}
public String getMessage() {
return message;
}
public Date getTime() {
return time;
}
public Double getLongitude() {
return longitude;
}
public Double getLatitude() {
return latitude;
}
@Override
public boolean equals(Object obj) {
return EqualsBuilder.reflectionEquals(this, obj,
new String[]{"message","latitude", "longitude"});
}
@Override
public int hashCode() {
return HashCodeBuilder.reflectionHashCode(this,
new String[]{"message", "latitude", "longitude"});
}
}
Spittle對象還是POJO，并沒什么復雜的。唯一需要注意的就是，利用Apache Commons Lang庫的接口，用于簡化equals和hashCode方法的實現。參考Apache Commons EqualsBuilder and HashCodeBuilder
首先為新的控制器接口寫一個測試用例，利用Mockito框架模擬repository對象，并模擬出request請求，代碼如下：
package org.test.spittr.web;
import org.junit.Test;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.web.servlet.view.InternalResourceView;
import org.test.spittr.data.Spittle;import org.test.spittr.data.SpittleRepository;import java.util.ArrayList;
import java.util.Date;import java.util.List;
import static org.hamcrest.Matchers.hasItems;
import static org.mockito.Mockito.*;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;
public class SpittleControllerTest {
@Test
public void shouldShowRecentSpittles() throws Exception {
//step1 準備測試數據
List expectedSpittles = createSpittleList(20);
SpittleRepository mockRepository = mock(SpittleRepository.class);
when(mockRepository.findSpittles(Long.MAX_VALUE, 20))
.thenReturn(expectedSpittles);
SpittleController controller = new SpittleController(mockRepository);
MockMvc mockMvc = standaloneSetup(controller)
.setSingleView(new InternalResourceView("/WEB-INF/views/spittles.jsp"))
.build();
//step2 and step3
mockMvc.perform(get("/spittles"))
.andExpect(view().name("spittles"))
.andExpect(model().attributeExists("spittleList"))
.andExpect(model().attribute("spittleList",
hasItems(expectedSpittles.toArray())));
}
private List createSpittleList(int count) {
List spittles = new ArrayList();
for (int i = 0; i < count; i++) {
spittles.add(new Spittle("Spittle " + i, new Date()));
}
return spittles;
}
}
單元測試的基本組成是：準備測試數據、調用待測試接口、校驗接口的執行結果。對于shouldShowRecentSpittles()這個用例我們也可以這么分割：首先規定在調用SpittleRepository接口的findSpittles()方法時將返回20個Spittle對象。
這里選擇獨立測試，跟HomeControllerTest不同的地方在于，這里構建MockMvc對象時還調用了setSingleView()函數，這是為了防止mock框架從控制器解析view名字。在很多情況下并沒有這個必要，但是對于SpittleController控制器來說，視圖名稱和路徑名稱相同，如果使用默認的視圖解析器，則MockMvc會混淆這兩者而失敗，報出如下圖所示的錯誤：
在這里其實可以隨意設置InternalResourceView的路徑，但是為了和WebConfig中的配置相同。
通過get方法構造GET請求，訪問"/spittles"，并確保返回的視圖名稱是"spittles"，返回的model數據中包含spittleList屬性，且對應的值為我們之前創建的測試數據。
最后，為了使用hasItems，需要在pom文件中引入hamcrest庫，代碼如下
org.hamcrest hamcrest-library 1.3
現在跑單元測試的話，必然會失敗，因為我們還沒有提供SpittleController的對應方法，代碼如下：
package org.test.spittr.web;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.test.spittr.data.SpittleRepository;
@Controller
@RequestMapping("/spittles")
public class SpittleController {
private SpittleRepository spittleRepository;
@Autowired
SpittleController(SpittleRepository spittleRepository) {
this.spittleRepository = spittleRepository;
}
@RequestMapping(method = RequestMethod.GET)
public String spittles(Model model) {
model.addAttribute(
spittleRepository.findSpittles(Long.MAX_VALUE, 20));
return "spittles";
}
}
Model對象本質上是一個Map，spittles方法負責填充數據，然后跟視圖的邏輯名稱一起回傳給DispatcherServlet。在調用addAttribute方法的時候，如果不指定key字段，則key字段會從value的類型推導出，在這個例子中默認的key字段是spittleList。
如果你希望顯式指定key字段，則可以按照如下方式指定：
@RequestMapping(method = RequestMethod.GET)
public String spittles(Model model) {
model.addAttribute("spittleList",
spittleRepository.findSpittles(Long.MAX_VALUE, 20));
return "spittles";
}
另外，如果你希望盡量少使用Spring規定的數據類型，則可以使用Map代替Model。
還有另一種spittles方法的實現，如下所示：
@RequestMapping(method = RequestMethod.GET) public Listspittles() { return spittleRepository.findSpittles(Long.MAX_VALUE, 20)); }
這個版本和之前的不同，并沒有返回一個邏輯名稱以及顯式設置Model對象，這個方法直接返回Spittle列表。在這種情況下，Spring會將返回值直接放入Model對象，并從值類型推導出對應的關鍵字key；然后從路徑推導出視圖邏輯名稱，在這里是spittles。
無論你選擇那種實現，最終都需要一個頁面——spittles.jsp。JSP頁面使用JSTL庫的
