《Spring实战》是学习Spring框架的一本非常经典的书籍，之前阅读了这本书，只是在书本上写写画画，最近整理了一下《Spring实战》的读书笔记，通过博客的方式进行记录分享。俗话说，好记性不如烂笔头，把学习到的知识记录下来，方便温故知新，让更多的读者可以学习到有关Spring框架的知识。
| 序号 | 内容 | 链接地址 |
|---|---|---|
| 1 | 《Spring实战》读书笔记-第1章 Spring之旅 | https://blog.csdn.net/ThinkWon/article/details/103097364 |
| 2 | 《Spring实战》读书笔记-第2章 装配Bean | https://blog.csdn.net/ThinkWon/article/details/103527675 |
| 3 | 《Spring实战》读书笔记-第3章 高级装配 | https://blog.csdn.net/ThinkWon/article/details/103536621 |
| 4 | 《Spring实战》读书笔记-第4章 面向切面的Spring | https://blog.csdn.net/ThinkWon/article/details/103541166 |
| 5 | 《Spring实战》读书笔记-第5章 构建Spring Web应用程序 | https://blog.csdn.net/ThinkWon/article/details/103550083 |
| 6 | 《Spring实战》读书笔记-第6章 渲染Web视图 | https://blog.csdn.net/ThinkWon/article/details/103559672 |
| 7 | 《Spring实战》读书笔记-第7章 Spring MVC的高级技术 | https://blog.csdn.net/ThinkWon/article/details/103562467 |
- 映射请求到Spring控制器
- 透明地绑定表单参数
- 校验表单提交
5.1 Spring MVC起步
Spring MVC框架主要包括请求调度Servlet、处理器映射（handler mapping）、控制器以及视图解析器（view resolver）这些组件。跟踪Spring MVC的请求 Web请求从离开浏览器开始到获取响应返回，它会经历好多站，每站都会留下一些信息同时带上其他信息。
一路上请求会将信息带到很多站点，并产生期望的结果 请求带着URL以及其他信息离开浏览器后，第一站是Spring的DispatcherServlet（前端控制器）。它的任务将请求发送给Spring MVC控制器。由于可能有多个控制器，DispatcherServlet会查询一个或多个处理器映射来确定请求的下一站，处理器映射会根据URL信息来决策。选择合适的控制器后，DispatcherServlet将请求发送给选中的控制器。到了控制器，它会处理请求带来的信息。 控制器处理完成后，会将模型数据打包，并且标示出用于渲染输出的视图名。它接下来将请求连同模型和视图名发送回DispatcherServlet，目的是解耦。传递给DispatcherServlet的视图名并不直接标示某个特定的JSP。它仅仅传递了一个逻辑名称，用来查找产生结果的真正视图。DispatcherServlet将会使用视图解析器来将逻辑视图名匹配为一个特定的视图实现（可能是JSP）。 DispatcherServlet的最后一站是视图的实现（可能是JSP），在这里它交付模型数据。视图将使用模型数据渲染输出，通过响应对象传递给客户端。
搭建Spring MVC 首先配置DispatcherServlet，它是Spring MVC的核心。如果按传统方式，DispatcherServlet会配置在web.xml中。另一种方式可以将DispatcherServlet配置在Servlet容器中。
package 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() { return new Class<?>[] { WebConfig.class }; } @Override // 将DispatcherServlet映射到“/” protected String[] getServletMappings() { return new String[]{ "/"}; }}AbstractAnnotationConfigDispatcherServletInitializer剖析 在Servlet3.0环境中，容器会在类路径中查找实现javax.servlet.ServletContainerInitializer接口的类，如果能发现的话，就会用它来配置Servlet容器。 Spring提供了这个接口的实现，名为SpringServletContainerInitializer，这个类反过来又会查找实现WebApplicationInitializer的类并将配置的任务交给它们来完成。Spring3.2引入了一个便利的WebApplicationInitializer基础实现，也就是AbstractAnnotationConfigDispatcherServletInitializer。因为我们的SpittrWebAppInitializer扩展了AbstractAnnotationConfigDispatcherServletInitializer（同时也就实现了WebApplicationInitializer），因此当部署到Servlet3.0容器中的时候，容器会自动发现它，并用它来配置Servlet上下文。 在本例中，SpittrWebAppInitializer重新了三个方法。 第一个方法是getServletMappings()，它会将一个或多个路径映射到DispatcherServlet上。本例中，它映射的是“/”，这表示它会是应用的默认Servlet。它会处理进入应用的所有请求。 为了理解其他的两个方法，首先要理解DispatcherServlet和一个Servlet监听器（也就是ContextLoaderListener）的关系。 当DispatcherServlet启动时，它会创建Spring应用上下文，并加载配置文件或配置类中所声明的bean。在代码中的getServletConfigClasses()方法中，我们要求DispatcherServlet加载应用上下文时，使用定义在WebConfig配置类（使用Java配置）中的bean。 但是在Spring Web应用中，通常还会有另外一个应用上下文。另外的这个应用上下文是由ContextLoaderListener创建的。 我们希望DispatcherServlet加载包含Web组件的bean，如控制器、视图解析器以及处理器映射，而ContextLoaderListener要加载应用中的其他bean。这些bean通常是驱动应用后端的中间层和数据层组件。 实际上，AbstractAnnotationConfigDispatcherServletInitializer会同时创建 DispatcherServlet和ContextLoaderListener。getServletConfigClasses()方法返回的带有@Configuration注解的类将会用来定义DispatcherServlet应用上下文中的bean。getRootConfigClasses()方法返回的带有@Configuration注解的类将会用来配置ContextLoaderListener创建的应用上下文中bean。 在本例中，根配置定义在RootConfig中，DispatcherServlet的配置声明在WebConfig中。 如果按照这种方式配置DispatcherServlet，它只能部署到支持Servlet 3.0的服务器中才能正常工作，如Tomcat 7或更高版本。
启动Spring MVC 启动Spring MVC组件的方法也不仅一种。除了传统的XML配置，还可选择基于Java进行配置。
package 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@ComponentScan("spittr.web") // 启动组件扫描@EnableWebMvc // 启动spring mvcpublic class WebConfig extends WebMvcConfigurerAdapter { @Bean public ViewResolver viewResolver(){ // 配置jsp视图解析器 InternalResourceViewResolver resolver = new InternalResourceViewResolver(); resolver.setPrefix("/views/"); resolver.setSuffix(".jsp"); resolver.setExposeContextBeansAsAttributes(true); return resolver; } // 配置静态资源的处理 @Override public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { configurer.enable(); }}package spittr.config;import org.springframework.context.annotation.ComponentScan;import org.springframework.context.annotation.ComponentScan.Filter;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.FilterType;import org.springframework.web.servlet.config.annotation.EnableWebMvc;@Configuration@ComponentScan(basePackages = {"spittr"}, excludeFilters = {@Filter(type = FilterType.ANNOTATION, value = EnableWebMvc.class)})public class RootConfig {}5.2 编写基本的控制器
在Spring MVC中，控制器只是方法上添加了@RequestMapping注解的类，这个注解声明了它们所要处理的请求。 下面是简单的HomeController控制器package spittr.web;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import static org.springframework.web.bind.annotation.RequestMethod.GET;@Controller // 声明为一个控制器public class HomeController { @RequestMapping(value = "/",method = GET) // 处理对“/”的GET请求 public String home(){ return "home"; // 视图名为 home }}<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %><%@ page contentType="text/html;charset=UTF-8" language="java" session="false"%>
<html><head> <title>Spittr</title> <link rel="stylesheet" type="text/css" href="<c:url value="/resources/style.css" />" />
</head><body> <h1>Welcome to Spittr</h1> <a href="<c:url value="/spittles" />">Spittles</a> |
<a href="<c:url value="/spitter/register" />">Register</a></body></html>
测试控制器 我们可以编写一个简单的类来测试HomeController，
package spittr.web;import org.junit.Test;import static org.junit.Assert.assertEquals;public class HomeControllerTest { @Test public void testHomePage() throws Exception { HomeController controller = new HomeController(); assertEquals("home", controller.home()); }}package spittr.web;import org.junit.Test;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.*;import org.springframework.test.web.servlet.MockMvc;public class HomeControllerTest { @Test public void testHomePage() throws Exception { HomeController controller = new HomeController(); MockMvc mockMvc = standaloneSetup(controller).build(); // 搭建MockMvc mockMvc.perform(get("/")). // 对"／"执行GET请求 andExpect(view().name("home")); // 预期得到home视图 }}定义类级别的请求处理 我们可以拆分@RequestMapping，并将其路径映射部分放到类级别上。
package spittr.web;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import static org.springframework.web.bind.annotation.RequestMethod.GET;@Controller @RequestMapping("/") // 将控制器映射到"/"public class HomeController { @RequestMapping(method = GET) // 处理GET请求 public String home(){ return "home"; // 视图名为 home }}@Controller@RequestMapping({"/","/homepage"})public class HomeController { ...}传递模型数据到视图中 我们需要有一个页面展现最近提交的Spittle列表。因此，我们需要一个新的方法来处理这个页面。 首先，需要定义一个数据访问的Repository。为了实现解耦以及避免陷入数据库访问的细节之中，我们将Repository定义为一个接口，并在稍后实现它。
package spittr.data;import spittr.model.Spittle;import java.util.List;public interface SpittleRepository { List<Spittle> findSpittles(long max, int count);}List<Spittle> recent = spittleRepository.findSpittles(Long.MAX_VALUE, 20);package spittr.model;import java.util.Date;import org.apache.commons.lang3.builder.EqualsBuilder;import org.apache.commons.lang3.builder.HashCodeBuilder;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 longitude, Double latitude){ this.id = null; this.message = message; this.time = time; this.longitude = longitude; this.latitude = latitude; } public long getId(){ return id; } public String getMessage(){ return message; } public Date getTime() { return time; } public Double getLatitude() { return latitude; } public Double getLongitude() { return longitude; } @Override public boolean equals(Object that){ return EqualsBuilder.reflectionEquals(this,that,"id", "time"); } @Override public int hashCode(){ return HashCodeBuilder.reflectionHashCode(this,"id", "time"); }}@Testpublic void shouldShowRecentSpittles() throws Exception{ List<Spittle> 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("/views/spittles.jsp")).build(); mockMvc.perform(get("/spittles")) // 对“/spittles”发起GET请求 .andExpect(view().name("spittles")) .andExpect(model().attributeExists("spittleList")) .andExpect(model().attribute("spittleList",hasItems(expectedSpittles.toArray())));}....private List<Spittle> createSpittleList(int count){ List<Spittle> spittles = new ArrayList<Spittle>(); for(int i = 0; i < count; i++){ spittles.add(new Spittle("Spittle " + i, new Date())); } return spittles;}package 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.*;import spittr.data.SpittleRepository;import spittr.model.Spittle;import java.util.List;@Controller@RequestMapping("/spittles")public class SpittleController { private SpittleRepository spittleRepository; @Autowired public SpittleController(SpittleRepository spittleRepository){ this.spittleRepository = spittleRepository; } @RequestMapping(method=RequestMethod.GET) public String spittles(Model model) { // 将spittle添加到模型中 model.addAttribute(spittleRepository
.findSpittles(Long.MAX_VALUE,20)); return "spittles"; // 返回视图名 }}@RequestMapping(method=RequestMethod.GET)public String spittles(Model model) { model.addAttribute("spittleList", spittleRepository.findSpittles(Long.MAX_VALUE,20)); return "spittles"; }@RequestMapping(method=RequestMethod.GET)public List<Spittle> spittles(){ return spittleRepository.findSpittles(Long.MAX_VALUE, 20);}<c:forEach items="${spittleList}" var="spittle"> <li id="spittle_<c:out value="spittle.id"/>">
<div class="spittleMessage"> <c:out value="${spittle.message}"/> </div> <div> <span class="spittleTime"> <c:out value="${spittle.time.toString()}"/> </span> <span class="spittleLocation"> (<c:out value="${spittle.latitude}"/>,
<c:out value="${spittle.longitude}"/>)
</span> </div> </li></c:forEach>
控制器中的Spittle模型数据将会作为请求参数，并在Web页面上渲染为列表形式
5.3 接受请求的输入
Spring MVC允许以多种方式将客户端中的数据传送到控制器的处理方法中，包括：- 查询参数（Query Parameter）
- 表单参数（Form Parameter）
- 路径变量（Path Variable）
处理查询参数 我们来实现一个查询Spittle列表的分页功能。为了实现这个功能，我们所编写的处理器方法要接受如下的参数：
- before参数（表明结果中所有Spittle的ID均应该在这个值之前）
- count参数（表明在结果中要包含的Spittle数量）
@Testpublic void shouldShowPagedSpittles() throws Exception{ List<Spittle> expectedSpittles = createSpittleList(50); SpittleRepository mockRepository = mock(SpittleRepository.class); when(mockRepository.findSpittles(238900,50)).thenReturn(expectedSpittles); SpittleController controller = new SpittleController(mockRepository); MockMvc mockMvc = standaloneSetup(controller) .setSingleView(new InternalResourceView("/views/spittles.jsp")).build(); mockMvc.perform(get("/spittles?max=238900&count=50")) .andExpect(view().name("spittles")) .andExpect(model().attributeExists("spittleList")) .andExpect(model().attribute("spittleList",hasItems(expectedSpittles.toArray())));}@RequestMapping(method=RequestMethod.GET)public List<Spittle> spittles( @RequestParam(value="max", defaultValue=MAX_LONG_AS_STRING) long max, @RequestParam(value="count", defaultValue="20") int count) { return spittleRepository.findSpittles(max, count);}通过路径参数接受输入 假设我们的应用程序需要根据给定的ID来展现某一个Spittle记录。其中一种方法就是编写处理器方法，通过使用@RequestParam注解，让它接受ID作为查询参数。另一种方式，要识别的资源应该通过URL路径进行标示。对“/spittles/12345”发起GET请求要优于对“/spittles/show?spittle_id=12345”发起请求。 我们先将这个需求转换为一个测试
@Testpublic void testSpittle() throws Exception{ Spittle expectedSpittle = new Spittle("Hello" , new Date()); SpittleRepository mockRepository = mock(SpittleRepository.class); when(mockRepository.findOne(12345)).thenReturn(expectedSpittle); SpittleController controller = new SpittleController(mockRepository); MockMvc mockMvc = standaloneSetup(controller).build(); mockMvc.perform(get("/spittles/12345")) .andExpect(view().name("spittle")) .andExpect(model().attributeExists("spittle")) .andExpect(model().attribute("spittle",expectedSpittle));}@RequestMapping(value="/{spittleId}", method=RequestMethod.GET)public String spittle(@PathVariable("spittleId") long spittleId, Model model) { model.addAttribute(spittleRepository.findOne(spittleId)); return "spittle";}@RequestMapping(value="/{spittleId}", method=RequestMethod.GET)public String spittle(@PathVariable long spittleId, Model model) { model.addAttribute(spittleRepository.findOne(spittleId)); return "spittle";}<div class="spittleView"> <div class="spittleMessage"><c:out value="${spittle.message}" /></div> <div> <span class="spittleTime"><c:out value="${spittle.time}" /></span> </div></div>
在浏览器中展现一个spittle
5.4 处理表单
Spring MVC的控制器也为表单处理提供了良好的支持。 使用表单分为两个方面：展现表单以及处理用户通过表单提交的数据。在Spittr应用中，我们需要有个表单让新用户注册。package 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.PathVariable;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestPart;import spittr.data.SpitterRepository;import spittr.model.Spitter;import static org.springframework.web.bind.annotation.RequestMethod.*;@Controller@RequestMapping("/spitter")public class SpitterController { @RequestMapping(value="/register", method=GET) public String showRegistrationForm(Model model) { return "registerForm"; }}<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %><%@ page session="false" language="java" pageEncoding="UTF-8" contentType="text/html; charset=utf-8"%>
<!DOCTYPE HTML><html> <head> <title>Spitter</title> <link rel="stylesheet" type="text/css"
href="<c:url value="/resources/style.css" />" >
</head> <body> <h1>Register</h1> <form method="POST" > First Name: <input path="firstName" /><br/> Last Name: <input path="lastName" /><br/> Email: <input type="email" path="email" /><br/> Username: <input path="username" /><br/> Password: <password path="password" /><br/> <input type="submit" value="Register" /> </form> </body></html><form>标签中并没有设置action属性。在这种情况下，当表单提交时，它会提交到与展现时相同的URL路径上。也就是，它会提交到“/spitter/register”上。
编写处理表单的控制器 当处理注册表单的POST请求时，控制器需要接受表单数据并将表单数据保存为Spitter对象。最后，为了防止重复提交（用户点击浏览器的刷新按钮又可能会发生这种情况），应该将浏览器重定向到新创建用户的基本信息页面。这些行为通过下面的shouldProcessRegistration()进行测试。
@Testpublic void shouldProcessRegistration() throws Exception { SpitterRepository mockRepository = mock(SpitterRepository.class); Spitter unsaved = new Spitter("jbauer", "24hours","Jack", "Bauer"); Spitter saved = new Spitter(24L,"jbauer", "24hours","Jack", "Bauer"); when(mockRepository.save(unsaved)).thenReturn(saved); SpitterController controller = new SpitterController(mockRepository); MockMvc mockMvc = standaloneSetup(controller).build(); mockMvc.perform(post("/spitter/register") .param("firstName", "Jack") .param("lastName", "Bauer") .param("username", "jbauer") .param("password", "24hours") .andExpect(redirectedUrl("/spitter/jbauer")); verify(mockRepository,atLeastOnce()).save(unsaved); }package spittr.web;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.security.core.context.SecurityContextHolder;import org.springframework.stereotype.Controller;import org.springframework.ui.Model;import org.springframework.web.bind.annotation.PathVariable;import org.springframework.web.bind.annotation.RequestMapping;import spittr.data.SpitterRepository;import spittr.model.Spitter;import static org.springframework.web.bind.annotation.RequestMethod.*;@Controller@RequestMapping("/spitter")public class SpitterController { private SpitterRepository spitterRepository; @Autowired public SpitterController(SpitterRepository spitterRepository){ this.spitterRepository = spitterRepository; } @RequestMapping(value="/register", method=GET) public String showRegistrationForm(Model model) { return "registerForm"; } @RequestMapping(value="/register", method=POST) public String processRegistration(Spitter spitter) { spitterRepository.save(spitter); return "redirect:/spitter/"+spitter.getUsername(); }}@RequestMapping(value="/{username}", method=GET)public String showSpitterProfile(@PathVariable String username, Model model) { Spitter spitter = spitterRepository.findByUsername(username); model.addAttribute(spitter); return "profile";}<h1>Your Profile</h1> <c:out value="${spitter.username}" /><br/> <c:out value="${spitter.firstName}" /> <c:out value="${spitter.lastName}" />
Spittr的基本信息页展示了用户的情况，这些信息是由SpitterController填充到模型中的
校验表单 如果用户在提交表单的时候，文本域为空，会导致新建对象中某些关键字段为空。如果不处理这种现象，将会出现安全问题。 从Spring 3.0开始，在Spring MVC中提供了对Java校验API的支持。在Spring MVC中要使用它的话，只要保证在类路径下包含这个Java API的实现即可，比如Hibernate Validator。 Java校验API定义了多个注解，这些注解可以放到属性上，从而限制这些属性的值。所有注解都位于javax.validation.constraints包中。下表列出了这些校验注解
| 注解 | 描述 |
|---|---|
| @AssertFalse | 所注解的元素必须是Boolean类型，并且值为false |
| @AssertTrue | 所注解的元素必须是Boolean类型，并且值为true |
| @DecimalMax | 所注解的元素必须是数字，并且它的值要小于或等于给定的BigDecimalString值 |
| @DecimalMin | 所注解的元素必须是数字，并且它的值要大于或等于给定的BigDecimalString值 |
| @Digits | 所注解的元素必须是数字，并且它的值必须有指定的位数 |
| @Future | 所注解的元素的值必须是一个将来的日期 |
| @Max | 所注解的元素必须是数字，并且它的值要小于或等于给定的值 |
| @Min | 所注解的元素必须是数字，并且它的值要大于或等于给定的值 |
| @NotNull | 所注解的元素的值必须不能为Null |
| @Null | 所注解的元素的值必须为Null |
| @Past | 所注解的元素的值必须是一个已过期的日期 |
| @Pattern | 所直接的元素的值必须匹配给定的正则表达式 |
| @Size | 所注解的元素的值必须是String、集合或数组，并且它的长度要符合给定的范围 |
package spittr.model;import javax.validation.constraints.NotNull;import javax.validation.constraints.Size;import org.apache.commons.lang3.builder.EqualsBuilder;import org.apache.commons.lang3.builder.HashCodeBuilder;public class Spitter { private Long id; @NotNull @Size(min=5, max=16) private String username; @NotNull @Size(min=5, max=25) private String password; @NotNull @Size(min=2, max=30) private String firstName; @NotNull @Size(min=2, max=30) private String lastName; public Spitter() {} public Spitter(String username, String password, String firstName, String lastName) { this(null, username, password, firstName, lastName); } public Spitter(Long id, String username, String password, String firstName, String lastName) { this.id = id; this.username = username; this.password = password; this.firstName = firstName; this.lastName = lastName; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public Long getId() { return id; } public void setId(Long id) { this.id = id; } public String getFirstName() { return firstName; } public void setFirstName(String firstName) { this.firstName = firstName; } public String getLastName() { return lastName; } public void setLastName(String lastName) { this.lastName = lastName; } @Override public boolean equals(Object that) { return EqualsBuilder.reflectionEquals(this, that, "firstName", "lastName", "username", "password"); } @Override public int hashCode() { return HashCodeBuilder.reflectionHashCode(this, "firstName", "lastName", "username", "password"); }}@RequestMapping(value="/register", method=POST)public String processRegistration( @Valid Spitter spitter, // 校验 Spitter输入 Errors errors) { if (errors.hasErrors()) { return "registerForm"; // 如果校验出现错误，则重新返回表单 } spitterRepository.save(spitter); return "redirect:/spitter/" + spitter.getUsername();}