小BUG大原理:重寫WebMvcConfigurationSupport後SpringBoot自動配置失效

你好,舊時光發表於2020-05-25

一、背景

公司的專案前段時間發版上線後,測試反饋使用者的批量刪除功能報錯。正常情況下看起來應該是個小BUG,可怪就怪在上個版本正常,且此次發版未涉及使用者功能的改動。因為這個看似小BUG我瞭解到不少未知的東西,在這裡和你們分享下。

先宣告下具體原因為了避免耽誤找解決問題方法的小夥伴們的寶貴時間,因為專案重寫了WebMvcConfigurationSupport,如果你的專案沒有重寫這個配置類,趕緊到別處找找,祝你很快找到解決BUG獲取經驗值升級。

二、問題描述

使用者批量刪除功能:前臺傳遞使用者ID陣列,後臺使用@RequestParam解析引數為list

錯誤提示:

Required List parameter 'ids[]' is not present

前臺程式碼:

$.ajax({
    url"/users",
    type"delete",
    data: {ids: ids},
    successfunction (response{
        if (response.code === 0) {
             layer.msg("刪除成功");
        }
    }
})

後臺程式碼:

@DeleteMapping("/users")
@ResponseBody
public Result delete(@RequestParam(value = "ids[]") List<Long> ids) {
    boolean status = sysUserService.deleteByIds(ids);
    return Result.status(status);
}

知識點:

  1. 後臺為什麼使用@RequestParam解析?

    ajax如果不指定上傳資料型別Content-Type,預設的是application/x-www-form-urlencoded,這種編碼格式後臺需要通過RequestParam來處理。

  2. 後臺為什麼引數名稱是ids[]?

image
image

三、問題分析和猜想驗證

1. 問題分析

前臺確實傳遞了ids[],後臺接收不到ids[],程式碼邏輯在上個版本是可行的,未對使用者模組更新。思來想去得出的結論,此次的全域性性的改動引發出來的問題。去其他頁面功能點選批量刪除,確實都不可用了。

想到全域性性的改動,記得自己當時為了全域性配置日期格式轉換還有Long傳值到前臺精度丟失的問題重寫了WebMvcConfigurationSupport,程式碼如下:

import com.alibaba.fastjson.serializer.SerializeConfig;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.serializer.ToStringSerializer;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

import java.math.BigInteger;
import java.util.ArrayList;
import java.util.List;

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        //1、定義一個convert轉換訊息的物件
        FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();
        //2、新增FastJson的配置資訊
        FastJsonConfig fastJsonConfig = new FastJsonConfig();

        //Long型別轉String型別
        SerializeConfig serializeConfig = SerializeConfig.globalInstance;
        serializeConfig.put(BigInteger.class, ToStringSerializer.instance);
        serializeConfig.put(Long.class, ToStringSerializer.instance);
        // serializeConfig.put(Long.TYPE, ToStringSerializer.instance); //不轉long值
        fastJsonConfig.setSerializeConfig(serializeConfig);

        fastJsonConfig.setSerializerFeatures(
                SerializerFeature.WriteMapNullValue, // 保留map空的欄位
                SerializerFeature.WriteNullStringAsEmpty, // 將String型別的null轉成""
                SerializerFeature.WriteNullNumberAsZero, // 將Number型別的null轉成0
                SerializerFeature.WriteNullListAsEmpty, // 將List型別的null轉成[]
                SerializerFeature.WriteNullBooleanAsFalse, // 將Boolean型別的null轉成false
                SerializerFeature.WriteDateUseDateFormat,  //日期格式轉換
                SerializerFeature.DisableCircularReferenceDetect // 避免迴圈引用
        );
        //3、在convert中新增配置資訊
        fastConverter.setFastJsonConfig(fastJsonConfig);
        //4、解決響應資料非json和中文響應亂碼
        List<MediaType> jsonMediaTypes = new ArrayList<>();
        jsonMediaTypes.add(MediaType.APPLICATION_JSON);
        fastConverter.setSupportedMediaTypes(jsonMediaTypes);
        //5、將convert新增到converters中
        converters.add(fastConverter);
        //6、追加預設轉換器
        super.addDefaultHttpMessageConverters(converters);
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations(
                "classpath:/static/");
        registry.addResourceHandler("swagger-ui.html").addResourceLocations(
                "classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations(
                "classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
    }
}

