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

由於公司使用的spring版本過高，在集成swagger的時候會存在一些問題，而網上的不少實例大多都是版本比較低的，爲了是朋友們少才坑，我這邊將集成的過程記錄一下：

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

1. <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的配置類：

 

1. 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. 服務配置項

<span style="color: #ff0000;">@Api("區域服務")</span>    
@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;    
    }    
}    

 

4. 啓動項目，查看結果：

 

到此結束！！源碼來源