前言

最近想體驗(yàn)下最新版本的SpringBoot，逛了下官網(wǎng)，發(fā)現(xiàn)SpringBoot目前最新版本已經(jīng)是2.6.4了，版本更新確實(shí)夠快的。之前的項(xiàng)目升級了2.6.4版本后發(fā)現(xiàn)有好多坑，不僅有循環(huán)依賴的問題，連Swagger都沒法用了！今天給大家分享下升級過程，填一填這些坑！

SpringBoot實(shí)戰(zhàn)電商項(xiàng)目mall（50k+star）地址：https://github.com/macrozheng/mall

首先我們來聊聊SpringBoot的版本，目前最新版本是2.6.4版本，2.7.x即將發(fā)布，2.4.x及以下版本已經(jīng)停止維護(hù)了，目前的主流版本應(yīng)該是2.5.x和2.6.x。具體可以看下下面這張表。

升級過程

下面我們將之前的mall-tiny-swagger項(xiàng)目升級下，看看到底有哪些坑，這些坑該如何解決！

添加依賴

首先在pom.xml中修改SpringBoot的版本號，注意從2.4.x版本開始，SpringBoot就不再使用.RELEASE后綴了。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.6.4</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

循環(huán)依賴

啟動項(xiàng)目后，由于SpringBoot禁止了循環(huán)引用，我們會遇到第一個問題，securityConfig和umsAdminServiceImpl循環(huán)引用了，具體日志如下；

具體來說就是我們的SecurityConfig引用了UmsAdminService；

而UmsAdminServiceImpl又引用了PasswordEncoder；

由于SecurityConfig繼承了WebSecurityConfigurerAdapter，而Adapter又引用了PasswordEncoder，這樣就導(dǎo)致了循環(huán)引用。

要解決這個問題其實(shí)很簡單，你可以修改application.yml直接允許循環(huán)引用，不過這個方法有點(diǎn)粗暴，在沒有其他方法的時候可以使用；

spring:
  main:
    allow-circular-references: true

其實(shí)循環(huán)引用主要是因?yàn)闀?dǎo)致Spring不知道該先創(chuàng)建哪個Bean才會被禁用的，我們可以使用@Lazy注解指定某個Bean進(jìn)行懶加載就可以優(yōu)雅解決該問題，比如在SecurityConfig中懶加載UmsAdminService。

啟動出錯

再次啟動SpringBoot應(yīng)用后會出現(xiàn)一個空指針異常，一看就是Swagger問題，原來挺好用的Swagger不能用了！

在Swagger的配置類中添加如下Bean可以解決該問題；

/**
 * Swagger2API文檔的配置
 */
@Configuration
public class Swagger2Config {
    @Bean
    public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
        return new BeanPostProcessor() {
            @Override
            public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
                if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) {
                    customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
                }
                return bean;
            }
            private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {
                List<T> copy = mappings.stream()
                        .filter(mapping -> mapping.getPatternParser() == null)
                        .collect(Collectors.toList());
                mappings.clear();
                mappings.addAll(copy);
            }
            @SuppressWarnings("unchecked")
            private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
                try {
                    Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
                    field.setAccessible(true);
                    return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
                } catch (IllegalArgumentException | IllegalAccessException e) {
                    throw new IllegalStateException(e);
                }
            }
        };
    }
}

文檔無法顯示

再次啟動后訪問Swagger文檔，會發(fā)現(xiàn)之前好好的文檔也無法顯示了，訪問地址：http://localhost:8088/swagger-ui/

修改application.yml文件，MVC默認(rèn)的路徑匹配策略為PATH_PATTERN_PARSER，需要修改為ANT_PATH_MATCHER；

spring:
  mvc:
    pathmatch:
      matching-strategy: ANT_PATH_MATCHER

再次啟動后發(fā)現(xiàn)Swagger已經(jīng)可以正常使用了！

聊聊springfox

提到Swagger，我們一般在SpringBoot中集成的都是springfox給我們提供的工具庫，看了下官網(wǎng)，該項(xiàng)目已經(jīng)快兩年沒有發(fā)布新版本了。

再看下Maven倉庫中的版本，依舊停留在之前的3.0.0版本。如果springfox再不出新版本的話，估計(jì)隨著SpringBoot版本的更新，兼容性會越來越差的！

總結(jié)

今天帶大家體驗(yàn)了一把SpringBoot升級2.6.x版本的過程，主要解決了循環(huán)依賴和Swagger無法使用的問題，希望對大家有所幫助！

如果你想了解更多SpringBoot實(shí)戰(zhàn)技巧的話，可以試試這個帶全套教程的實(shí)戰(zhàn)項(xiàng)目（50K+Star）：https://github.com/macrozheng/mall

參考資料

官網(wǎng)地址：https://github.com/springfox/springfox

項(xiàng)目源碼地址 https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-swagger2

更多關(guān)于SpringBoot2.6.x升級循環(huán)依賴Swagger的資料請關(guān)注腳本之家其它相關(guān)文章！