想到這,二話不說把@Configuration註釋掉,讓Spring啟動不載入這個配置類,結果如猜想,可以傳值了。

那麼問題就出現在這個配置類中,毫無頭緒的我只想找個背鍋的。我第一篇有關專案問題的總結就是FastJSON,嘿嘿,然後就把訊息轉換器的程式碼configureMessageConverters註釋了,然而並沒有啥用。

其實主要問題在於對SpringMVC讀取請求引數的流程不清楚,如果把流程梳理清楚了,應該就知道引數在哪丟了?!

附:SpringMVC請求處理流程(可略過)

宣告這裡單純的因為自己對Spring請求處理的流程不熟悉,可能和下文引出的問題產生原因並無直接關聯,東西有點多不感興趣的童鞋可以直接跳過。後面我會單獨整理篇有關SpringMVC請求處理流程,這裡就問題案例來進行的流程分析。

接下來在原始碼的角度層面來認識SpringMVC處理請求的過程。

SpringMVC處理請求流程從DispatcherServlet#doService方法作為入口,請求處理核心部分委託給doDispatch方法。

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
HttpServletRequest processedRequest = request;
HandlerExecutionChain mappedHandler = null;
...

try {
    try {
        ModelAndView mv = null;
        Object dispatchException = null;

        try {
            processedRequest = this.checkMultipart(request);
            multipartRequestParsed = processedRequest != request;
            //  獲取 HandlerExecutionChain處理器執行鏈,由handler處理器和interceptor攔截器組成 
            mappedHandler = this.getHandler(processedRequest);
            ...

            // 根據handler獲取對應的handlerAdapter去執行這個handler(Controller的方法)
            HandlerAdapter ha = this.getHandlerAdapter(mappedHandler.getHandler());
            ...
            mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
            if (asyncManager.isConcurrentHandlingStarted()) {
                return;
            }

            this.applyDefaultViewName(processedRequest, mv);
            mappedHandler.applyPostHandle(processedRequest, response, mv);
        } 
        ...
        this.processDispatchResult(processedRequest, response, mappedHandler, mv, (Exception)dispatchException);
    }
    ...

}

根據請求資訊的請求路徑和方法型別(get/post/put/delete)從HandlerMapping對映集合獲取 HandlerExecutionChain處理器執行鏈(包含handler和interceptor)。

通過獲得的handler型別去適配handlerAdapter執行對應的邏輯。那怎麼去找介面卡呢?首先你至少知道你的handler是什麼型別吧。在此之前,引入一個概念HandlerMethod,簡單點說就是你控制器Controller裡用來處理請求的方法的資訊、還有方法引數資訊等。

除錯時發現這裡使用的是AbstractHandlerMethodAdapter,看下內部用來做適配的supports方法。handler instanceof HandlerMethod這個判斷點明瞭一切。

public abstract class AbstractHandlerMethodAdapter extends WebContentGenerator implements HandlerAdapterOrdered {
    

    public final boolean supports(Object handler) {
        return handler instanceof HandlerMethod && this.supportsInternal((HandlerMethod)handler);
    }

    protected abstract boolean supportsInternal(HandlerMethod var1);

    @Nullable
    public final ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return this.handleInternal(request, response, (HandlerMethod)handler);
    }
    
    @Nullable
    protected abstract ModelAndView handleInternal(HttpServletRequest var1, HttpServletResponse var2, HandlerMethod var3) throws Exception;
}

找到介面卡後,執行其handle方法,呼叫內部方法handleInternal,交由其子類RequestMappingHandlerAdapter實現,我們平時開發最常用的也就是這個介面卡了。來看下RequestMappingHandlerAdapter#handleInternal方法。

protected ModelAndView handleInternal(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
    ModelAndView mav;
    ...
    // 呼叫RequestMappingHandlerAdapter#invokeHandlerMethod方法
    mav = this.invokeHandlerMethod(request, response, handlerMethod);
    ...
    return mav;
}

呼叫內部方法RequestMappingHandlerAdapter#invokeHandlerMethod,繼續走。

