1 跟蹤請(qǐng)求

Spring MVC中請(qǐng)求經(jīng)過的路徑如下：

Spring MVC請(qǐng)求的跟蹤.JPG

2 搭建Spring MVC

2.1 配置Dispatcher

Dispatcher可以使用JavaConfig來配置戈锻，也可以使用web.xml配置晓殊，但前者要在支持Servlet 3.0以上的服務(wù)器中才能正常工作褒侧。

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環(huán)境中萎战，容器會(huì)在類路徑中查找實(shí)現(xiàn)javax.servlet.ServletContainerInitializer接口的類看锉，如果能發(fā)現(xiàn)的話浩销，就會(huì)用它來配置Servlet容器妈经。Spring提供了這個(gè)接口的實(shí)現(xiàn)临梗，名為SpringServletContainerInitializer胞得，這個(gè)類反過來又會(huì)查找實(shí)現(xiàn)WebApplicationInitializer的類并將配置的任務(wù)交給它們來完成荧止。Spring 3.2引入了一個(gè)WebApplicationInitializer的基礎(chǔ)實(shí)現(xiàn)，也就是AbstractAnnotationConfigDispatcherServletInitializer阶剑。所以在我們擴(kuò)展了AbstractAnnotationConfigDispatcherServletInitializer的時(shí)候跃巡，將項(xiàng)目部署到Servlet 3.0以上的容器時(shí)，容器就會(huì)自動(dòng)發(fā)現(xiàn)它并用它來配置上下文牧愁。我們也可以通過自己實(shí)現(xiàn)WebApplicationInitializer來進(jìn)行配置素邪。

2.2 自定義Dispatcher配置

上面的例子實(shí)現(xiàn)了AbstractAnnotationConfigDispatcherServletInitializer的三個(gè)抽象方法。如果要自定義更多的配置猪半，可以重寫其他方法兔朦。比如說customizeRegistration()，在AbstractAnnotationConfigDispatcherServletInitializer將DispatcherServlet注冊(cè)到Servlet容器中之后磨确，就會(huì)調(diào)用customizeRegistration()沽甥，并將Servlet注冊(cè)后得到的Registration.Dynamic傳遞進(jìn)來。

    @Override
    protected void customizeRegistration(ServletRegistration.Dynamic registration) {
        registration.setMultipartConfig(new MultipartConfigElement("/img"));
    }

借助customizeRegistration()方法中的ServletRegistration.Dynamic乏奥，我們能夠完成多項(xiàng)任務(wù)摆舟，包括通過調(diào)用setLoadOnStartup()設(shè)置load-on-startup優(yōu)先級(jí)，通過setInitParameter()設(shè)置初始化參數(shù)邓了，通過調(diào)用setMultipartConfig()配置Servlet 3.0對(duì)multipart的支持等等恨诱。

2.3 兩個(gè)應(yīng)用上下文

DispatcherServlet會(huì)創(chuàng)建一個(gè)應(yīng)用上下文，用來加載配置類或配置文件中的所聲明的bean骗炉。getServletConfigClasses()用來指定DispatcherServlet加載應(yīng)用上下文的時(shí)候所用的配置照宝。在Spring Web項(xiàng)目中，還有另一個(gè)上下文由ContextLoaderListener所創(chuàng)建痕鳍，getRootConfigClasses()用來指定由ContextLoaderListener創(chuàng)建上下文時(shí)要用到的配置硫豆。

