Spring-Boot約定優(yōu)于配置好是挺好的雷则,但有時(shí)候也挺坑的,就比如我最近遇到的這個(gè)問題肪笋。因?yàn)轫?xiàng)目需要加一個(gè)自定義的HandlerMethodReturnValueHandler來處理成統(tǒng)一的響應(yīng)結(jié)果月劈。網(wǎng)上一搜,有些博客會告訴你實(shí)現(xiàn)WebMvcConfigurer接口然后加上@Configuration和@EnbleWebMvc注解藤乙,有些博客又是另一種方式猜揪,讓你直接繼承WebMvcConfigurerAdapter或者繼承WebMvcConfigurationSupport又或者繼承DelegatingWebMvcConfiguration。各有各的說法坛梁,好像都能實(shí)現(xiàn)而姐,又好像都會導(dǎo)致其他的問題,比如這個(gè)swagger突然就訪問不了划咐,或者Pageable突出就解析不了了等等拴念。
這時(shí)候你可能會跟我一樣,去瞅瞅這幾個(gè)類的javadoc看看官方是怎么說的褐缠。然后你會發(fā)現(xiàn)政鼠,官方也是這么說的“大部分情況你只要實(shí)現(xiàn)WebMvcConfigurer接口你所需要實(shí)現(xiàn)的方法,然后加上@Configuration队魏,然后其中一個(gè)類加上@EnbleWebMvc注解就可以了公般,當(dāng)實(shí)現(xiàn)接口不能滿足你的需求時(shí)確實(shí)是可以考慮繼承WebMvcConfigurationSupport的”。那么問題到底出在什么地方呢器躏?
問題就出在Spring-Boot的自動配置俐载。前面的這些機(jī)制都是spring-webmvc這個(gè)jar提供的,如果沒有自動配置登失,確實(shí)上面的方法都不會有問題(嚴(yán)格來說也不算問題遏佣,只是你不明白發(fā)生了什么而已)。而一旦你引入了spring-boot-autoconfigure揽浙,你就不能再按上面的說法去做了状婶。
我來詳細(xì)解釋一下這里面的關(guān)系。首先spring-webmvc的機(jī)制是沒有問題的馅巷,在不引入spring-boot-autoconfigure這個(gè)自動配置包的情況下膛虫,我們配置好swagger之后實(shí)際上是訪問不到swagger的頁面的,因?yàn)閟wagger本身以及我們自己都沒有向spring注冊相應(yīng)的ResourceHandler钓猬。我們使用spring-boot之所以能訪問到swagger-ui.html稍刀,是因?yàn)閟pring-boot-autoconfigure包中的WebMvcAutoConfiguration這個(gè)類。
上面這段代碼來自WebMvcAutoConfiguration中的內(nèi)部配置類WebMvcAutoConfigurationAdapter,就是它注冊了/**的ResouceHandler讓我們能夠訪問的classpath下面的swagger-ui.html账月。這一切本來都挺好的综膀,問題的源頭就出在WebMvcAutoConfiguration上面的一個(gè)注解:
意思是只有不存在WebMvcConfigurationSupport這個(gè)類型的bean時(shí),這一大堆自動配置才會生效局齿。而spring-webmvc推薦的使用@EnableWebMvc會自動引入DelegatingWebMvcConfiguration這個(gè)WebMvcConfigurationSupport的子類來加載所有實(shí)現(xiàn)了WebMvcConfigurer接口的Configuration剧劝,和直接繼承WebMvcConfigurationSupport的效果一樣都會導(dǎo)致自動配置失效。你說這能怪誰抓歼?怪spring-webmvc讥此?人家單獨(dú)開發(fā)寫文檔的時(shí)候又怎么會想到你autoconfigure會這么搞?怪autoconfigure谣妻?人家確實(shí)也是在盡可能讓你既可以使用自動配置萄喳,又可以覆蓋自動配置。只是你不會用而已蹋半,你只需要實(shí)現(xiàn)WebMvcConfigurer接口加上@Configuration就可以了取胎,千萬別加@EnableWebMvc。要怪只能怪你湃窍,沒看源碼羅!哈哈~~滑天下之大稽匪傍。我他喵搞了一整天才找到這個(gè)根源您市。
另外順便提一嘴,別傻乎乎地真的去直接繼承WebMvcConfigurationSupport役衡,起碼也應(yīng)該是繼承它的子類DelegatingWebMvcConfiguration茵休,因?yàn)槔锩姘思虞d所有實(shí)現(xiàn)了WebMvcConfigurer接口的Configuration。比如上面提到的Pageable失效就是因?yàn)橹苯永^承WebMvcConfigurationSupport導(dǎo)致的SpringDataWebConfiguration這個(gè)配置沒有被加載手蝎。
唉榕莺,難怪常看到“Spring Boot sucks”這樣的字眼棵介。