Spring MVC 配置類 WebMvcConfigurerAdapter

  WebMvcConfigurerAdapter配置類是spring提供的一種配置方式，采用JavaBean的方式替代傳統的基於xml的配置來對spring框架進行自定義的配置。因此，在spring boot提倡的基於注解的配置，采用“約定大於配置”的風格下，當需要進行自定義的配置時，便可以繼承WebMvcConfigurerAdapter這個抽象類，通過JavaBean來實現需要的配置。

  WebMvcConfigurerAdapter是一個抽象類，它只提供了一些空的接口讓用戶去重寫，比如如果想添加攔截器的時候，需要去重寫一下addInterceptors()這個方法，去配置自定義的攔截器。我們可以看一下WebMvcConfigurerAdapter提供了哪些接口來供我們使用。

public abstract class WebMvcConfigurerAdapter implements WebMvcConfigurer {
    /*配置路徑匹配參數*/
    public void configurePathMatch(PathMatchConfigurer configurer) {}
    /*配置Web Service或REST API設計中內容協商,即根據客戶端的支持內容格式情況來封裝響應消息體，如xml,json*/
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {}
    /*配置路徑匹配參數*/
    public void configureAsyncSupport(AsyncSupportConfigurer configurer) {}
    /* 使得springmvc在接口層支持異步*/
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {}
    /* 注冊參數轉換和格式化器*/
    public void addFormatters(FormatterRegistry registry) {}
    /* 注冊配置的攔截器*/
    public void addInterceptors(InterceptorRegistry registry) {}
    /* 自定義靜態資源映射*/
    public void addResourceHandlers(ResourceHandlerRegistry registry) {}
    /* cors跨域訪問*/
    public void addCorsMappings(CorsRegistry registry) {}
    /* 配置頁面直接訪問，不走接口*/
    public void addViewControllers(ViewControllerRegistry registry) {}
    /* 注冊自定義的視圖解析器*/
    public void configureViewResolvers(ViewResolverRegistry registry) {}
    /* 注冊自定義控制器(controller)方法參數類型*/
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {}
    /* 注冊自定義控制器(controller)方法返回類型*/
    public void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers) {}
    /* 重載會覆蓋掉spring mvc默認注冊的多個HttpMessageConverter*/
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {}
    /* 僅添加一個自定義的HttpMessageConverter,不覆蓋默認注冊的HttpMessageConverter*/
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {}
    /* 注冊異常處理*/
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers) {}
    /* 多個異常處理，可以重寫次方法指定處理順序等*/
    public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers) {}
}

  WebMvcConfigurerAdapter提供了很多的接口供用戶去實現自定義的配置項。下面挑幾個比較重要的介紹一下如何使用這些接口來自定義配置。

  1.注冊攔截器

  首先，編寫攔截器的代碼：

public class LoginInterceptor extends HandlerInterceptorAdapter {

    private static final Logger logger = LoggerFactory.getLogger(LoginInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        logger.info("-----------------------------");
        logger.info(request.getRequestedSessionId());
        logger.info("-----------------------------");
        return true;
    }
}

  這里只打印相關信息，然后，需要寫一個config類去配置這個攔截器：

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
    /*
    * 攔截器配置*/
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**");
}

  配置類繼承了WebMvcConfigurerAdapter這個類，並且重寫了addInterceptors這個方法，在方法中，注冊了上面編寫的攔截器，並且為此攔截器配置了攔截路徑，這樣一來就算是配置好了這個攔截器。

  2.配置CORS跨域

  只需要在上面的webConfig里重寫WebMvcConfigurerAdapter的addCorsMappings方法就可以獲得基於spring的跨域支持。

/**
     * 跨域CORS配置
     * @param registry
     */
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        super.addCorsMappings(registry);
        registry.addMapping("/**")
                .allowedHeaders("*")
                .allowedMethods("POST","GET")
                .allowedOrigins("http://...")
                .allowCredentials(true);
    }

  3.配置ViewController

   當首頁或者登陸頁的頁面對外暴露，不需要加載任何的配置的時候，這些頁面將不通過接口層，而是直接訪問，這時，就需要配置ViewController指定請求路徑直接到頁面。

 /**
     * 視圖控制器配置
     * @param registry
     */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        super.addViewControllers(registry);
        registry.addViewController("/").setViewName("forward:/index.html");
    }

 4.配置ViewResolver

  通常在使用jsp的項目中，會基於spring mvc配置的文件去配置視圖解析器，通過重寫WebMvcConfigurerAdapter里的configureViewResolvers也可以將自己定義的InternalResourceViewResolver配置整合進spring中。

/**
     * 配置請求視圖映射
     *
     * @return
     */
    @Bean
    public InternalResourceViewResolver resourceViewResolver() {
        InternalResourceViewResolver internalResourceViewResolver = new InternalResourceViewResolver();
        //請求視圖文件的前綴地址
        internalResourceViewResolver.setPrefix("/WEB-INF/jsp/");
        //請求視圖文件的后綴
        internalResourceViewResolver.setSuffix(".jsp");
        return internalResourceViewResolver;
    }

    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        super.configureViewResolvers(registry);
        registry.viewResolver(resourceViewResolver());
    }

  可以看一下ViewResolverRegistry中的代碼：

    public UrlBasedViewResolverRegistration jsp() {
        return this.jsp("/WEB-INF/", ".jsp");
    }

    public UrlBasedViewResolverRegistration jsp(String prefix, String suffix) {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix(prefix);
        resolver.setSuffix(suffix);
        this.viewResolvers.add(resolver);
        return new UrlBasedViewResolverRegistration(resolver);
    }

  可以看到，即使不去配置，spring也會新建一個默認的視圖解析器。十分方便。

 5.配置Formatter

  當請求的參數中帶有日期的參數的時候，可以在此配置formatter使得接收到日期參數格式統一。

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addFormatter(new Formatter<Date>() {
            @Override
            public Date parse(String date, Locale locale) {
                return new Date(Long.parseLong(date));
            }

            @Override
            public String print(Date date, Locale locale) {
                return Long.valueOf(date.getTime()).toString();
            }
        });
    }

 

  總結一下，本文主要講了如何通過JavaBean替代xml為springmvc做出自定義的配置，比較符合spring boot的去xml配置的風格。