1 跟蹤請求
Spring MVC中請求經過的路徑如下:
2 搭建Spring MVC
2.1 配置Dispatcher
Dispatcher可以使用JavaConfig來配置,也可以使用web.xml配置,但前者要在支持Servlet 3.0以上的服務器中才能正常工作。
public class MyWebAppInitializer
extends AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class<?>[] getRootConfigClasses() {
return new Class<?>[] { WebConfig.class };
}
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class<?>[] { RootConfig.class };
}
@Override
protected String[] getServletMappings() {
return new String[] { "/" };
}
}
原理:在Servlet 3.0環境中,容器會在類路徑中查找實現javax.servlet.ServletContainerInitializer
接口的類,如果能發現的話,就會用它來配置Servlet容器。Spring提供了這個接口的實現,名為SpringServletContainerInitializer
,這個類反過來又會查找實現WebApplicationInitializer
的類并將配置的任務交給它們來完成。Spring 3.2引入了一個WebApplicationInitializer
的基礎實現,也就是AbstractAnnotationConfigDispatcherServletInitializer
。所以在我們擴展了AbstractAnnotationConfigDispatcherServletInitializer
的時候,將項目部署到Servlet 3.0以上的容器時,容器就會自動發現它并用它來配置上下文。我們也可以通過自己實現WebApplicationInitializer
來進行配置。
2.2 自定義Dispatcher配置
上面的例子實現了AbstractAnnotationConfigDispatcherServletInitializer
的三個抽象方法。如果要自定義更多的配置,可以重寫其他方法。比如說customizeRegistration()
,在AbstractAnnotationConfigDispatcherServletInitializer
將DispatcherServlet
注冊到Servlet容器中之后,就會調用customizeRegistration()
,并將Servlet注冊后得到的Registration.Dynamic
傳遞進來。
@Override
protected void customizeRegistration(ServletRegistration.Dynamic registration) {
registration.setMultipartConfig(new MultipartConfigElement("/img"));
}
借助customizeRegistration()
方法中的ServletRegistration.Dynamic
,我們能夠完成多項任務,包括通過調用setLoadOnStartup()
設置load-on-startup優先級,通過setInitParameter()
設置初始化參數,通過調用setMultipartConfig()
配置Servlet 3.0對multipart的支持等等。
2.3 兩個應用上下文
DispatcherServlet
會創建一個應用上下文,用來加載配置類或配置文件中的所聲明的bean。getServletConfigClasses()
用來指定DispatcherServlet
加載應用上下文的時候所用的配置。在Spring Web項目中,還有另一個上下文由ContextLoaderListener
所創建,getRootConfigClasses()
用來指定由ContextLoaderListener
創建上下文時要用到的配置。
@Configuration
@ComponentScan("me.ye.springinaction.controller")
@EnableWebMvc
public class WebConfig extends WebMvcConfigurerAdapter {
/**
* 配置JSP視圖解析器
*
* @return
*/
@Bean
public ViewResolver viewResolver() {
InternalResourceViewResolver resolver =
new InternalResourceViewResolver();
resolver.setSuffix(".jsp");
resolver.setExposeContextBeansAsAttributes(true);
return resolver;
}
/**
* 配置靜態資源的處理
*
* @param configurer
*/
@Override
public void configureDefaultServletHandling(
DefaultServletHandlerConfigurer configurer) {
configurer.enable();
}
}
@Configuration
@ComponentScan(basePackages = {"me.ye.springinaction"},
excludeFilters = {
@Filter(type = FilterType.ANNOTATION, value = EnableWebMvc.class)
})
public class RootConfig {
}
2.4 編寫控制器
@Controller
public class HomeController {
@RequestMapping(value = "/", method = RequestMethod.GET)
public String home() {
return "home";
}
}
控制器的測試:
public class HomeControllerTest {
@Test
public void testHome() throws Exception {
HomeController controller = new HomeController();
MockMvc mockMvc = MockMvcBuilders.standaloneSetup(controller).build();
mockMvc.perform(MockMvcRequestBuilders.get("/")).andExpect(
MockMvcResultMatchers.view().name("home")
);
}
}
如果要往視圖傳遞數據,可以使用Model作為控制器的參數,Model實際上就是一個Map(也就是key-value對的集合),它會傳遞給視圖,這樣數據就能渲染到客戶端了。當調用addAttribute()方法并且不指定key的時候,那么key會根據值的對象類型推斷確定。如果你希望使用非Spring類型的話,那么可以用java.util.Map來代替Model。
@Controller
public class HomeController {
@RequestMapping(value = "/", method = RequestMethod.GET)
public String home(Model model) {
model.addAttribute("key", "value");
return "home";
}
}
2.5 接收請求
Spring MVC允許以多種方式將客戶端中的數據傳送到控制器的處理器方法中,包括:
- 查詢參數(Query Parameter)
- 表單參數(Form Parameter)
- 路徑變量(Path Variable)
1.查詢參數,使用@RequestParam
聲明參數,如下面的控制器將會接收來自/userInfo?id=xxx
的請求
@RequestMapping(value="/userInfo", method = RequestMethod.GET)
public String userInfo(Model model, @RequestParam("id") String id) {
User user = userService.getUserById(id);
model.addAttribute("user", user);
return "userInfo";
}
2.路徑變量,和查詢參數有點類似,但是參數是直接作為uri的,如下的控制器將會接收來自/userInfo/xxx
的請求
@RequestMapping(value="/userInfo/{id}", method = RequestMethod.GET)
public String userInfo(Model model, @PathVariable("id") String id) {
User user = userService.getUserById(id);
model.addAttribute("user", user);
return "userInfo";
}
3.表單參數(或者是其他實體),這一類請求需要用post
@RequestMapping(value = "/register", method=RequestMethod.POST)
public String register(User user) {
User savedUser = userService.save(user);
return "redirect: /userInfo/" + savedUser.getId();
}
如上面例子,當InternalResourceViewResolver看到視圖格式中的“redirect:”前綴時,它就知道要將其解析為重定向的規則,而不是視圖的名稱。需要注意的是,除了“redirect:”,InternalResourceViewResolver還能識別“forward:”前綴。當它發現視圖格式中以“forward:”作為前綴時,請求將會前往(forward)指定的URL路徑,而不再是重定向。
3 視圖解析原理
在Spring MVC中,定義了一個叫ViewResolver
的接口
public interface ViewResolver {
View resolveViewName(String viewName, Locale locale) throws Exception;
}
當給resolveViewName()方法傳入一個視圖名和Locale對象時,它會返回一個View實例,View也是一個接口
public interface View {
String RESPONSE_STATUS_ATTRIBUTE = View.class.getName() + ".responseStatus";
String PATH_VARIABLES = View.class.getName() + ".pathVariables";
String SELECTED_CONTENT_TYPE = View.class.getName() + ".selectedContentType";
String getContentType();
void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) throws Exception;
}
View的任務就是接受模型以及Servlet的request和response對象,并將輸出結果渲染到response中。
對于ViewResolver,Spring提供了多個實現。其中,InternalResourceViewResolver
將視圖解析為Web應用的內部資源,一般為JSP。
Spring使用Thymeleaf3:
@Configuration
@ComponentScan("me.ye.springinaction.controller")
@EnableWebMvc
public class WebConfig extends WebMvcConfigurerAdapter implements ApplicationContextAware {
private ApplicationContext applicationContext;
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
@Bean
public ViewResolver viewResolver(SpringTemplateEngine springTemplateEngine) {
ThymeleafViewResolver resolver = new ThymeleafViewResolver();
resolver.setTemplateEngine(springTemplateEngine);
resolver.setCharacterEncoding("UTF-8");
return resolver;
}
@Bean
public SpringTemplateEngine springTemplateEngine(
ITemplateResolver templateResolver) {
SpringTemplateEngine engine = new SpringTemplateEngine();
engine.setEnableSpringELCompiler(true);
engine.setTemplateResolver(templateResolver);
return engine;
}
@Bean
public ITemplateResolver templateResolver() {
SpringResourceTemplateResolver resolver =
new SpringResourceTemplateResolver();
resolver.setApplicationContext(applicationContext);
resolver.setPrefix("/WEB-INF/templates/");
resolver.setTemplateMode(TemplateMode.HTML);
resolver.setSuffix(".html");
return resolver;
}
}
4 Spring MVC 高級技術
4.1 添加其他的Servlet和Filter
按照AbstractAnnotationConfigDispatcherServletInitializer
的定義,它會創建DispatcherServlet
和ContextLoaderListener
。如果我們想往Web容器中注冊其他組件的話,只需創建一個新的初始化器就可以了。最簡單的方式就是實現Spring的WebApplicationInitializer
接口。
public class MyServletInitializer implements WebApplicationInitializer {
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
//注冊Servlet
ServletRegistration.Dynamic myServlet =
servletContext.addServlet("myServlet", MyServlet.class);
//映射Servlet
myServlet.addMapping("/custom/**");
}
}
同理,我們也可以創建新的WebApplicationInitializer
實現注冊Listener和Filter。
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
//注冊Filter
ServletRegistration.Dynamic myServlet =
servletContext.addFilter("myFilter", MyFilter.class);
//映射Filter
myServlet.addMappingForUrlPatterns(null, false, "/custom/*");
}
4.2 處理Multipart形式的數據
- 配置multipart解析器
解析器有兩個選擇:
- CommonsMultipartResolver:使用Jakarta Commons FileUpload解析multipart請求;
- StandardServletMultipartResolver:依賴于Servlet 3.0對multipart請求的支持(始于Spring 3.1)。
后者使用Servlet所提供的功能支持,并不需要依賴任何其他的項目,所以優先選用后者。
@Bean
public MultipartResolver multipartResolver() {
return new StandardServletMultipartResolver();
}
解析器的限制條件需要在servlet中配置,有兩種方法:
(1) 如果我們采用Servlet初始化類的方式來配置DispatcherServlet的話,這個初始化類應該已經實現了WebApplicationInitializer,那我們可以在Servlet registration上調用setMultipartConfig()方法,傳入一個MultipartConfigElement實例。
DispatcherServlet ds = new DispatcherServlet();
Dynamic registration = context.addServlet("appServlet", ds)'
registration.addMapping("/");
registration.setMultipartConfig(new MultipartConfigElement("/tmp"))
(2) 如果Servlet初始化類繼承了AbstractAnnotationConfigDispatcherServletInitializer
,可以重寫customizeRegistration()
@Override
protected void customizeRegistration(ServletRegistration.Dynamic registration) {
registration.setMultipartConfig(new MultipartConfigElement("/temp"));
}
- 接收MultipartFile
頁面表單要將<form>
標簽的enctype屬性設置為multipart/form-data
<form method="post" enctype="multipart/form-data" action="/signUp">
...
<lable>Image</lable>
<input type="file" name="image" accept="image/jpeg, image/png, image/gif">
...
</form>
后臺接收的時候,使用注解@RequestPart
來指定對應part的數據,對于上傳的文件,可以使用byte[]
進行接收,但是使用byte[]
操作起來比較麻煩。Spring提供了MultiPartFile
接口用以接收上傳的文件,該接口提供了處理上傳文件的相關功能。比如說,transferTo()
方法可以很方便地將上傳的文件寫入到文件系統中。
@PostMapping("/signUp")
public String signUp(@RequestPart("image") MultipartFile image, User user)
throws Exception{
...
image.transferTo(new File("/image/" + image.getOriginalFilename()));
...
}
Servlet3.0還提供了一個Part
接口用來接收上傳的文件,使用方法與MultiPartFile
差別不大。
4.3 異常處理
Spring有如下方式可以將異常轉換為相應:
- Spring自身特定的異常會自定轉換為指定的HTTP狀態碼
- 使用
@ResponseStatus
,將某一個異常映射為特定的HTTP狀態碼 - 在方法上可以添加
@ExceptionHandler
,用來處理異常
-
在默認情況下,Spring會將自身的一些異常自動轉換為合適的狀態碼。
一些Spring異常的默認映射.JPG 可以使用
ResponseStatus
將異常映射為特定的狀態碼。對于沒有映射的的異常,默認為500的狀態碼。
@ResponseStatus(value = HttpStatus.BAD_REQUEST)
public class DemoException extends RuntimeException {
}
3.可以用一個獨立的方法用來處理特定的異常,該方法要用@ExceptionHandler
標注。這樣可以免去在每個處理器方法中的重復編寫異常捕捉代碼。但是該方法只能適用于當前的Controller。如果要使用所有的控制器,要將方法定義到控制器通知類。
@ExceptionHandler(NullPointerException.class)
public String handException() {
return "error";
}
@RequestMapping(value = "/", method = RequestMethod.GET)
public String home() {
...
}
4.4 為控制器添加通知
為類加上@ControllerAdvice
注解,即為控制器通知類。控制器通知類的方法可以應用到整個應用程序中所有的Controller。在控制器通知類可以定義一個或多個以下的方法:
- @ExceptionHandler注解標注的方法;
- @InitBinder注解標注的方法;
- @ModelAttribute注解標注的方法。
@ControllerAdvice
public class CommonControllerHandler {
@ExceptionHandler(NullPointerException.class)
public String handException() {
return "error";
}
@InitBinder
public void initBinder(WebDataBinder binder) {
binder.addCustomFormatter(new DateFormatter("yyyyMMdd"));
}
@ModelAttribute("key")
public String initModel() {
return "value";
}
}
@InitBinder
用于數據綁定,對于接收的參數,有時候需要進行轉換,比如說將字符串類的日期轉換為Date類型,這個時候就可以使用@InitBinder
,請求到后臺的時候會先進入@InitBinder
標注的方法注冊相關的編輯器。
@InitBinder
public void initBinder(WebDataBinder binder) {
binder.addCustomFormatter(new DateFormatter("yyyyMMdd"));
}
@ModelAttribute
有兩種用法,一種是標注在方法,為處理器方法設置Model的屬性,另一種是標注在處理器方法的參數,用以接收參數并作為Model返回。
- 標注在方法上,被標注的方法將會先于控制器方法執行:
@ModelAttribute("key")
public String initModel() {
return "value";
}
這樣子會在controller方法返回頁面的Model里面添加一個name為key而value為value的屬性。
@ModelAttribute()
public voidinitModel(Model model) {
model.addAttibute("key", "value");
}
無返回值的的方法可以直接用model來設置屬性。
- 標注在方法的參數:
@GetMapping(value = "/")
public String home(@ModelAttribute("key")String key) {
return "home";
}
從客戶端接收的request param可以做為Model再次返回給頁面。也可以接收form-data,如下:
@PostMapping("/user")
public String user(@ModelAttribute("user") User user) {
return "user";
}
4.5 跨重定向請求傳遞數據
重定向使用return "redirect:/anotherPagePath"
的格式進行。進行重定向的時候,上次請求的參數將不能繼續傳遞下去。要實現跨重定向傳遞數據,主要有兩種方法:
- 使用URL模板以路徑變量或查詢參數的形式傳遞數據;
- 通過flash屬性發送數據。
@PostMapping("/user")
public String user(User user, RedirectAttributes model) {
model.addAttribute("id", 100);
model.addAttribute("name", "Jacob");
model.addFlashAttribute("user", user);
return "redirect:/userInfo/{name}";
}
@GetMapping("/userInfo/{name}")
public String userInfo(@RequestParam("id") String id,
@PathVariable("name") String name,
Model model) {
model.addAttribute("id", id);
model.addAttribute("name", name);
return "user";
}
對于一些簡單的數據,可以通過路徑變量和查詢參數進行傳遞,如果傳遞對象,可以使用RedirectAttributes,它繼承了Model類并且新增了提供設置flash屬性的方法。flash屬性是通過會話實現的,在重定向執行前,所有的flash屬性會復制到會話中,在重定向之后,存在會話中的flash屬性會被取出,并轉移到模型之中。