protected ModelAndView invokeHandlerMethod(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
    ...
    Object result;
    try {
        ...
        // 生成一個可呼叫的方法invocableMethod
        ServletInvocableHandlerMethod invocableMethod = this.createInvocableHandlerMethod(handlerMethod);
        if (this.argumentResolvers != null) {
            // 繫結引數解析器
            invocableMethod.setHandlerMethodArgumentResolvers(this.argumentResolvers);
        }

        if (this.returnValueHandlers != null) {
            invocableMethod.setHandlerMethodReturnValueHandlers(this.returnValueHandlers);
        }

        invocableMethod.setDataBinderFactory(binderFactory);
        invocableMethod.setParameterNameDiscoverer(this.parameterNameDiscoverer);
        ...
        // 核心 通過呼叫ServletInvocableHandlerMethod的invokeAndHandle方法執行Controller裡處理請求的方法
        invocableMethod.invokeAndHandle(webRequest, mavContainer, new Object[0]);
        ...
    }
    return (ModelAndView)result;
}

將HandlerMethod轉化成ServletInvocableHandlerMethod,可以說這個ServletInvocableHandlerMethod是SpringMVC最最核心的部分了。至於為什麼這麼說?

  1. 繫結了HandlerMethodArgumentResolver引數解析器
  2. 繫結了HandlerMethodReturnValueHandler返回值處理器
  3. 核心方法invokeAndHandle囊括了從請求到響應幾乎整個SpringMVC生命週期
 public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
    // 呼叫請求
    Object returnValue = this.invokeForRequest(webRequest, mavContainer, providedArgs);
    ...
    try {
        // 處理返回值
        this.returnValueHandlers.handleReturnValue(returnValue, this.getReturnValueType(returnValue), mavContainer, webRequest);
    }
    ...
}

本篇的BUG也就在於處理請求階段的問題,所以我們來看下ServletInvocableHandlerMethod#invokeForRequest方法。

public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
    Object[] args = this.getMethodArgumentValues(request, mavContainer, providedArgs);
    ...
    return this.doInvoke(args);
}

方法內部通過呼叫父類InvocableHandlerMethod#getMethodArgumentValues方法獲取請求引數。

protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
    MethodParameter[] parameters = this.getMethodParameters();
    if (ObjectUtils.isEmpty(parameters)) {
        return EMPTY_ARGS;
    } else {
        Object[] args = new Object[parameters.length];

        for(int i = 0; i < parameters.length; ++i) {
            MethodParameter parameter = parameters[i];
            parameter.initParameterNameDiscovery(this.parameterNameDiscoverer);
            args[i] = findProvidedArgument(parameter, providedArgs);
            if (args[i] == null) {
                ...
                try {
                    // 呼叫HandlerMethodArgumentResolverComposite的resolveArgument解析引數獲取返回值
                    args[i] = this.resolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);
                }
                ...
            }
        }

        return args;
    }
}

this.resolvers是HandlerMethodArgumentResolverComposite(相當於組合模式的變種),同時實現了HandlerMethodArgumentResolver介面,內部又包含所有引數解析器的列表。

public class HandlerMethodArgumentResolverComposite implements HandlerMethodArgumentResolver {
    // SpringMVC引數解析器的集合列表
    private final List<HandlerMethodArgumentResolver> argumentResolvers = new LinkedList();
    ...
    public boolean supportsParameter(MethodParameter parameter) {
        return this.getArgumentResolver(parameter) != null;
    }

    @Nullable
    public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
        HandlerMethodArgumentResolver resolver = this.getArgumentResolver(parameter);
        if (resolver == null) {
            throw new IllegalArgumentException("Unsupported parameter type [" + parameter.getParameterType().getName() + "]. supportsParameter should be called first.");
        } else {
            return resolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory);
        }
    }
    
    @Nullable
    private HandlerMethodArgumentResolver getArgumentResolver(MethodParameter parameter) {
        HandlerMethodArgumentResolver result = (HandlerMethodArgumentResolver)this.argumentResolverCache.get(parameter);
        if (result == null) {
            Iterator var3 = this.argumentResolvers.iterator();

            // 遍歷尋找適配的引數解析器
            while(var3.hasNext()) {
                HandlerMethodArgumentResolver resolver = (HandlerMethodArgumentResolver)var3.next();
                if (resolver.supportsParameter(parameter)) {
                    result = resolver;
                    this.argumentResolverCache.put(parameter, resolver);
                    break;
                }
            }
        }

        return result;
    }
    
}