@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;
    }


    /**
     * 配置靜態(tài)資源的處理
     *
     * @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";
    }
}

控制器的測(cè)試：

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")
        );
    }
}

如果要往視圖傳遞數(shù)據(jù)，可以使用Model作為控制器的參數(shù)笼呆，Model實(shí)際上就是一個(gè)Map（也就是key-value對(duì)的集合）熊响，它會(huì)傳遞給視圖，這樣數(shù)據(jù)就能渲染到客戶端了诗赌。當(dāng)調(diào)用addAttribute()方法并且不指定key的時(shí)候汗茄，那么key會(huì)根據(jù)值的對(duì)象類型推斷確定。如果你希望使用非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 接收請(qǐng)求

Spring MVC允許以多種方式將客戶端中的數(shù)據(jù)傳送到控制器的處理器方法中递览，包括：

• 查詢參數(shù)（Query Parameter）
• 表單參數(shù)（Form Parameter）
• 路徑變量（Path Variable）
  1.查詢參數(shù)，使用@RequestParam聲明參數(shù)瞳腌，如下面的控制器將會(huì)接收來自/userInfo?id=xxx的請(qǐng)求

    @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.路徑變量绞铃，和查詢參數(shù)有點(diǎn)類似，但是參數(shù)是直接作為uri的嫂侍，如下的控制器將會(huì)接收來自/userInfo/xxx的請(qǐng)求

    @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.表單參數(shù)（或者是其他實(shí)體）儿捧，這一類請(qǐng)求需要用post

    @RequestMapping(value = "/register", method=RequestMethod.POST)
    public String register(User user) {
        User savedUser = userService.save(user);
        return "redirect: /userInfo/" + savedUser.getId();
    }

如上面例子，當(dāng)InternalResourceViewResolver看到視圖格式中的“redirect:”前綴時(shí)挑宠，它就知道要將其解析為重定向的規(guī)則菲盾，而不是視圖的名稱。需要注意的是各淀，除了“redirect:”懒鉴，InternalResourceViewResolver還能識(shí)別“forward:”前綴。當(dāng)它發(fā)現(xiàn)視圖格式中以“forward:”作為前綴時(shí)碎浇，請(qǐng)求將會(huì)前往（forward）指定的URL路徑临谱，而不再是重定向。

3 視圖解析原理

在Spring MVC中南捂，定義了一個(gè)叫ViewResolver的接口

public interface ViewResolver {
    View resolveViewName(String viewName, Locale locale) throws Exception;
}

當(dāng)給resolveViewName()方法傳入一個(gè)視圖名和Locale對(duì)象時(shí)吴裤，它會(huì)返回一個(gè)View實(shí)例，View也是一個(gè)接口

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的任務(wù)就是接受模型以及Servlet的request和response對(duì)象溺健，并將輸出結(jié)果渲染到response中麦牺。
對(duì)于ViewResolver，Spring提供了多個(gè)實(shí)現(xiàn)鞭缭。其中剖膳，InternalResourceViewResolver將視圖解析為Web應(yīng)用的內(nèi)部資源，一般為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 高級(jí)技術(shù)

4.1 添加其他的Servlet和Filter

按照AbstractAnnotationConfigDispatcherServletInitializer的定義吱晒，它會(huì)創(chuàng)建DispatcherServlet和ContextLoaderListener。如果我們想往Web容器中注冊(cè)其他組件的話沦童，只需創(chuàng)建一個(gè)新的初始化器就可以了仑濒。最簡(jiǎn)單的方式就是實(shí)現(xiàn)Spring的WebApplicationInitializer接口。

public class MyServletInitializer implements WebApplicationInitializer {

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        
        //注冊(cè)Servlet
        ServletRegistration.Dynamic myServlet =
                servletContext.addServlet("myServlet", MyServlet.class);
        
        //映射Servlet
        myServlet.addMapping("/custom/**");
    }
}

同理偷遗，我們也可以創(chuàng)建新的WebApplicationInitializer實(shí)現(xiàn)注冊(cè)Listener和Filter墩瞳。

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        
        //注冊(cè)Filter
        ServletRegistration.Dynamic myServlet =
                servletContext.addFilter("myFilter", MyFilter.class);
        
        //映射Filter
        myServlet.addMappingForUrlPatterns(null, false, "/custom/*");
    }

4.2 處理Multipart形式的數(shù)據(jù)

1. 配置multipart解析器
   解析器有兩個(gè)選擇：

• CommonsMultipartResolver：使用Jakarta Commons FileUpload解析multipart請(qǐng)求；
• StandardServletMultipartResolver：依賴于Servlet 3.0對(duì)multipart請(qǐng)求的支持（始于Spring 3.1）氏豌。
  后者使用Servlet所提供的功能支持喉酌，并不需要依賴任何其他的項(xiàng)目，所以優(yōu)先選用后者。

    @Bean
    public MultipartResolver multipartResolver() {

        return new StandardServletMultipartResolver();
    }

解析器的限制條件需要在servlet中配置泪电，有兩種方法：
（1） 如果我們采用Servlet初始化類的方式來配置DispatcherServlet的話般妙，這個(gè)初始化類應(yīng)該已經(jīng)實(shí)現(xiàn)了WebApplicationInitializer，那我們可以在Servlet registration上調(diào)用setMultipartConfig()方法相速，傳入一個(gè)MultipartConfigElement實(shí)例碟渺。

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"));
    }

2. 接收MultipartFile
   頁(yè)面表單要將<form>標(biāo)簽的enctype屬性設(shè)置為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>

后臺(tái)接收的時(shí)候突诬，使用注解@RequestPart來指定對(duì)應(yīng)part的數(shù)據(jù)止状，對(duì)于上傳的文件，可以使用byte[]進(jìn)行接收攒霹，但是使用byte[]操作起來比較麻煩。Spring提供了MultiPartFile接口用以接收上傳的文件浆洗，該接口提供了處理上傳文件的相關(guān)功能催束。比如說，transferTo()方法可以很方便地將上傳的文件寫入到文件系統(tǒng)中伏社。

    @PostMapping("/signUp")
    public String signUp(@RequestPart("image") MultipartFile image, User user)
            throws Exception{
        ...
        image.transferTo(new File("/image/" + image.getOriginalFilename()));
        ...
    }

Servlet3.0還提供了一個(gè)Part接口用來接收上傳的文件抠刺，使用方法與MultiPartFile差別不大。

4.3 異常處理

Spring有如下方式可以將異常轉(zhuǎn)換為相應(yīng):

• Spring自身特定的異常會(huì)自定轉(zhuǎn)換為指定的HTTP狀態(tài)碼
• 使用@ResponseStatus摘昌，將某一個(gè)異常映射為特定的HTTP狀態(tài)碼
• 在方法上可以添加@ExceptionHandler速妖，用來處理異常

1. 在默認(rèn)情況下，Spring會(huì)將自身的一些異常自動(dòng)轉(zhuǎn)換為合適的狀態(tài)碼聪黎。

   
   
   一些Spring異常的默認(rèn)映射.JPG

2. 可以使用ResponseStatus將異常映射為特定的狀態(tài)碼罕容。對(duì)于沒有映射的的異常，默認(rèn)為500的狀態(tài)碼稿饰。

@ResponseStatus(value = HttpStatus.BAD_REQUEST)
public class DemoException extends RuntimeException {
}

3.可以用一個(gè)獨(dú)立的方法用來處理特定的異常锦秒，該方法要用@ExceptionHandler標(biāo)注。這樣可以免去在每個(gè)處理器方法中的重復(fù)編寫異常捕捉代碼喉镰。但是該方法只能適用于當(dāng)前的Controller旅择。如果要使用所有的控制器，要將方法定義到控制器通知類侣姆。

    @ExceptionHandler(NullPointerException.class)
    public String handException() {
        return "error";
    }
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String home() {
       ...
    }

4.4 為控制器添加通知

為類加上@ControllerAdvice注解生真，即為控制器通知類∞嘧冢控制器通知類的方法可以應(yīng)用到整個(gè)應(yīng)用程序中所有的Controller柱蟀。在控制器通知類可以定義一個(gè)或多個(gè)以下的方法：

• @ExceptionHandler注解標(biāo)注的方法；
• @InitBinder注解標(biāo)注的方法偿凭；
• @ModelAttribute注解標(biāo)注的方法产弹。

@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用于數(shù)據(jù)綁定，對(duì)于接收的參數(shù)，有時(shí)候需要進(jìn)行轉(zhuǎn)換痰哨，比如說將字符串類的日期轉(zhuǎn)換為Date類型胶果，這個(gè)時(shí)候就可以使用@InitBinder，請(qǐng)求到后臺(tái)的時(shí)候會(huì)先進(jìn)入@InitBinder標(biāo)注的方法注冊(cè)相關(guān)的編輯器斤斧。

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.addCustomFormatter(new DateFormatter("yyyyMMdd"));
    }

@ModelAttribute有兩種用法早抠，一種是標(biāo)注在方法，為處理器方法設(shè)置Model的屬性撬讽，另一種是標(biāo)注在處理器方法的參數(shù)蕊连，用以接收參數(shù)并作為Model返回。

1. 標(biāo)注在方法上游昼，被標(biāo)注的方法將會(huì)先于控制器方法執(zhí)行：

    @ModelAttribute("key")
    public String initModel() {
        return "value";
    }

這樣子會(huì)在controller方法返回頁(yè)面的Model里面添加一個(gè)name為key而value為value的屬性甘苍。

    @ModelAttribute()
    public voidinitModel(Model model) {
        model.addAttibute("key", "value");
    }

無返回值的的方法可以直接用model來設(shè)置屬性。

2. 標(biāo)注在方法的參數(shù)：

    @GetMapping(value = "/")
    public String home(@ModelAttribute("key")String key) {
        return "home";
    }

從客戶端接收的request param可以做為Model再次返回給頁(yè)面烘豌。也可以接收form-data载庭，如下：

    @PostMapping("/user")
    public String user(@ModelAttribute("user") User user) {

        return "user";
    }

4.5 跨重定向請(qǐng)求傳遞數(shù)據(jù)

重定向使用return "redirect:/anotherPagePath"的格式進(jìn)行。進(jìn)行重定向的時(shí)候廊佩，上次請(qǐng)求的參數(shù)將不能繼續(xù)傳遞下去囚聚。要實(shí)現(xiàn)跨重定向傳遞數(shù)據(jù)，主要有兩種方法：

• 使用URL模板以路徑變量或查詢參數(shù)的形式傳遞數(shù)據(jù)标锄；
• 通過flash屬性發(fā)送數(shù)據(jù)顽铸。

    @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";
    }

對(duì)于一些簡(jiǎn)單的數(shù)據(jù)，可以通過路徑變量和查詢參數(shù)進(jìn)行傳遞料皇，如果傳遞對(duì)象谓松，可以使用RedirectAttributes，它繼承了Model類并且新增了提供設(shè)置flash屬性的方法瓶蝴。flash屬性是通過會(huì)話實(shí)現(xiàn)的毒返，在重定向執(zhí)行前，所有的flash屬性會(huì)復(fù)制到會(huì)話中舷手，在重定向之后拧簸，存在會(huì)話中的flash屬性會(huì)被取出，并轉(zhuǎn)移到模型之中男窟。

flash屬性原理.JPG