《Spring實戰》筆記(四):Spring MVC

1 跟蹤請求

Spring MVC中請求經過的路徑如下:


Spring MVC請求的跟蹤.JPG

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(),在AbstractAnnotationConfigDispatcherServletInitializerDispatcherServlet注冊到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的定義,它會創建DispatcherServletContextLoaderListener。如果我們想往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形式的數據

  1. 配置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"));
    }
  1. 接收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,用來處理異常
  1. 在默認情況下,Spring會將自身的一些異常自動轉換為合適的狀態碼。


    一些Spring異常的默認映射.JPG
  2. 可以使用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返回。

  1. 標注在方法上,被標注的方法將會先于控制器方法執行:
    @ModelAttribute("key")
    public String initModel() {
        return "value";
    }

這樣子會在controller方法返回頁面的Model里面添加一個name為key而value為value的屬性。

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

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

  1. 標注在方法的參數:
    @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屬性會被取出,并轉移到模型之中。


flash屬性原理.JPG
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,412評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,514評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,373評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,975評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,743評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,199評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,262評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,414評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,951評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,780評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,527評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,218評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,649評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,889評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,673評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,967評論 2 374

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,782評論 18 139
  • Spring Boot 參考指南 介紹 轉載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,898評論 6 342
  • 本章主要內容: 備用的Spring MVC配置項 處理文件上傳 控制器中的異常處理 使用flash屬性 “等等,客...
    hoxis閱讀 3,533評論 1 26
  • 從三月份找實習到現在,面了一些公司,掛了不少,但最終還是拿到小米、百度、阿里、京東、新浪、CVTE、樂視家的研發崗...
    時芥藍閱讀 42,320評論 11 349
  • 分離總是傷感的話題,可我們的分離帶著彼此最美好的祝福。仿佛客不留人天留人,海鹽又下起了雨,雨確實不大,滴滴答...
    大眼靜閱讀 207評論 0 0