【BUG】Swagger2 与通用的 Spring MVC Controller 冲突

阳光穿透心脏的1/2处 2022-01-29 04:04 151阅读 0赞

## 问题 ##

--------------------

在做 YMall 商城项目时，配置了 Swagger2 接口文档，默认的访问路径时 [http://localhost:8080/swagger2-ui.html，一直][http_localhost_8080_swagger2-ui.html] 404。

## 问题原因 ##

--------------------

Swagger2 默认的访问路径时 [http://localhost:8080/swagger2-ui.html，但在因为我写了一个通用的页面跳转方法，如下：][http_localhost_8080_swagger2-ui.html 1]

/** * 通用的跳转方法 * * @param page * @return */
    @GetMapping("{page}")
    public String showPage(@PathVariable String page) { 
        return page;
    }

这时就出现了一个问题，访问 [http://localhost:8080/swagger2-ui.html，就会通过这个][http_localhost_8080_swagger2-ui.html 2] Controller，出现 404 错误。

![Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-01.jpg][]

于是我做了修改，再 web.xml 中配置了，如下代码：

<servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>/swagger-ui.html</url-pattern>
    </servlet-mapping>

让 /swagger-ui.html 由 Tomcat 默认的 Servlet 进行处理，这样就可以不经过 Controller，直接跳转 swagger2-ui.html 页面了。

当我以为问题这就解决了的时候，新的问题又出现了，/swagger-resources 这个路径的资源 404，原因也是因为通过了通用的 Controller。

![Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-02.jpg][]

我以为是跟前面同一个问题，在 web.xml 做了与之前的处理方式，发现 Tomcat 默认的 Servlet 也没有 /swagger-resources 这个路径映射，所以这个路径还是 404。

后来查看了 Swagger2 的源码，在 swagger-common 包中，有一个 ApiResourceController 就是 Swagger2 的路径映射 Controller，类中有 /swagger-resouces 路径的映射。

![Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-03.jpg][]

![Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-05.jpg][]

![Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-04.jpg][]

至于为什么这个类的的路径映射没有生效，可能是因为被我写的 Controller 给覆盖了。

## 解决方法 ##

--------------------

配置 web.xml，如下：

<servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>/swagger-ui.html</url-pattern>
    </servlet-mapping>

重写 /swagger2-resources 的路径映射，如下：

/** * @Classname SwaggerController * @Date 2019/5/20 19:32 * @Created by Yuu */
    @RestController
    public class SwaggerController { 
    
        @Autowired
        private ApiResourceController apiResourceController;
    
        /** * swagger-resources 跳转 * * @return */
        @GetMapping("/swagger-resources")
        public ResponseEntity<List<SwaggerResource>> swaggerResources() { 
            return apiResourceController.swaggerResources();
        }
    }

[http_localhost_8080_swagger2-ui.html]: http://localhost:8080/swagger2-ui.html%EF%BC%8C%E4%B8%80%E7%9B%B4
[http_localhost_8080_swagger2-ui.html 1]: http://localhost:8080/swagger2-ui.html%EF%BC%8C%E4%BD%86%E5%9C%A8%E5%9B%A0%E4%B8%BA%E6%88%91%E5%86%99%E4%BA%86%E4%B8%80%E4%B8%AA%E9%80%9A%E7%94%A8%E7%9A%84%E9%A1%B5%E9%9D%A2%E8%B7%B3%E8%BD%AC%E6%96%B9%E6%B3%95%EF%BC%8C%E5%A6%82%E4%B8%8B%EF%BC%9A
[http_localhost_8080_swagger2-ui.html 2]: http://localhost:8080/swagger2-ui.html%EF%BC%8C%E5%B0%B1%E4%BC%9A%E9%80%9A%E8%BF%87%E8%BF%99%E4%B8%AA
[Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-01.jpg]: /images/20220129/96b8e8fc5d0449ab93d413cd477ccdd1.png
[Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-02.jpg]: /images/20220129/2ff34fafdf8348b694542a343cc002d2.png
[Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-03.jpg]: /images/20220129/6afb995e18524a7ba28fc0060a53ab31.png
[Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-05.jpg]: /images/20220129/67dc6845bb8044f4805cdaa5aa2c5dbd.png
[Swagger2_E4_B8_8E_E9_80_9A_E7_94_A8_E7_9A_84_E9_A1_B5_E9_9D_A2_E8_B7_B3_E8_BD_AC_E6_96_B9_E6_B3_95_E5_86_B2_E7_AA_81-04.jpg]: /images/20220129/a0e1261ec1ac400c860d920005c59d34.png