Spring Boot中使用Swagger3.0.0版本构建RESTful APIs的方法
刘大猫. 人气:0一、项目描述
为了练习Spring Boot中使用Swagger3.0.0版本生成可视化的swagger接口文档
本项目涉及的版本
- Spring版本:5.3.22
- SpringBoot版本:2.7.3
- Swagger版本:3.0.0
二、简介
一般我们在对接前后端的时候,都需要提供相应的接口文档。对于后端来说,编写接口文档即费时费力,还会经常因为没有及时更新,导致前端对接时出现实际接口与文档不一致。而且手写接口文档还容易出错,而swagger很好的解决了这个痛点。
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。可用于:1.接口的文档在线自动生成、2.功能测试。
三、Swagger2.X和Swagger3.0.0 的对比
1)SpringFox 2.x 发布
此版本的亮点:
- 号称时最流行的 API 框架
- 接口文档在线生成,避免同步的麻烦
- 可以支持在线对接口执行测试
- 支持多语言
SpringBoot项目整合swagger2需要用到两个依赖:springfox-swagger2和springfox-swagger-ui,用于自动生成swagger文档。
springfox-swagger2:这个组件的功能用于帮助我们自动生成描述API的json文件
springfox-swagger-ui:就是将描述API的json文件解析出来,用一种更友好的方式呈现出来。
2)SpringFox 3.0.0 发布
此版本的亮点:
- Spring5,Webflux支持(仅支持请求映射,尚不支持功能端点)。
- Spring Integration支持。
- SpringBoot支持springfox Boot starter依赖性(零配置、自动配置支持)。
- 支持OpenApi 3.0.3。
- 零依赖。几乎只需要spring-plugin,swagger-core ,现有的swagger2注释将继续工作并丰富openapi3.0规范。
兼容性说明:
- 需要Java 8
- 需要Spring5.x(未在早期版本中测试)
- 需要SpringBoot 2.2+(未在早期版本中测试)
3)swagger3.0 与2.xx配置差异:
- 应用主类添加注解@EnableOpenApi (swagger2是@EnableSwagger2)
- swagger配置类SwaggerProperties.class,与swagger2.xx 版本有差异,具体看下文
- 自定义一个配置类 SwaggerConfiguration.class,看下文
- 访问地址:http://localhost:8080/swagger-ui/index.html
- (swagger2.xx版本访问的地址为http://localhost:8080/swagger-ui.html)
四、注解说明
注意:注解中其实会有很多的属性,该文章只列出部分常用的属性而已,其他不常用属性请查看其他人博客!
@Api
@Api
@Api : 位置:用在请求的类上,例如Controller, 作用:说明该类的主要作用。 参数说明:@Api("tags":"", "value":"", "description ":"") tags:说明该类的作用,参数是个数组,可以填多个。 value="该参数没什么意义,在UI界面上不显示,所以不用配置" description = "用户基本信息操作"
代码示例如下:
@RestController @RequestMapping("/swagger") @Api(tags = "用户管理") @Slf4j public class SwaggerController {}
网站效果展示:
@ApiOperation
@ApiOperation
@ApiOperation: 位置:用在请求方法上 作用:说明方法的用途、作用 参数说明:@ApiOperation("value":"", "notes":"", "tags ":"") value="方法的用途和作用" notes="方法的注意事项和备注" tags:说明该方法的作用, 参数是个数组,可以填多个。例如格式:tags={"作用1","作用2"}
代码示例如下:
@GetMapping("/getList") @ApiOperation(value = "分页查询", notes = "分页查询的注意事项和备注", tags = {"说明该方法的作用1,说明该方法的作用2"}) public Response<PageResult<User>> getList(@RequestParam int pageNo, @RequestParam int pageSize){
网站效果展示:
@ApiImplicitParams
@ApiImplicitParams
@ApiImplicitParams: 位置:用在请求方法上 作用:包含多@ApiImplicitParam,包含一组参数说明。 参数说明:@ApiImplicitParams({@ApiImplicitParam("name":"", "value":"", "dataType":"", "paramType":"", "required":"")...}) @ApiImplicitParams: 位置:用在请求方法上 作用:包含多@ApiImplicitParam,包含一组参数说明。 参数说明:@ApiImplicitParams({@ApiImplicitParam("name":"", "value":"", "dataType":"", "paramType":"", "required":"")...})
代码示例如下:
@GetMapping("/getList") @ApiOperation(value = "分页查询", notes = "分页查询的注意事项和备注", tags = {"说明该方法的作用1,说明该方法的作用2"}) @ApiImplicitParams({ @ApiImplicitParam(name = "pageNo", value = "当前页码,从1开始", paramType = "query", required = true, dataType="int") , @ApiImplicitParam(name = "pageSize", value = "每页显示记录数", paramType = "query",required = true, dataType="int") , }) public Response<PageResult<User>> getList(@RequestParam int pageNo, @RequestParam int pageSize){
@ApiImplicitParam
@ApiImplicitParam
@ApiImplicitParam: 位置:用在请求方法上 作用:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面说明 参数说明:@ApiImplicitParam("name":"", "value":"", "dataType":"", "paramType":"", "required":"") name="参数名称" value="参数说明" dataType="数据类型",默认String required=true 参数是否必选 paramType="query" 表示参数放在哪里,查询参数类型,这里有几种形式: header --> 请求参数的获取:@RequestHeader,参数在 request headers 里边提交 query --> 请求参数的获取:@RequestParam,直接跟参数,完成自动映射赋值 path(用于 restful 接口)--> 请求参数的获取:@PathVariable,以地址的形式提交数据 body(不常用)--> 以流的形式提交 仅支持 POST form(不常用)--> 以 form 表单的形式提交 仅支持 POST
代码示例如下:
@GetMapping("/getList") @ApiOperation(value = "分页查询", notes = "分页查询的注意事项和备注", tags = {"说明该方法的作用1,说明该方法的作用2"}) @ApiImplicitParams({ @ApiImplicitParam(name = "pageNo", value = "当前页码,从1开始", paramType = "query", required = true, dataType="int") , @ApiImplicitParam(name = "pageSize", value = "每页显示记录数", paramType = "query",required = true, dataType="int") , }) public Response<PageResult<User>> getList(@RequestParam int pageNo, @RequestParam int pageSize){
网站效果展示:
@ApiResponses
@ApiResponses
@ApiResponses:用在请求的方法上,表示一组响应
代码示例如下:
@GetMapping("/getList") @ApiResponses({ @ApiResponse(code=400,message="请求参数及格式不对"), @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对") }) public Response<PageResult<User>> getList(@RequestParam int pageNo, @RequestParam int pageSize){
@ApiResponse
@ApiResponse
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息 code:数字,例如400 message:信息,例如"请求参数没填好" response:抛出异常的类
代码示例如下:
@GetMapping("/getList") @ApiResponses({ @ApiResponse(code=400,message="请求参数及格式不对"), @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对") }) public Response<PageResult<User>> getList(@RequestParam int pageNo, @RequestParam int pageSize){
网站效果展示:
@ApiModel
@ApiModel
@ApiModel: 位置:用在返回对象类上 作用:描述一个Model的信息(一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候) 参数说明:@ApiModel("description":"") description="描述实体的作用"
代码示例如下:
package com.swagger.bean; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; @Data @AllArgsConstructor @NoArgsConstructor @ApiModel(description= "返回响应数据") public class User { @ApiModelProperty(name = "id", value = "用户ID") private Integer id; //姓名 @ApiModelProperty(name = "name", value = "用户姓名") private String name; //密码 @ApiModelProperty(name = "password", value = "用户密码") private String password; }
@ApiModelProperty
@ApiModelProperty
@ApiModelProperty: 位置:用在属性上 作用:描述一个model的属性 参数说明:@ApiModelProperty("value":"", "name":"", "required":"") value="参数说明" 描述参数的意义 name="参数名称" 参数的变量名 required=true 参数是否必选
代码示例如下:
package com.swagger.bean; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; @Data @AllArgsConstructor @NoArgsConstructor @ApiModel(description= "返回响应数据") public class User { @ApiModelProperty(name = "id", value = "用户ID") private Integer id; //姓名 @ApiModelProperty(name = "name", value = "用户姓名") private String name; //密码 @ApiModelProperty(name = "password", value = "用户密码") private String password; }
网站效果展示:
@ApiParam
@ApiParam
@ApiParam: 位置:用在请求方法、参数上 作用:对参数使用说明(如:说明 或是否必填等) 参数说明:@ApiParam("value":"", "name":"", "required":"") value="参数说明" 描述参数的意义 name="参数名称" 参数的变量名 required=true 参数是否必选
代码示例如下:
@PostMapping("/post") @ApiOperation(value = "新增用户", notes = "演示json参数是否接受成功") public Response postTest(@ApiParam(name = "user", value = "接收传递给后端接口的user对象参数") @RequestBody User user) {
网站效果展示:
@ApiIgnore
@ApiIgnore
@ApiIgnore: 位置:用在类,方法,参数 作用:表示这个方法或者类被忽略,也就是在http://ip:port/swagger-ui.html上不显示 参数说明:无
代码示例如下:
@ApiIgnore @PutMapping("/update2") @ApiOperation(value = "修改用户2", notes = "演示json参数是否接受成功") public Response updateTest2(@ApiParam(name = "user", value = "接收传递给后端接口的user对象参数") @RequestBody User user) {
具体使用详情请看:Swagger中@ApiIgnore注解的使用
网站效果展示:
五、案例准备工作
0.项目目录
1.pom依赖
<dependencies> <!--解决@RestController注解爆红--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>2.6.3</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.22</version> </dependency> <!--Swagger版本--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> </dependencies>
2.创建SwaggerConfig
package com.swagger.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.oas.annotations.EnableOpenApi; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; /** * Swagger配置 */ @Configuration @EnableOpenApi //@EnableOpenApi用于开启Swagger在 Spring Boot,可放在启动类上,也可放在这里, public class SwaggerConfig { /** * 配置Swagger的Docket的bean实例 */ @Bean public Docket docket() { return new Docket(DocumentationType.OAS_30) //(常用) groupName:分组 .groupName("标准接口") .apiInfo(apiInfo()) //(常用) select:通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现 .select() // /** * (常用) apis:过滤规则,可以自定义指定哪些接口生成文档 * RequestHandlerSelectors:配置要扫描接口的方式 * basePackage:指定要扫描的包 * any:扫面全部 * none:不扫描 * withClassAnnotation:扫描类上的注解(参数是类上注解的class对象) * withMethodAnnotation:扫描方法上的注解(参数是方法上的注解的class对象) */ .apis(RequestHandlerSelectors.basePackage("com.swagger.controller")) //(常用) apis:加了ApiOperation注解的类,生成接口文档 // .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) /** * (常用) paths:过滤路径 * PathSelectors:配置过滤的路径 * any:过滤全部路径 * none:不过滤路径 * ant:过滤指定路径:按照按照Spring的AntPathMatcher提供的match方法进行匹配 * regex:过滤指定路径:按照String的matches方法进行匹配 */ .paths(PathSelectors.any()) //(已淘汰)所有接口统一定义响应信息 // .build().globalResponseMessage(); .build(); } /** * 配置文档描述 * 访问地址:http://ip:port/swagger-ui.html */ private ApiInfo apiInfo() { return new ApiInfoBuilder() //文档标题 .title("标题:Spring Boot中使用Swagger3.0.0版本构建RESTful APIs") //文档描述 .description("描述:用户列表的CRUD") //团队链接 .termsOfServiceUrl("https://blog.csdn.net/a924382407/article/details/127842503") //联系人信息 .contact(new Contact("刘大猫", "https://blog.csdn.net/a924382407/article/details/127842503", "ldz924382407@163.com")) //API 版本 .version("1.0") .build(); } }
3.配置文件application.yml
# 端口号 server: port: 8016 # 设置SpringMVC的路径匹配策略 spring: mvc: pathmatch: matching-strategy: ant_path_matcher
4.实体bean
package com.swagger.bean; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; /** * @Author 211145187 * @Date 2022/2/23 09:32 **/ @Data @AllArgsConstructor @NoArgsConstructor @ApiModel(description= "返回响应数据") public class User { @ApiModelProperty(name = "id", value = "用户ID") private Integer id; //姓名 @ApiModelProperty(name = "name", value = "用户姓名") private String name; //密码 @ApiModelProperty(name = "password", value = "用户密码") private String password; }
5.后端接口SwaggerController
package com.swagger.controller; import com.swagger.bean.User; import com.swagger.response.PageResult; import com.swagger.response.Response; import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; import io.swagger.annotations.ApiResponse; import io.swagger.annotations.ApiResponses; import lombok.extern.slf4j.Slf4j; import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.PutMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; import springfox.documentation.annotations.ApiIgnore; import java.util.ArrayList; import java.util.List; /** * 使用swagger,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务 * @Author 211145187 * @Date 2022/9/19 16:31 **/ @RestController @RequestMapping("/swagger") @Api(tags = "用户管理") @Slf4j public class SwaggerController { @GetMapping("/getList") @ApiOperation(value = "分页查询", notes = "分页查询的注意事项和备注", tags = {"说明该方法的作用1,说明该方法的作用2"}) @ApiImplicitParams({ @ApiImplicitParam(name = "pageNo", value = "当前页码,从1开始", paramType = "query", required = true, dataType="int") , @ApiImplicitParam(name = "pageSize", value = "每页显示记录数", paramType = "query",required = true, dataType="int") , }) @ApiResponses({ @ApiResponse(code=400,message="请求参数及格式不对"), @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对") }) public Response<PageResult<User>> getList(@RequestParam int pageNo, @RequestParam int pageSize){ log.info("-getList-pageNo:{},pageSize:{}", pageNo, pageSize); List list = new ArrayList(); list.add(new User(1, "tom", "tom")); list.add(new User(2, "jerry", "jerry")); PageResult pageResult = new PageResult(); pageResult.setPageNum(pageNo); pageResult.setPageSize(pageSize); pageResult.setTotalPage(1); pageResult.setTotalCount(2); pageResult.setList(list); return Response.success(pageResult); } @PostMapping("/post") @ApiOperation(value = "新增用户", notes = "演示json参数是否接受成功") public Response postTest(@ApiParam(name = "user", value = "接收传递给后端接口的user对象参数") @RequestBody User user) { log.info("-postTest-user:{}", user); return Response.success(user); } @PutMapping("/update") @ApiOperation(value = "修改用户", notes = "演示json参数是否接受成功") public Response updateTest(@ApiParam(name = "user", value = "接收传递给后端接口的user对象参数") @RequestBody User user) { log.info("-postTest-user:{}", user); return Response.success(user); } @ApiIgnore @PutMapping("/update2") @ApiOperation(value = "修改用户2", notes = "演示json参数是否接受成功") public Response updateTest2(@ApiParam(name = "user", value = "接收传递给后端接口的user对象参数") @RequestBody User user) { log.info("-postTest-user:{}", user); return Response.success(user); } @DeleteMapping("/delete/{id}") @ApiOperation(value = "删除用户", notes = "演示json参数是否接受成功") public Response deleteTest(@ApiParam(name = "id", value = "接收的参数id") @PathVariable Integer id) { log.info("-deleteTest-id:{}", id); return Response.success(id); } }
6.返回对象Response介绍
SpringBoot ResponseBody返回值处理的实现
7.启动类
package com.swagger; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; /** * 使用swagger,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务 * @Author 211145187 * @Date 2022/9/20 14:33 **/ @SpringBootApplication public class SwaggerApplication { public static void main(String[] args) { SpringApplication.run(SwaggerApplication.class, args); } }
六、运行结果展示
登录网址:http://localhost:8016/swagger-ui/index.html#/ 即可打开如下图的网站
七、注意事项说明
1.@ApiOperation注解的tags属性尽量少用
,因为tags属性会对接口重新分类,导致登录swagger-ui查看接口不清晰,具体如图,比如我只有一个Controller里面包含4个方法,按常理应该只有一个”用户管理“的接口说明,如果我使用tags属性,那么下方会多出一个tags属性标识过的重复的的接口说明(说白了就是有重复的显示,感觉不直观)。
2.SwaggerConfig中无论是Docket属性还是ApiInfoBuilder属性、以及注解中属性都有很多,该案例只使用常用的几个属性,想了解其他属性请查看其他人博客了解即可。
3.Swagger2.x版本中开启Swagger在SpringBoot项目的启动类或配置类中添加@EnableSwagger2
,而Swagger3.0.0版本中开启Swagger在SpringBoot项目的启动类或配置类中添加@EnableOpenApi
4.ApiInfo 基本信息参数介绍
,可以看到,它提供了 8 个
可以配置属性,根据名字也能猜出其中的意思。
- version:API 版本
- title:文档标题
- description:文档描述
- termsOfServiceUrl:团队链接
- license:许可
- licenseUrl:许可链接
- contact:联系人信息
- vendorExtensions:扩展信息
5.问题:
注解@ApiParam和@ApiImplicitParams都是作用在方法上,区别是啥?答案:
他两互相都可以互为替代品,即描述参数用@ApiParam和@ApiImplicitParams都可以,只不过@ApiImplicitParams要和@ApiImplicitParam搭配使用。
八、报错场景说明
错误场景1:org.springframework.context.ApplicationContextException: Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerException
org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:181) ~[spring-context-5.3.15.jar:5.3.15] at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54) ~[spring-context-5.3.15.jar:5.3.15] at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:356) ~[spring-context-5.3.15.jar:5.3.15] at java.lang.Iterable.forEach(Iterable.java:75) ~[na:1.8.0_71] at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:155) ~[spring-context-5.3.15.jar:5.3.15] at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:123) ~[spring-context-5.3.15.jar:5.3.15] at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:935) ~[spring-context-5.3.15.jar:5.3.15] at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:586) ~[spring-context-5.3.15.jar:5.3.15] at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:145) ~[spring-boot-2.6.3.jar:2.6.3] at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:732) [spring-boot-2.6.3.jar:2.6.3] at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:414) [spring-boot-2.6.3.jar:2.6.3] at org.springframework.boot.SpringApplication.run(SpringApplication.java:302) [spring-boot-2.6.3.jar:2.6.3] at org.springframework.boot.SpringApplication.run(SpringApplication.java:1303) [spring-boot-2.6.3.jar:2.6.3] at org.springframework.boot.SpringApplication.run(SpringApplication.java:1292) [spring-boot-2.6.3.jar:2.6.3] at com.swagger.SwaggerApplication.main(SwaggerApplication.java:14) [classes/:na] Caused by: java.lang.NullPointerException: null at springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper.getPatterns(WebMvcPatternsRequestConditionWrapper.java:56) ~[springfox-spring-webmvc-3.0.0.jar:3.0.0] at springfox.documentation.RequestHandler.sortedPaths(RequestHandler.java:113) ~[springfox-core-3.0.0.jar:3.0.0] at springfox.documentation.spi.service.contexts.Orderings.lambda$byPatternsCondition$3(Orderings.java:89) ~[springfox-spi-3.0.0.jar:3.0.0] at java.util.Comparator.lambda$comparing$77a9974f$1(Comparator.java:469) ~[na:1.8.0_71] at java.util.TimSort.countRunAndMakeAscending(TimSort.java:355) ~[na:1.8.0_71] at java.util.TimSort.sort(TimSort.java:220) ~[na:1.8.0_71] at java.util.Arrays.sort(Arrays.java:1512) ~[na:1.8.0_71] at java.util.ArrayList.sort(ArrayList.java:1454) ~[na:1.8.0_71] at java.util.stream.SortedOps$RefSortingSink.end(SortedOps.java:387) ~[na:1.8.0_71] at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[na:1.8.0_71] at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[na:1.8.0_71] at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[na:1.8.0_71] at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[na:1.8.0_71] at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:482) ~[na:1.8.0_71] at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471) ~[na:1.8.0_71] at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:708) ~[na:1.8.0_71] at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) ~[na:1.8.0_71] at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:499) ~[na:1.8.0_71] at springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider.requestHandlers(WebMvcRequestHandlerProvider.java:81) ~[springfox-spring-webmvc-3.0.0.jar:3.0.0] at java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:193) ~[na:1.8.0_71] at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1374) ~[na:1.8.0_71] at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481) ~[na:1.8.0_71] at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471) ~[na:1.8.0_71] at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:708) ~[na:1.8.0_71] at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) ~[na:1.8.0_71] at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:499) ~[na:1.8.0_71] at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.withDefaults(AbstractDocumentationPluginsBootstrapper.java:107) ~[springfox-spring-web-3.0.0.jar:3.0.0] at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.buildContext(AbstractDocumentationPluginsBootstrapper.java:91) ~[springfox-spring-web-3.0.0.jar:3.0.0] at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.bootstrapDocumentationPlugins(AbstractDocumentationPluginsBootstrapper.java:82) ~[springfox-spring-web-3.0.0.jar:3.0.0] at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.start(DocumentationPluginsBootstrapper.java:100) ~[springfox-spring-web-3.0.0.jar:3.0.0] at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:178) ~[spring-context-5.3.15.jar:5.3.15] ... 14 common frames omitted
错误原因:
SpinrgBoot版本过高导致,比如我的SpringBoot版本2.7.3,它使用的Spring版本5.3.22 ,而Spring5.x版本中SpringMVC 默认路径匹配策略从AntPathMatcher 更改为PathPatternParser
解决方案:
针对原因2,解决办法是切换回原先的AntPathMatcher,即在application.yml中配置spring:mvc:pathmatch:matching-strategy: ant_path_matcher
也可以查看其他人的博客了解详情:Docker启动失败报错Failed to start Docker Application Container Engine的解决办法
加载全部内容