《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 MVC配置的替代方案
- 处理文件上传
- 在控制器中处理异常
- 使用flash属性
7.1 Spring MVC配置的替代方案
自定义DispatcherServlet配置 除了我们之前在SpitterWebAppInitializer中所编写的三个方法仅仅是必须要重载的abstract方法，AbstractAnnotationConfigDispatcherServletInitializer所完成的事情其实比看上去的要多。 此类的方法之一就是customizeRegistration()。 在AbstractAnnotationConfigDispatcherServletInitializer将DispatcherServlet注册到Servlet容器中之后，就会调用customizeRegistration()，并将Servlet注册后得到的Registration.Dynamic传递进来。通过重载customizeRegistration()方法，我们可以对DispatcherServlet进行额外的配置。 例如，可以在Spring MVC中处理请求和文件上传。如果计划使用Servlet 3.0对multipart配置的支持，那么需要使用DispatcherServlet的registration来启动multipart请求。我们可以重载customizeRegistration()方法来设置MultipartConfigElement，如下所示：
@Overrideprotected void customizeRegistration(ServletRegistration.Dynamic registration) { // 存入文件路径；单个文件大小不超过2MB；整个请求不超过4MB；所有的文件都要写入磁盘中 registration.setMultipartConfig(new MultipartConfigElement("/Users/Shangnan/Documents/service_upload/springinaction/spittr" ,2097152,4194304, 0));}添加其他的Servlet和Filter 基于Java的初始化器（initializer）的一个好处就在于我们可以定义任意数量的初始化器类。因此，如果我们想往Web容器中注册其他组件的话，只需要创建一个新的初始化器就可以了。最简单的方式就是实现Spring的WebApplicationInitializer接口。 例如，如下的程序展示了如何创建WebApplicationInitializer实现并注册一个Servlet。
package com.myapp.config;import javax.servlet.ServletContext;import javax.servlet.ServletException;import javax.servlet.ServletRegistration.Dynamic;import org.springframework.web.WebApplicationInitializer;import com.myapp.MyServlet;public class MyServletInitializer implements WebApplicationInitializer { @Override public void onStartup(ServletContext servletContext) throws ServletException { Dynamic myServlet = servletContext.addServlet("myServlet", MyServlet.class); // 注册 Servlet myServlet.addMapping("/custom/**"); // 映射 Servlet }}@Overridepublic void onStartup(ServletContext servletContext) throws ServletException { Dynamic filter = servletContext.addFilter("myFilter", MyFilter.class); // 注册 Filter filter.addMappingForUrlPatterns(null, false, "/custom/**"); // 添加Filter的映射路径}@Overrideprotected Filter[] getServletFilters(){ return new Filter[] { new MyFilter() };}在web.xml中声明DispatcherServlet 在典型的Spring MVC应用中，我们会需要DispatcherServlet和ContextLoaderListener。如下是一个基本的web.xml文件，它按照传统的方式搭建了DispatcherServlet和ContextLoaderListener。
<?xml version="1.0" encoding="UTF-8" ?><web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"> <context-param> <param-name>contextConfigLocation</param-name> <!--设置根上下文配置文件位置--> <param-value>/WEB-INF/spring/root-context.xml</param-value> </context-param> <!--注册ContextLoaderListener--> <listener> <listener-class> org.springframework.web.context.ContextLoaderListener
</listener-class> </listener> <!--注册DispatcherServlet--> <servlet> <servlet-name>appServlet</servlet-name> <servlet-class> org.springframework.web.servlet.DispatcherServlet
</servlet-class> </servlet> <!--将DispatcherServlet映射到“/”--> <servlet-mapping> <servlet-name>appServlet</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping></web-app><servlet> <servlet-name>appServlet</servlet-name> <servlet-class> org.springframework.web.servlet.DispatcherServlet
</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/spring/appServlet/servlet-context.xml
</param-value> </init-param> <load-on-startup>1</load-on-startup></servlet><?xml version="1.0" encoding="UTF-8" ?><web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"> <context-param> <param-name>contextClass</param-name> <!--使用Java配置--> <param-value> org.springframework.web.context.support.
AnnotationConfigWebApplicationContext
</param-value> </context-param> <context-param> <param-name>contextConfigLocation</param-name> <!--指定根配置类--> <param-value>com.jourwon.spitter.config.RootConfig</param-value> </context-param> <listener> <listener-class> org.springframework.web.context.ContextLoaderListener
</listener-class> </listener> <servlet> <servlet-name>appServlet</servlet-name> <servlet-class> org.springframework.web.servlet.DispatcherServlet
</servlet-class> <init-param> <param-name>contextClass</param-name> <param-value> org.springframework.web.context.support.
AnnotationConfigWebApplicationContext
</param-value> </init-param> <init-param> <param-name>contextConfigLocation</param-name> <param-value> com.jourwon.spittr.config.WebConfigConfig
</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>appServlet</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping></web-app>7.2 处理multipart形式的数据
Spittr应用在两个地方需要文件上传。当新用户注册应用的时候，我们希望他们能够上传一张图片，从而与他们的个人信息相关联。当用户提交新的Spittle时，除了文本消息以外，他们可能还会上传一张照片。 对于传送二进制数据，如上传图片，与典型的基于文本的表单提交有所不同，multipart格式的数据会将一个表单拆分为多个部分（part），每个部分对应一个输入域。在一般的表单输入域中，它所对应的部分中会放置文本型数据，但是如果上传文件的话，它所对应的部分是二进制，下面展示了multipart的请求体： 展示了multipart的请求体：
在这个multipart的请求中，我们可以看到profilePicture部分与其他部分明显不同。除了其他内容以外，它还有自己的Content-type头，表明它是一个JPEG图片。尽管不一定那么明显，但profilePicture部分的请求体是二进制数据，而不是简单的文本。 在编写控制器方法之前，我们必须要配置一个multipart解析器，通过它来告诉DispatcherServlet该如何读取multipart请求。
配置multipart解析器 DispatcherServlet并没有实现任何解析multipart请求数据的功能。它将该任务委托给了Spring中MultipartResolver策略接口的实现，通过这个实现类解析multipart请求中的内容。从Spring 3.1开始，Spring内置了两个MultipartResolver的实现供我们选择：
- CommonsMultipartResolver：使用Jakarta Commons FileUpload解析multipart请求；
- StandardServletMultipartResolver：依赖于Servlet 3.0对multipart请求的支持（始于Spring 3.1）
@Beanpublic MultipartResolver multipartResolver() throws IOException { return new StrandardServletMultipartResolver();}- 上传文件的临时路径。
- 上传文件的最大容量（以字节为单位）。默认是没有限制的。
- 整个multipart请求的最大容量（以字节为单位），不会关心有多少个part以及每个part的大小。默认是没有限制的。
- 在上传的过程中，如果文件大小达到了一个指定最大容量（以字节单位），将会写入到临时文件路径中。默认值为0，也就是所上传的文件都会写入到磁盘上。
@Overrideprotected void customizeRegistration(Dynamic registration) { registration.setMultipartConfig(new MultipartConfigElement("/tmp/spittr/uploads", 2097152, 4194394, 0));}<servlet>中
<multipart-config>元素，如下所示：
<servlet> <servlet-name>appServlet</servlet-name> <servlet-class> org.springframework.web.servlet.DispatcherServlet
</servlet-class> <load-on-startup>1</load-on-startup> <multipart-config> <location>/tmp/spittr/uploads</location> <max-file-size>2097152</max-file-size> <max-request-size>4194394</max-request-size> </multipart-config></servlet>@Beanpublic MultipartResolver multipartResolver() { return new CommonsMultipartResulver();}@Beanpublic MultipartResolver multipartResolver() { CommonsMultipartResolver multipartResolver = new CommonsMultipartResolver(); multipartResolver.setUploadTempDir(new FileSystemResource("/tmp/spittr/uploads")); multipartResolver.setMaxUploadSize(2097152); multipartResolver.setMaxInMemorySize(0); return multipartResolver;}处理multipart请求 要实现控制器方法来接收上传的文件，最常见的方式就是在某个控制器方法参数上添加@RequestPart注解。 假设我们允许用户在注册Spittr应用的时候上传一张图片，那么我们需要修改表单，以允许用户选择要上传的图片，同时还需要修改SpitterController中的processRegistration() 方法来接收上传的图片。如下的代码片段来源于JSP注册表单视图：
<sf:form method="POST" commandName="spitter" enctype="multipart/form-data">...
<label>Profile Picture</label>:
<input type="file" name="profilePicture" accept="image/jpeg,image/png,image/gif" /><br/>...
</sf:form><form>标签现在将enctype属性设置为multipart/form-data，这会告诉浏览器以multipart数据的形式提交表单，而不是以表单数据的形式进行提交。在multipart中，每个输入域都会对应一个part。 除了注册表单中已有的输入域，我们还要添加了一个新的
<input>域，其type为file。这能够让用户选择要上传的图片文件。accept属性用来将文件类型限制为JPEG、PNG以及GIF图片。根据其name属性，图片数据将会发送到multipart请求中的profilePicture part之中。 现在我们需要修改processRegistration()方法，使其能够接受上传的图片。其中一种方式是添加byte数组参数，并为其添加@RequestPart注解。如下为示例：
@RequestMappting(value="/register", method=POST)public String processRegistration( @RequestPart("profilePicture") byte[] profilePicture, @Valid Spitter spitter, Errors errors) { ...}package org.springframework.web.multipart;import java.io.File;import java.io.IOException;import java.io.InputStream;import org.springframework.core.io.InputStreamSource;public interface MultipartFile extends InputStreamSource { String getName(); String getOriginalFilename(); String getContentType(); boolean isEmpty(); long getSize(); byte[] getBytes() throws IOException; InputStream getInputStream() throws IOException; void transferTo(File var1) throws IOException, IllegalStateException;} @RequestMapping(value="/register", method=POST) public String processRegistration( @Valid SpitterForm spitterForm, // 校验 Spitter输入 Errors errors) throws IllegalStateException, IOException { if (errors.hasErrors()) { return "registerForm"; // 如果校验出现错误，则重新返回表单 } Spitter spitter = spitterForm.toSpitter(); spitterRepository.save(spitter); MultipartFile profilePicture = spitterForm.getProfilePicture(); profilePicture.transferTo(new File("/tmp/spittr/" + profilePicture.getOriginalFilename())); return "redirect:/spitter/" + spitter.getUsername(); }package spittr.web;import javax.validation.constraints.NotNull;import javax.validation.constraints.Size;import org.hibernate.validator.constraints.Email;import org.springframework.web.multipart.MultipartFile;import spittr.model.Spitter;public class SpitterForm { @NotNull @Size(min=5, max=16, message="{username.size}") private String username; @NotNull @Size(min=5, max=25, message="{password.size}") private String password; @NotNull @Size(min=2, max=30, message="{firstName.size}") private String firstName; @NotNull @Size(min=2, max=30, message="{lastName.size}") private String lastName; @NotNull @Email private String email; private MultipartFile profilePicture; 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 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; } public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } public MultipartFile getProfilePicture() { return profilePicture; } public void setProfilePicture(MultipartFile profilePicture) { this.profilePicture = profilePicture; } public Spitter toSpitter() { return new Spitter(username, password, firstName, lastName, email); }}@RequestMappting(value="/register", method=POST)public String processRegistration( @RequestPart("profilePicture") Part profilePicture, @Valid Spitter spitter, Errors errors) { ...}profilePicture.write(new File("/tmp/spittr/" + profilePicture.getSubmittedFileName()));7.3 处理异常
不管发生什么事情，不管是好的还是坏的，Servlet请求的输出都是一个Servlet响应。如果在请求处理的时候，出现了异常，那它的输出依然会是Servlet响应。异常必须要以某种方式转换为响应。 Spring提供了多种方式将异常转换为响应：- 特定的Spring异常将会自动映射为指定的HTTP状态码；
- 异常上可以添加@ResponseStatus注解，从而将其映射为某一个HTTP状态码；
- 在方法上可以添加@ExceptionHandler注解，使其用来处理异常。
将异常映射为HTTP状态码 在默认情况下，Spring会将自身的一些异常自动转换为合适的状态码。下表列出了这些映射关系。
| Spring异常 | HTTP状态码 |
|---|---|
| BindException | 400 - Bad Request |
| ConversionNotSupportedException | 500 - Internal Server Error |
| HttpMediaTypeNotAcceptableException | 406 - Not Acceptable |
| HttpMediaTypeNotSupportedException | 415 - Unsupported Media Type |
| HttpMessageNotWritableException | 500 - Internal Server Error |
| HttpRequestMethodNotSupportedException | 405 - Method Not Allowed |
| MethodArgumentNotValidException | 400 - Bad Request |
| MissingServletRequestParameterException | 400 - Bad Request |
| MissingServletRequestPartException | 400 - Bad Request |
| NoSuchRequestHandlingMethodException | 404 - Not Found |
| TypeMismatchException | 400 - Bad Request |
@RequestMapping(value="/{spittleId}" , method=RequestMethod.GET)public String spittle( @PathVariable("spittleId") long spittleId, Model model) { Spittle spittle = spittleRepository.findOne(spittleId); if (spittle == null) { throw new SpittleNotFoundException(); } model.addAttribute(spittle); return "spittle";}package spittr.web;public class SpittleNotFoundException extends RuntimeException {}package spittr.web;import org.springframework.http.HttpStatus;import org.springframework.web.bind.annotation.ResponseStatus;@ResponseStatus(value = HttpStatus.NOT_FOUND, reason = "Spittle Not Found")public class SpittleNotFoundException extends RuntimeException {}编写异常处理的方法 作为样例，假设用户试图创建的Spittle与已创建的Spittle文本完全相同，那么SpittleRepository的save()方法将会抛出DuplicateSpittleException异常。这意味着SpittleController的saveSpittle()方法可能需要处理这个异常。如下面的程序所示，saveSpittle()方法可以只关注成功保存Spittle的情况。
@RequestMapping(method=RequestMethod.POST)public String saveSpittle(SpittleForm form, Model model) throws Exception { spittleRepository.save(new Spittle(null, form.getMessage(), new Date(), form.getLongitude(), form.getLatitude())); return "redirect:/spittles";}@ExceptionHandler(DuplicateSpittleException.class)public String handleDuplicateSpittle(){ return "error/duplicate";}7.4 为控制器添加通知
如果控制器类的特定切面能够运用到整个应用程序的所有控制器中，那么这将会便利很多。举例说明，如果要在多个控制器中处理异常，那@ExceptionHandler注解所标注的方法是很有用的。不过，如果多个控制器类中都会抛出某个特定的异常，那么你可能会发现要在所有的控制器方法中重复相同的@ExceptionHandler方法。或者，为了避免重复，我们会创建一个基础的控制器类，所有控制器类要扩展这个类，从而继承通用的@ExceptionHandler方法。 Spring 3.2为这类问题引入了一个新的解决方案：控制器通知。 控制器通知（controller advice）是任意带有@ControllerAdvice注解的类，这个类会包含一个或多个如下类型的方法：- @ExceptionHandler注解标注的方法；
- @InitBinder注解标注的方法；
- @ModelAttribute注解标注的方法；
package spittr.web;import org.springframework.web.bind.annotation.ControllerAdvice;import org.springframework.web.bind.annotation.ExceptionHandler;@ControllerAdvicepublic class AppWideExceptionHandler { @ExceptionHandler(DuplicateSpittleException.class) public String duplicateSpittleHandler(){ return "error/duplicate"; }}7.5 跨重定向请求传递数据
在处理完POST请求后，通常来讲一个最佳实践就是执行一下重定向。除了其他的一些因素外，这样做能够防止用户点击浏览器的刷新按钮或后退箭头时，客户端重新执行危险的POST请求。 “redirect:”前缀能够让重定向功能变得非常简单。Spring为重定向功能还提供了一些其他的辅助功能。 一般来讲，当一个处理器方法完成之后，该方法所指定的模型数据将会复制到请求中，并作为请求中的属性，请求会转发（forward）到视图上进行渲染。因为控制器方法和视图所处理的是同一个请求，所以在转发的过程中，请求属性能够得以保存。 但是，当控制器的结果是重定向的话，原始的请求就结束了，并且会发起一个新的GET请求。原始请求中所带有的模型数据也就随着请求一起消亡了。在新的请求属性中，没有任何的模型数据，这个请求必须要自己计算数据。 显然，对于重定向来说，模型并不能用来传递数据。但是我们也有一些其他的方案，能够从发起重定向的方法传递数据给处理重定向方法中：- 使用URL模板以路径变量和/或查询参数的形式传递数据；
- 通过flash属性发送数据。
通过URL模板进行重定向 通过路径变量和查询参数传递数据看起来非常简单。例如
return "redirect:/spitter/" + spitter.getUsername();@RequestMapping(value="/register", method=POST)public String processRegistration( Spitter spitter, Model model) { spitterRepository.save(spitter); model.addAttribute("username", spitter.getUsername()); return "redirect:/spitter/{username}";}@RequestMapping(value="/register", method=POST)public String processRegistration( Spitter spitter, Model model) { spitterRepository.save(spitter); model.addAttribute("username", spitter.getUsername()); model.addAttribute("spitterId", spitter.getId()); return "redirect:/spitter/{username}";}使用flash属性 如果在重定向的时候，需要实际发送对象。例如前面的例子中，我们需要重定向的时候传递Spitter对象。Spitter对象要比String和int更为复杂。因此，我们不能想路径变量或查询参数那么容易地发送Spitter对象。 正如我们前面讨论的那样，模型数据最终是以请求参数的形式复制到请求中的，当重定向发生的时候，这些数据就会丢失。因此，我们需要将Spitter对象放到一个位置，使其能够在重定向的过程中存活下来。 有个方案是将Spitter放到会话中，Spring也认为将跨重定向存活的数据放到会话中是一个很不错的方式。但是，Spring认为我们并不需要管理这些数据，相反，Spring提供了将数据发送为flash属性（flash attribute）的功能。 按照定义，flash属性会一直携带这些数据直到下一次请求，然后才会消失。 Spring提供了通过RedirectAttributes设置flash属性的方法，这是Spring 3.1引入的Model的一个子接口。RedirectAttributes提供了Model的所有功能，除此之外，还有几个方法是用来设置flash属性的。 具体来讲，RedirectAttributes提供了一组addFlashAttribute()方法来添加flash属性。重现看一下processRegistration()方法，我们可以使用addFlashAttribute()将Spitter对象添加到模型中：
@RequestMapping(value="/register", method=POST)public String processRegistration( Spitter spitter, RedirectAttributes model) { spitterRepository.save(spitter); model.addAttribute("username", spitter.getUsername()); model.addFlashAttribute("spitter",spitter); return "redirect:/spitter/{username}";}model.addFlashAttribute(spitter);
flash属性保存在会话中，然后再放到模型中，因此能够在重定向的过程中存活 为了完成flash属性的流程，如下展现了更新版本的showSpitterProfile()方法，在从数据库中查找之前，它会首先从模型中检查Spitter对象：
@RequestMapping(value="/{username}", method=GET)public String showSpitterProfile(@PathVariable String username, Model model) { if (!model.containsAttribute("spitter")){ Spitter spitter = spitterRepository.findByUsername(username); model.addAttribute(spitter); } return "profile";}