Spring 4.2.2以上版本和swagger集成方案和踩过的坑

一时失言乱红尘 2022-04-21 14:46 53阅读 0赞

因为公司使用的spring版本太高，在集成swagger的时候会存在一些问题，而网上的很多实例大多都是版本比较低的，为了使朋友们少踩坑，我这边将集成的过程记录一下：愿意了解源码的朋友直接求求交流分享技术二一四七七七五六三三

1. 引入spring、swagger的相关jar包（springfox-swagger2、springfox-swagger-ui），在pom.xml中配置：

<dependency>  
                <groupId>io.springfox</groupId>  
                <artifactId>springfox-swagger2</artifactId>  
                <version>2.4.0</version>  
                <exclusions>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-core</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-beans</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-context</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-context-support</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-aop</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-tx</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-orm</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-jdbc</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-web</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-webmvc</artifactId>  
                    </exclusion>  
                    <exclusion>  
                        <groupId>org.springframework</groupId>  
                        <artifactId>spring-oxm</artifactId>  
                    </exclusion>  
                </exclusions>  
            </dependency>  
            <dependency>  
                <groupId>io.springfox</groupId>  
                <artifactId>springfox-swagger-ui</artifactId>  
                <version>2.4.0</version>  
            </dependency>

提醒： 特别注意，springfox-swagger2在集成的时候，已经引入了spring的相关jar，特别是spring-context、spring-context-support的版本和项目中使用的版本完全不一致，项目在启动的时候出现很多包冲突的问题，这边在引入pom.xml文件的时候过滤掉了spring的相关jar包。

2. 编写Swagger的配置类：

package com.ml.honghu.swagger.web;  
      
    import org.springframework.context.annotation.Bean;  
    import org.springframework.context.annotation.ComponentScan;  
    import org.springframework.context.annotation.Configuration;  
    import org.springframework.web.servlet.config.annotation.EnableWebMvc;  
      
    import springfox.documentation.builders.ApiInfoBuilder;  
    import springfox.documentation.builders.PathSelectors;  
    import springfox.documentation.builders.RequestHandlerSelectors;  
    import springfox.documentation.service.ApiInfo;  
    import springfox.documentation.service.Contact;  
    import springfox.documentation.spi.DocumentationType;  
    import springfox.documentation.spring.web.plugins.Docket;  
    import springfox.documentation.swagger2.annotations.EnableSwagger2;  
      
    @EnableWebMvc  
    @EnableSwagger2  
    @Configuration  
    @ComponentScan(basePackages ={"com.ml.honghu.**.rest"})  
    public class SwaggerConfig {  
        @Bean  
        public Docket createRestApi() {  
            return new Docket(DocumentationType.SWAGGER_2)  
                    .apiInfo(apiInfo())  
                    .select()  
                    .apis(RequestHandlerSelectors.basePackage("com.ml.honghu"))  
                    .paths(PathSelectors.any())  
                    .build();  
        }  
      
        private ApiInfo apiInfo() {  
            return new ApiInfoBuilder()  
                    .title("接口列表 v1.0")  
                    .description("接口信息")  
                    .termsOfServiceUrl("http://honghu.com")  
                    .contact(new Contact("", "", "HongHu"))  
                    .version("1.1.0")  
                    .build();  
        }  
    }

3. 在spring-mvc.xml文件中进行过滤器的配置，过滤掉swagger的相关访问配置

<mvc:exclude-mapping path="/swagger*/**"/>  
    <mvc:exclude-mapping path="/v2/**"/>  
    <mvc:exclude-mapping path="/webjars/**"/>

4. 服务配置项

@Api("区域服务")
    @RestController  
    @RequestMapping(value = "/rest/area")  
    public class AreaService  {  
      
        @Autowired  
        private AreaService areaService;  
          
        <span style="color: #ff0000;">@ApiOperation(value = "区域列表", httpMethod = "GET", notes = "区域列表")</span>  
        @IsLogin  
        @ResponseBody  
        @RequestMapping(value = "treeData", method = RequestMethod.GET)  
        public List<Map<String, Object>> treeData(  
                <span style="color: #ff0000;">@ApiParam(required = true, value = "区域ID")</span>  @RequestParam(required=false) String extId, HttpServletResponse response) {  
            List<Map<String, Object>> mapList = Lists.newArrayList();  
            List<Area> list = areaService.findAll();  
            for (int i=0; i<list.size(); i++){  
                Area e = list.get(i);  
                if (StringUtils.isBlank(extId) || (extId!=null && !extId.equals(e.getId()) && e.getParentIds().indexOf(","+extId+",")==-1)){  
                    Map<String, Object> map = Maps.newHashMap();  
                    map.put("id", e.getId());  
                    map.put("pId", e.getParentId());  
                    map.put("name", e.getName());  
                    mapList.add(map);  
                }  
            }  
            return mapList;  
        }  
    }

5. 启动项目，查看结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NwcmluZ01M_size_16_color_FFFFFF_t_70][]

[资料和源码来源][Link 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NwcmluZ01M_size_16_color_FFFFFF_t_70]: /images/20220414/815362f9da054a7c8acd14a43dc76654.png
[Link 1]: http://minglisoft.cn/honghu/technology.html