Spring Boot 2.X(四)：Spring Boot 自定義 Web MVC 配置

時間 2020-01-04

標籤 spring boot 2.x 自定義 web mvc 配置欄目 Spring 简体版

原文原文鏈接

0.準備

Spring Boot 不只提供了至關簡單使用的自動配置功能，並且開放了很是自由靈活的配置類。Spring MVC 爲咱們提供了 WebMvcConfigurationSupport 類和一個註解 @EnableWebMvc 以幫助咱們減小配置 Bean 的聲明。本文簡單說明如何自定義 Web MVC 配置。
首先須要使用 @Configuration 將 WebMvcConfig 類標註爲 Spring 配置類，示例代碼以下:css

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
    //經過重寫配置方法覆蓋
}

並在啓動類上添加 @EnableWebMvc，代碼以下：html

@SpringBootApplication
@MapperScan("cn.zwqh.springboot.dao")
@EnableWebMvc //啓用 Spring MVC 配置
public class SpringBootSsmThymeleafApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootSsmThymeleafApplication.class, args);
    }
}

1.靜態資源配置

Spring Boot 中默認的靜態資源配置，是把類路徑下的/static、/public、/resources 和 /METAINF/resources 目錄或者 ServletContext 的根目錄中的靜態文件直接映射爲 /**。它使用來自 Spring MVC 的ResourceHttpRequestHandler，以便您能夠經過添加本身的WebMvcConfigurer並覆蓋addResourceHandlers方法來修改該行爲。示例代碼以下：java

@Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {    
        registry.addResourceHandler("/statics/**").addResourceLocations("classpath:/statics/");//靜態資源路徑 css,js,img等
        registry.addResourceHandler("/templates/**").addResourceLocations("classpath:/templates/");//視圖
        registry.addResourceHandler("/mapper/**").addResourceLocations("classpath:/mapper/");//mapper.xml
        super.addResourceHandlers(registry);        
    }

2.攔截器配置

經過重寫 addInterceptors() 方法，使用 InterceptorRegistry 註冊類來添加攔截器 HandlerInterceptor。示例代碼以下：git

@Autowired
    private BeforMethodInteceptor beforMethodInteceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {    
        //註冊自定義攔截器，添加攔截路徑和排除攔截路徑
        registry.addInterceptor(beforMethodInteceptor) //添加攔截器
                   .addPathPatterns("/**") //添加攔截路徑
                   .excludePathPatterns(//添加排除攔截路徑
                           "/index",
                           "/login",
                           "/doLogin",
                           "/logout",
                           "/register",
                           "/doRegister",
                           "/**/*.css",
                "/**/*.png", 
                           "/**/*.jpeg",
                           "/**/*.jpg",
                           "/**/*.ico",
                           "/**/*.js",
                           "/swagger-resources/**"
                           );
        super.addInterceptors(registry);        
    }

3.跨域配置

經過重寫 addCorsMappings 方法實現跨域配置的支持，使用 CorsRegistry 註冊類添加路徑映射。示例代碼以下：github

@Override
    public void addCorsMappings(CorsRegistry registry) {        
        registry.addMapping("/**")//配置容許跨域的路徑
                .allowedOrigins("*")//配置容許訪問的跨域資源的請求域名
                .allowedMethods("PUT,POST,GET,DELETE,OPTIONS")//配置容許訪問該跨域資源服務器的請求方法，如：POST、GET、PUT、DELETE等
                .allowedHeaders("*"); //配置容許請求header的訪問，如 ：X-TOKEN
        super.addCorsMappings(registry);
    }

4.視圖控制器配置

經過重寫 addViewControllers 方法，使用 ViewControllerRegistry 註冊類來實現視圖控制器配置。示例代碼以下：spring

@Override
    public void addViewControllers(ViewControllerRegistry registry) {    
        registry.addViewController("/").setViewName("/index");//默認視圖跳轉
        registry.addViewController("/index").setViewName("/index");
        registry.addViewController("/article").setViewName("/article");
        registry.addViewController("/error/404").setViewName("/error/404"); 
       registry.addViewController("/error/500").setViewName("/error/500");         
       registry.setOrder(Ordered.HIGHEST_PRECEDENCE);
       super.addViewControllers(registry);        
    }

上面的代碼等同於以下代碼：json

@RequestMapping(value = { "/", "/index" })
    public String index() { 
         return "index";
    }  
    @RequestMapping(value = "article")
    public String article() { 
         return "article";
    } 
    @RequestMapping(value = "/error/404")
    public String error_404() { 
         return "/error/404";
    }
   @RequestMapping(value = "/error/500")
    public String error_500() { 
         return "/error/500";
    }

5.消息轉換器配置

經過覆蓋重寫 configureMessageConverters 方法來配置消息轉換器。示例代碼以下：
自定義字符串轉換器：跨域

@Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        StringHttpMessageConverter converter  = new StringHttpMessageConverter(Charset.forName("UTF-8"));
        converters.add(converter);  
    }

自定義fastjson轉換器：springboot

@Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
        //1.須要定義一個convert轉換消息的對象;
        FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
        //2.添加fastJson的配置信息，好比：是否要格式化返回的json數據;
        FastJsonConfig fastJsonConfig = new FastJsonConfig();
        fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat);
        //3處理中文亂碼問題
        List<MediaType> fastMediaTypes = new ArrayList<>();
        fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
        //4.在convert中添加配置信息.
        fastJsonHttpMessageConverter.setSupportedMediaTypes(fastMediaTypes);
        fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
        //5.將convert添加到converters當中.
        converters.add(fastJsonHttpMessageConverter);
    }

6.數據格式化器配置

經過重寫 addFormatters 方法來添加數據格式化器。Spring MVC 接受 HTTP 請求會把參數自動綁定映射到 Controller 請求參數上。Spring 中沒有默認配置將字符串轉換爲日期類型。這時能夠經過添加一個 DateFormatter 類來實現自動轉換。示例代碼以下：服務器

@Override
    public void addFormatters(FormatterRegistry registry) {
        super.addFormatters(registry);
        registry.addFormatter(new DateFormatter("yyyy-MM-dd"));
    }

7.視圖解析器配置

經過覆蓋重寫 configureViewResolvers() 方法來配置視圖解析器。代碼示例以下：

@Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("");
        viewResolver.setSuffix(".html");
        viewResolver.setCache(false);
        viewResolver.setContentType("text/html;charset=UTF-8");
        viewResolver.setOrder(0);        
        registry.viewResolver(viewResolver);
        super.configureViewResolvers(registry);
    }