第三十四章：SpringBoot配置類WebMvcConfigurerAdapter

springDevBird 發(fā)布于2019-08-15 11:57 / 438人閱讀

摘要：本章目標(biāo)繼承采用形式實(shí)現(xiàn)個(gè)性化配置定制。本章代碼已經(jīng)上傳到碼云網(wǎng)頁(yè)地址地址相關(guān)系列文章請(qǐng)?jiān)L問(wèn)目錄學(xué)習(xí)目錄相關(guān)系列文章請(qǐng)?jiān)L問(wèn)通用查詢框架學(xué)習(xí)目錄相關(guān)系列文章請(qǐng)?jiān)L問(wèn)目錄學(xué)習(xí)目錄感謝閱讀歡迎加入技術(shù)交流群，共同進(jìn)步。

WebMvcConfigurerAdapter配置類其實(shí)是Spring內(nèi)部的一種配置方式，采用JavaBean的形式來(lái)代替?zhèn)鹘y(tǒng)的xml配置文件形式進(jìn)行針對(duì)框架個(gè)性化定制，下面我們來(lái)看一下該類內(nèi)的常用方法。

本章目標(biāo)

繼承WebMvcConfigurerAdapter采用JavaBean形式實(shí)現(xiàn)個(gè)性化配置定制。

構(gòu)建項(xiàng)目

本章內(nèi)容同樣不涉及到業(yè)務(wù)邏輯，我們創(chuàng)建一個(gè)web項(xiàng)目即可，pom.xml配置文件如下所示：

...//省略

        
            org.springframework.boot
            spring-boot-starter-web
        

        
            org.springframework.boot
            spring-boot-starter-tomcat
            
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
    
...//省略

WebMvcConfigurerAdapter實(shí)現(xiàn)類

我們創(chuàng)建一個(gè)配置實(shí)體類型，并繼承WebMvcConfigurerAdapter，代碼如下所示：

package com.yuqiyu.chapter34;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.*;

import java.util.List;

/**
 * 自定義配置類實(shí)現(xiàn)JavaBean注解形式配置
 * ========================
 * Created with IntelliJ IDEA.
 * User：恒宇少年
 * Date：2017/9/3
 * Time：21:48
 * 碼云：http://git.oschina.net/jnyqy
 * ========================
 */
@Configuration
public class WebConfiguration
    extends WebMvcConfigurerAdapter
{
}

我們?cè)谂渲妙惿咸砑恿俗⒔?b>@Configuration，標(biāo)明了該類是一個(gè)配置類并且會(huì)將該類作為一個(gè)SpringBean添加到IOC容器內(nèi)，我們打開該注解的源碼查看如下所示：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.context.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.stereotype.Component;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
    String value() default "";
}

可以看到在@Configuration 上聲明式添加了Spring注入注解@Component，也就是解釋了為什么我們配置了@Configuration會(huì)被自動(dòng)添加到IOC容器內(nèi)。

WebMvcConfigurerAdapter該抽象類其實(shí)里面沒有任何的方法實(shí)現(xiàn)，只是空實(shí)現(xiàn)了接口WebMvcConfigurer內(nèi)的全部方法，并沒有給出任何的業(yè)務(wù)邏輯處理，這一點(diǎn)設(shè)計(jì)恰到好處的讓我們不必去實(shí)現(xiàn)那些我們不用的方法，都交由WebMvcConfigurerAdapter抽象類空實(shí)現(xiàn)，如果我們需要針對(duì)具體的某一個(gè)方法做出邏輯處理，僅僅需要在WebMvcConfigurerAdapter子類中@Override對(duì)應(yīng)方法就可以了。

配置攔截器

在之前Xml配置形式天下的時(shí)候，我們都是在spring-mvc.xml配置文件內(nèi)添加標(biāo)簽配置攔截器。攔截器的相關(guān)創(chuàng)建請(qǐng)?jiān)L問(wèn)第六章：如何在SpringBoot項(xiàng)目中使用攔截器，攔截器配置如下所示：

    /**
     * 攔截器配置
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        super.addInterceptors(registry);
        registry.addInterceptor(new TestInterceptor()).addPathPatterns("/**");
    }

InterceptorRegistry 內(nèi)的addInterceptor需要一個(gè)實(shí)現(xiàn)HandlerInterceptor接口的攔截器實(shí)例，addPathPatterns方法用于設(shè)置攔截器的過(guò)濾路徑規(guī)則。

配置CORS

跨域我們之前章節(jié)也有講到，請(qǐng)?jiān)L問(wèn)第二十五章：SpringBoot添加支持CORS跨域訪問(wèn)，Spring既然為了集成了CROS，那就證明了一點(diǎn)，以后前后端分離是一個(gè)開發(fā)趨勢(shì)，配置代碼如下所示：

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

配置ViewController

這一個(gè)配置在之前是經(jīng)常被使用到的，最經(jīng)常用到的就是"/"、"/index"路徑請(qǐng)求時(shí)不通過(guò)@RequestMapping配置，而是直接通過(guò)配置文件映射指定請(qǐng)求路徑到指定View頁(yè)面，當(dāng)然也是在請(qǐng)求目標(biāo)頁(yè)面時(shí)不需要做什么數(shù)據(jù)處理才可以這樣使用，配置內(nèi)容如下所示：

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

配置ViewResolver

這個(gè)對(duì)我們來(lái)說(shuō)很熟悉，只要我們配置html、Jsp頁(yè)面視圖時(shí)就會(huì)用到InternalResourceViewResolver配置類，然后設(shè)置preffix、suffix參數(shù)進(jìn)行配置視圖文件路徑前綴與后綴。配置代碼如下所示：

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

    /**
     * 視圖配置
     * @param registry
     */
    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        super.configureViewResolvers(registry);
        registry.viewResolver(resourceViewResolver());
        /*registry.jsp("/WEB-INF/jsp/",".jsp");*/
    }

