筆記來源：【尚矽谷】SpringMVC教程丨一套快速上手spring mvc

• 完全註解開發
  • 1、AbstractAnnotationConfigDispatcherServletlnitializer
  • 2、初始化類
  • 3、SpringMVC 配置類
  • 4、檢視解析器
  • 5、WebMvcConfigurer
  • 6、檔案上傳解析器
  • 測試
    • 訪問首頁
    • 測試異常
  • 附錄：SpringMVC 配置類總覽
  • 總結

完全註解開發

1、AbstractAnnotationConfigDispatcherServletlnitializer

在 Servlet3.0 環境中，容器會在類路徑中查詢實現javax.servlet.ServletContainerlnitializer

Spring 提供了這個介面的實現，名為SpringServletContainerlnitializer，這個類反過來又會查詢實現WebApplicationlnitializer的類並將配置的任務交給它們來完成

Spring3.2 引入了一個便利的 WebApplicationlnitializer基礎實現，名為AbstractAnnotationConfigDispatcherServletlnitializer

當類擴充套件了AbstractAnnotationConfigDispatcherServletlnitializer

2、初始化類

/**
 * web工程的初始化類，代替web.xml
 */
public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {
    /**
     * 指定Spring配置類
     *
     * @return
     */
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }

    /**
     * 指定SpringMVC配置類
     *
     * @return
     */
    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{WebConfig.class};
    }

    /**
     * 指定SpringMVC的對映規則，即url-pattern
     *
     * @return
     */
    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    /**
     * 註冊過濾器
     *
     * @return
     */
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
        characterEncodingFilter.setEncoding("UTF-8");
        characterEncodingFilter.setForceResponseEncoding(true);
        HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
        return new Filter[]{characterEncodingFilter, hiddenHttpMethodFilter};
    }
}
 

3、SpringMVC 配置類

SpringMVC 配置類清單

• 1、掃描元件
• 2、檢視解析器
• 3、view-controller
• 4、default-servlet-handler
• 5、MVC註解驅動
• 6、檔案上傳解析器
• 7、攔截器
• 8、異常處理解析器

// 標識為配置類
@Configuration
// ========== 1、掃描元件 ==========
@ComponentScan("com.vectorx.springmvc.controller")
// ========== 5、MVC註解驅動 ==========
@EnableWebMvc
public class WebConfig {}

4、檢視解析器

@Configuration
@ComponentScan("com.vectorx.springmvc.controller")
@EnableWebMvc
public class WebConfig {
    // ========== 2、檢視解析器 ==========

    /**
     * 生成模板解析器
     *
     * @return
     */
    @Bean
    public ITemplateResolver templateResolver() {
        SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver();
        templateResolver.setPrefix("/WEB-INF/templates/");
        templateResolver.setSuffix(".html");
        templateResolver.setTemplateMode(TemplateMode.HTML);
        templateResolver.setCharacterEncoding("UTF-8");
        return templateResolver;
    }

    /**
     * 生成模板引擎並注入模板解析器
     *
     * @param templateResolver
     * @return
     */
    @Bean
    public ISpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver);
        return templateEngine;
    }

    /**
     * 生成檢視解析器並注入模板引擎
     *
     * @param templateEngine
     * @return
     */
    @Bean
    public ViewResolver viewResolver(ISpringTemplateEngine templateEngine) {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setOrder(1);
        viewResolver.setCharacterEncoding("UTF-8");
        viewResolver.setTemplateEngine(templateEngine);
        return viewResolver;
    }
}

5、WebMvcConfigurer

@Configuration
@ComponentScan("com.vectorx.springmvc.controller")
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    // 略...

    // ========== 3、view-controller ==========
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("index");
    }
    // ========== 4、default-servlet-handler ==========
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    // ========== 7、攔截器 ==========
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new TestInterceptor()).addPathPatterns("/**");
    }

    // ========== 8、異常處理解析器 ==========
    @Override
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        SimpleMappingExceptionResolver exceptionResolver = new SimpleMappingExceptionResolver();
        Properties properties = new Properties();
        properties.setProperty("java.lang.ArithmeticException", "error");
        exceptionResolver.setExceptionMappings(properties);
        exceptionResolver.setExceptionAttribute("ex");
        resolvers.add(exceptionResolver);
    }
}

6、檔案上傳解析器

@Configuration
@ComponentScan("com.vectorx.springmvc.controller")
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    // 略...
    
    // ========== 6、檔案上傳解析器 ==========
    @Bean
    public MultipartResolver multipartResolver() {
        MultipartResolver multipartResolver = new CommonsMultipartResolver();
        return multipartResolver;
    }
}

測試

訪問首頁

測試異常

附錄：SpringMVC 配置類總覽

// 標識為配置類
@Configuration
// ========== 1、掃描元件 ==========
@ComponentScan("com.vectorx.springmvc.controller")
// ========== 5、MVC註解驅動 ==========
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    // ========== 2、檢視解析器 ==========

    /**
     * 生成模板解析器
     *
     * @return
     */
    @Bean
    public ITemplateResolver templateResolver() {
        SpringResourceTemplateResolver templateResolver = new SpringResourceTemplateResolver();
        templateResolver.setPrefix("/WEB-INF/templates/");
        templateResolver.setSuffix(".html");
        templateResolver.setTemplateMode(TemplateMode.HTML);
        templateResolver.setCharacterEncoding("UTF-8");
        return templateResolver;
    }

    /**
     * 生成模板引擎並注入模板解析器
     *
     * @param templateResolver
     * @return
     */
    @Bean
    public ISpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver);
        return templateEngine;
    }

    /**
     * 生成檢視解析器並注入模板引擎
     *
     * @param templateEngine
     * @return
     */
    @Bean
    public ViewResolver viewResolver(ISpringTemplateEngine templateEngine) {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setOrder(1);
        viewResolver.setCharacterEncoding("UTF-8");
        viewResolver.setTemplateEngine(templateEngine);
        return viewResolver;
    }

    // ========== 3、view-controller ==========
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("index");
    }

    // ========== 4、default-servlet-handler ==========
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    // ========== 6、檔案上傳解析器 ==========
    @Bean
    public MultipartResolver multipartResolver() {
        MultipartResolver multipartResolver = new CommonsMultipartResolver();
        return multipartResolver;
    }

    // ========== 7、攔截器 ==========
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new TestInterceptor()).addPathPatterns("/**");
    }

    // ========== 8、異常處理解析器 ==========
    @Override
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        SimpleMappingExceptionResolver exceptionResolver = new SimpleMappingExceptionResolver();
        Properties properties = new Properties();
        properties.setProperty(ArithmeticException.class.getCanonicalName(), "error");
        exceptionResolver.setExceptionMappings(properties);
        exceptionResolver.setExceptionAttribute("ex");
        resolvers.add(exceptionResolver);
    }
}

總結

本屆重點掌握

• web 工程初始化的配置方法
• SpringMVC 配置類的元件配置方法

附上導圖，僅供參考