MethodParameter是處理器方法(HandlerMethod)的一個HandlerMethodParameter處理器方法引數資訊,這裡面其中就包含了描述方法引數的註解資訊(eg:@RequestParam)。然後需要根據引數資訊從引數解析器列表查詢適配的引數解析器。

終於,在27個引數解析器中找到了RequestParamMapMethodArgumentResolver解析器,那我們去看下這個解析器做的適配方法supportsParameter。

public boolean supportsParameter(MethodParameter parameter) {
    if (parameter.hasParameterAnnotation(RequestParam.class)) {
        if (!Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType())) {
            return true;
        } else {
            RequestParam requestParam = (RequestParam)parameter.getParameterAnnotation(RequestParam.class);
            return requestParam != null && StringUtils.hasText(requestParam.name());
        }
    } else if (parameter.hasParameterAnnotation(RequestPart.class)) {
        return false;
    } else {
        parameter = parameter.nestedIfOptional();
        if (MultipartResolutionDelegate.isMultipartArgument(parameter)) {
            return true;
        } else {
            return this.useDefaultResolution ? BeanUtils.isSimpleProperty(parameter.getNestedParameterType()) : false;
        }
    }
}

可以看到RequestParamMapMethodArgumentResolver支援被註解@RequestParam、@RequestPart修飾的方法引數。

在確定了引數解析器後,使用解析器的resolveArgument方法解析引數。RequestParamMapMethodArgumentResolver自身沒有resolveArgument方法,而是使用父類AbstractNamedValueMethodArgumentResolver的resolveArgument的方法。

public final Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
    // 提取註解的屬性鍵值(eg: 註解RequestParam的name、required、defaultValue)
    AbstractNamedValueMethodArgumentResolver.NamedValueInfo namedValueInfo = this.getNamedValueInfo(parameter);
    MethodParameter nestedParameter = parameter.nestedIfOptional();
    // 獲取處理器方法引數名
    Object resolvedName = this.resolveStringValue(namedValueInfo.name);
    if (resolvedName == null) {
        throw new IllegalArgumentException("Specified name must not resolve to null: [" + namedValueInfo.name + "]");
    } else {
        //  根據引數名從request請求物件獲取值
        Object arg = this.resolveName(resolvedName.toString(), nestedParameter, webRequest);
        if (arg == null) {
            if (namedValueInfo.defaultValue != null) {
                arg = this.resolveStringValue(namedValueInfo.defaultValue);
            } else if (namedValueInfo.required && !nestedParameter.isOptional()) {
                this.handleMissingValue(namedValueInfo.name, nestedParameter, webRequest);
            }

            arg = this.handleNullValue(namedValueInfo.name, arg, nestedParameter.getNestedParameterType());
        } else if ("".equals(arg) && namedValueInfo.defaultValue != null) {
            arg = this.resolveStringValue(namedValueInfo.defaultValue);
        }

        if (binderFactory != null) {
            WebDataBinder binder = binderFactory.createBinder(webRequest, (Object)null, namedValueInfo.name);

            try {
                arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
            } catch (ConversionNotSupportedException var11) {
                throw new MethodArgumentConversionNotSupportedException(arg, var11.getRequiredType(), namedValueInfo.name, parameter, var11.getCause());
            } catch (TypeMismatchException var12) {
                throw new MethodArgumentTypeMismatchException(arg, var12.getRequiredType(), namedValueInfo.name, parameter, var12.getCause());
            }
        }

        this.handleResolvedValue(arg, namedValueInfo.name, parameter, mavContainer, webRequest);
        return arg;
    }
}

這樣一個一個的解析處理器方法引數,直到把方法所有的引數都從request拿到對應的值之後,返回args。對應邏輯在ServletInvocableHandlerMethod#invokeForRequest,最後返回引數陣列args。這樣整個引數解析完成之後執行後面的邏輯this.doInvoke(args)。

至此,SpringMVC請求處理流程就結束了。