上述代碼中方法resourceViewResolver上配置了@Bean注解，該注解會(huì)將方法返回值加入到SpringIoc容器內(nèi)。
而在configureViewResolvers方法內(nèi)配置視圖映射為resourceViewResolver方法返回的InternalResourceViewResolver 實(shí)例，這樣完成了視圖的配置。在下面還有注釋掉的一部分代碼，這塊代碼很神奇，我們先來(lái)看看org.springframework.web.servlet.config.annotation.ViewResolverRegistry源碼：

package org.springframework.web.servlet.config.annotation;

public class 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);
    }
}
...//省略代碼

可以看到上述源碼中有兩個(gè)jsp方法，而沒有參數(shù)的方法恰恰跟我們配置的內(nèi)容一樣，這一點(diǎn)看來(lái)是Spring早就根據(jù)用戶使用習(xí)慣添加的默認(rèn)配置，同樣也提供了自定義配置Jsp相關(guān)的前綴、后綴內(nèi)容的方法，
方法內(nèi)部同樣是實(shí)例化了一個(gè)InternalResourceViewResolver 視圖映射類，并將實(shí)例添加到了viewResolvers集合內(nèi)。

配置MessageConverter

這個(gè)配置一般針對(duì)于Api接口服務(wù)程序，配置在請(qǐng)求返回時(shí)內(nèi)容采用什么轉(zhuǎn)換器進(jìn)行轉(zhuǎn)換，我們最常用到的就是fastJson的轉(zhuǎn)換，配置如下所示：

/**
     * 消息內(nèi)容轉(zhuǎn)換配置
     * 配置fastJson返回json轉(zhuǎn)換
     * @param converters
     */
    @Override
    public void configureMessageConverters(List> converters) {
        //調(diào)用父類的配置
        super.configureMessageConverters(converters);
        //創(chuàng)建fastJson消息轉(zhuǎn)換器
        FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();
        //創(chuàng)建配置類
        FastJsonConfig fastJsonConfig = new FastJsonConfig();
        //修改配置返回內(nèi)容的過(guò)濾
        fastJsonConfig.setSerializerFeatures(
                SerializerFeature.DisableCircularReferenceDetect,
                SerializerFeature.WriteMapNullValue,
                SerializerFeature.WriteNullStringAsEmpty
        );
        fastConverter.setFastJsonConfig(fastJsonConfig);
        //將fastjson添加到視圖消息轉(zhuǎn)換器列表內(nèi)
        converters.add(fastConverter);
    }

內(nèi)容轉(zhuǎn)換都是針對(duì)面向接口進(jìn)行編寫的實(shí)現(xiàn)類，都必須implements HttpMessageConverter接口完成方法的實(shí)現(xiàn)。

總結(jié)

以上內(nèi)容就是本章的全部講解內(nèi)容，本章主要講解了采用JavaBean配置的形式代替?zhèn)鹘y(tǒng)的Xml配置文件的形式進(jìn)行多種配置聲明，根據(jù)源碼我們可見到Spring在多年被使用的過(guò)程中不斷的提供一些默認(rèn)配置，從而達(dá)到用于預(yù)計(jì)的效果并提高了開發(fā)效率。

本章代碼已經(jīng)上傳到碼云：
網(wǎng)頁(yè)地址：http://git.oschina.net/jnyqy/lessons
Git地址：https://git.oschina.net/jnyqy/lessons.git
SpringBoot相關(guān)系列文章請(qǐng)?jiān)L問(wèn)：目錄：SpringBoot學(xué)習(xí)目錄
QueryDSL相關(guān)系列文章請(qǐng)?jiān)L問(wèn)：QueryDSL通用查詢框架學(xué)習(xí)目錄
SpringDataJPA相關(guān)系列文章請(qǐng)?jiān)L問(wèn)：目錄：SpringDataJPA學(xué)習(xí)目錄
感謝閱讀！
歡迎加入QQ技術(shù)交流群，共同進(jìn)步。