總結下整個SpringMVC請求處理的流程:

  1. 請求由DispatcherServlet攔截處理。
  2. 根據request資訊從HandlerMapping對映關係獲取對應的HandlerExecutionChain執行鏈(包含了處理器handler和interceptor)。
  3. 從HandlerExecutionChain獲取處理器handler,根據handler型別去匹配對應的介面卡。我們平時最常寫的Controller用來處理請求的方法對應的handler型別是HandlerMethod,匹配的介面卡是RequestMappingHandlerAdapter。
  4. 請求處理委託給RequestMappingHandlerAdapter處理,介面卡將拿到的handler轉換成ServletInvocableHandlerMethod,其內部繫結了引數解析器HandlerMethodArgumentResolver和返回值處理器HandlerMethodReturnValueHandler。
  5. 執行ServletInvocableHandlerMethod的invokeAndHandle方法。整個方法包含了請求呼叫和響應處理,請求中包含了引數的解析過程。

2. 猜想驗證

其實上面扯了這麼多,還沒說到關鍵點為什麼重寫了WebMvcConfigurationSupport會導致後臺接收不了FormData?按照之前的分析我們需要的FormData資料可能在哪個階段丟了。前臺傳過來的資料肯定會存在request物件中,既然這樣,笨辦法是不是可以想比較下沒有重寫和重寫的情景,看看兩次的request物件是否有差異不就行了。

我們把斷點打在InvocableHandlerMethod#getMethodArgumentValues方法中,因為這裡是從request物件中提取出引數的方法。我們要做的只需觀察兩次的request物件的差異即可。

image
image

果不其然,重寫過WebMvcConfigurationSupport後,少了formParams這個屬性,而formParams包含了我們想要的引數ids[]。

至於為什麼重寫WebMvcConfigurationSupport會丟失formParams?是不是毫無頭緒?別急,我們先看下這個formParams是什麼。

image
image

從上圖可以看得到formParams是FormContentFilter中靜態內部類FomContentRequestWrapper的一個屬性。猜想formParams應該是使用FormContentFilter過濾器從request物件提取出來的,那現在少了formParams應該是過濾器FormContentFilter沒有載入。

重寫配置類之前沒有配置過FormContentFilter過濾器,所以這個過濾器應該是SpringBoot自動配置並載入的。來看下SpringBoot的WebMvc自動配置類WebMvcAutoConfiguration。這個類配置在spring.factories裡,SpringBoot啟動時自動載入配置在裡面的類,是SpringBoot的擴充套件機制,類似java的SPI。

image
image

FormContentFilter如我們所料在SpringBoot的WebMvc自動配置類中,隨著SpringBoot啟動自動裝配。那至於為什麼重寫了WebMvcConfigurationSupport就會導致自動配置失效了呢?再看下WebMvcAutoConfiguration的頭部註解描述。

image
image

@ConditionalOnMissingBean({WebMvcConfigurationSupport.class}),意思就是Spring容器中沒有WebMvcConfigurationSupport類相關bean自動配置才會生效。而我這裡重寫WebMvcConfigurationSupport並載入到Spring容器中,顯然導致SpringBoot自動配置不能生效,最終表現出來的現象是後臺接收不到前臺FromData傳值。

四、解決方案

  1. 既然自動配置失效,手動配置吧
    @Bean
    public FormContentFilter formContentFilter(){
        FormContentFilter formContentFilter=new OrderedFormContentFilter();
        return  formContentFilter;
    }

這種方案問題在於還是重寫了WebMvcConfigurationSupport,除了本篇說到的問題還有其他自動配置同樣會失效,感覺終究還是不是太好的方案。

  1. 繼承實現WebMvcConfigurer介面,會在支援原有預設配置的情況下新增配置(推薦)。
  2. 其他方案,要是你知道的話歡迎下方留言。

五、總結

其實就是專案中批量刪除失敗看似一個很小的BUG,引出SpringMVC有關請求引數處理原理和SpringBoot自動裝配原理。因為時間和篇幅的原因,SpringMVC和SpringBoot原理後面會開專欄細說。最後說一下老生常談的問題,最好的學習方式是結合工作專案中學,個人完全贊同這種說法。而我們大多數人終究逃不了那迴圈CRUD的命,但千萬別浪費時間去抱怨,有時候所處的環境無法改變時,要相信自己可以創造環境。哪怕重複的CRUD、哪怕再小的BUG,我們也可以做到獨具慧眼看到深藏在它們背後的東西,而我們要的就是這些藏在這背後的東西。廢話了很多,所有都得看自己,有幫助的話希望點個關注❤

相關文章