首頁 > 軟體

解決springboot整合swagger碰到的坑(報404)

2021-06-11 16:01:11

一:專案使用springboot整合swagger進行偵錯

設定swagger非常簡單,主要有三步:

1、新增swagger依賴

<!-- 引入 swagger等相關依賴 -->
<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-swagger2</artifactId>
 <version>2.6.1</version>
</dependency>
<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-swagger-ui</artifactId>
 <version>2.6.1</version>
</dependency>

2、進行swagger的設定

package com.sailing.springbootmybatis.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.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
/**
 * @author baibing
 * @project: springboot-mybatis
 * @package: com.sailing.springbootmybatis.config
 * @Description: swagger2設定類
 * @date 2018/9/25 15:35
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sailing.springbootmybatis.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("SPRING-BOOT整合MYBATIS--API說明檔案")
                .description("2018-8完成版本")
                .contact("Sailing西安研發中心-baibing")
                .version("1.0")
                .license("署名-非商用-相同方式共用 4.0轉載請保留原文連結及作者")
                .licenseUrl("https://creativecommons.org/licenses/by-nc-sa/4.0/")
                .build();
    }
}

3、在controller層新增相應的註解(@Api 和 @ApiOperation 以及 @ApiIgnore 等)

package com.sailing.springbootmybatis.controller;
import com.sailing.springbootmybatis.bean.Userinfo;
import com.sailing.springbootmybatis.common.log.LogOperationEnum;
import com.sailing.springbootmybatis.common.log.annotation.MyLog;
import com.sailing.springbootmybatis.common.response.BuildResponseUtil;
import com.sailing.springbootmybatis.common.response.ResponseData;
import com.sailing.springbootmybatis.common.websocket.WebSocketServer;
import com.sailing.springbootmybatis.service.RedisService;
import com.sailing.springbootmybatis.service.UserinfoService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;
import javax.validation.Valid;
import java.io.IOException;
import java.util.List;
 
/**
 * @author baibing
 * @project: springboot-mybatis
 * @package: com.sailing.springbootmybatis.controller
 * @Description: Userinfo controller 控制層
 * @date 2018/9/12 10:07
 */
@RestController
@Api(value = "USERINFO", description = "使用者資訊測試controller")
public class UserinfoController{
    @Autowired
    private UserinfoService userinfoService;
    @Autowired
    private WebSocketServer webSocketServer;
    @Autowired
    private RedisService redisService;
    /**
     * 查詢指定id對應的使用者
     * @param id
     * @return
     */
    @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
    @MyLog(type = LogOperationEnum.SELECT,value = "查詢指定id的使用者資訊")
    @ApiOperation(value = "查詢指定id的使用者資訊介面", notes = "查詢指定id的使用者資訊介面")
    public ResponseData getUser(@PathVariable(value = "id") Integer id){
        return userinfoService.findById(id);
    }
    /**
     * 查詢所有使用者
     * @return
     */
    @RequestMapping(value = "/users", method = RequestMethod.GET)
    @MyLog(type = LogOperationEnum.SELECT,value = "查詢全部使用者資訊")
    @ApiOperation(value = "查詢所有使用者資訊介面", notes = "查詢所有使用者資訊介面")
    public ResponseData getAllUsers(){
        return userinfoService.findAllUsers();
    }
 
    /**
     * 查詢所有使用者(帶分頁)
     * @param page 當前頁數
     * @param rows 每頁顯示條數
     * @return
     */
    @RequestMapping(value = "/users/p", method = RequestMethod.GET)
    @ApiOperation(value = "查詢所有使用者資訊介面(帶分頁)", notes = "查詢所有使用者資訊介面(帶分頁)")
    public ResponseData getAllUsers(Integer page, Integer rows){
        return userinfoService.findAllUsers(page, rows);
    }
 
    /**
     * 新增使用者 (帶引數校驗@Valid)
     * 注意:BindingResult 物件必須在 @Valid 的緊挨著的後面,否則接收不到錯誤資訊
     * @Valid 可以校驗json 也可以校驗表單傳遞的物件屬性
     * @param userinfo
     * @return
     */
    @RequestMapping(value = "/user", method = RequestMethod.POST)
    @MyLog(type = LogOperationEnum.INSERT, value = "新增使用者資訊")
    @ApiOperation(value = "新增使用者介面(包含引數校驗)", notes = "新增使用者介面(包含引數校驗)")
    public ResponseData saveUserinfo(@RequestBody @Valid Userinfo userinfo, BindingResult bindingResult){
        if(bindingResult.hasErrors()){
            return BuildResponseUtil.buildFailResponse(bindingResult.getFieldError().getDefaultMessage());
        }
        return userinfoService.saveUser(userinfo);
    }
 
    /**
     * 刪除指定使用者
     * @param id 使用者id
     * @return
     */
    @RequestMapping(value = "/user/{id}", method = RequestMethod.DELETE)
    @ApiOperation(value = "刪除指定id的使用者資訊介面", notes = "刪除指定id的使用者資訊介面")
    public ResponseData deleteUser(@PathVariable Integer id){
        return userinfoService.deleteUser(id);
    }
 
    /**
     * 更新使用者
     * @param userinfo
     * @return
     */
    @RequestMapping(value = "/user", method = RequestMethod.PUT)
    @ApiOperation(value = "更新指定id使用者資訊介面", notes = "更新指定id使用者資訊介面")
    public ResponseData updateUserinfo(@RequestBody Userinfo userinfo){
        return userinfoService.updateUser(userinfo);
    }
 
    /**
     * 給指定使用者推播訊息
     * @param userName 使用者名稱
     * @param message 訊息
     * @throws IOException
     */
    @RequestMapping(value = "/socket", method = RequestMethod.GET)
    @ApiIgnore //使用此註解忽略方法的暴露,也可以用在controller上
    @ApiOperation(value = "給指定使用者推播socket訊息介面", notes = "給指定使用者推播socket訊息介面")
    public void testSocket(@RequestParam String userName,@RequestParam String message){
        webSocketServer.sendInfo(userName, message);
    }
 
    /**
     * 測試redis介面儲存String型別action
     * @param address
     * @return
     */
    @RequestMapping(value = "/redis", method = RequestMethod.POST)
    @ApiIgnore //使用此註解忽略方法的暴露,也可以用在controller上
    @ApiOperation(value = "redis中新增String資料介面", notes = "redis中新增String資料介面")
    public ResponseData setString(@RequestBody String address){
        System.out.println(address);
        return redisService.setValue(address);
    }
 
    /**
     * 測試redis介面儲存實體型別action
     * @param userinfo
     * @return
     */
    @RequestMapping(value = "/redis/userinfo", method = RequestMethod.POST)
    @ApiIgnore //使用此註解忽略方法的暴露,也可以用在controller上
    @ApiOperation(value = "redis中新增Userinfo實體介面", notes = "redis中新增Userinfo實體介面")
    public ResponseData setEntity(@RequestBody Userinfo userinfo){
        return redisService.setEntityValue(userinfo);
    }
    /**
     * 測試redis介面讀取實體型別action
     * @param key
     * @return
     */
    @RequestMapping(value = "/redis/userinfo/{key}", method = RequestMethod.GET)
    @ApiIgnore //使用此註解忽略方法的暴露,也可以用在controller上
    @ApiOperation(value = "redis中讀取指定key對應的資料介面", notes = "redis中讀取指定key對應的資料介面")
    public ResponseData getEntity(@PathVariable String key){
        return redisService.getEntityValue(key);
    }
 
    /**
     *
     * @param list
     * @return
     */
    @RequestMapping(value = "/redis/userList", method = RequestMethod.POST)
    @ApiIgnore //使用此註解忽略方法的暴露,也可以用在controller上
    @ApiOperation(value = "redis中新增包含Userinfo實體的集合介面", notes = "redis中新增包含Userinfo實體的集合介面")
    public ResponseData setCollection(@RequestBody List<Userinfo> list){
        return redisService.setCollectionValue(list);
    }
 
    /**
     * 測試redis介面讀取實體型別action
     * @param key
     * @return
     */
    @RequestMapping(value = "/redis/userList/{key}", method = RequestMethod.GET)
    @ApiOperation(value = "redis中讀取指定key對應的集合資料介面", notes = "redis中讀取指定key對應的集合資料介面")
    public ResponseData getCollection(@PathVariable String key){
        return redisService.getCollectionValue(key);
    }
}

二:到這裡設定就結束了

存取 http://127.0.0.1:埠/專案路徑/swagger-ui.html 就ok了, 頁面如下:

swagger-ui介面展示

三:專案執行了一段時間後存取上面連線突然報 404 錯誤

百思不得其解,但是可以肯定的是加了什麼設定導致,最後在application.yml 中發現了一個設定:

spring.mvv.resources.add-mapping:false

將其註釋掉熟悉的介面又回來了,查閱資料發現這個設定是不自動給靜態資源新增路徑,導致swagger-ui.html找不到資源,知道原因後摸索看能不能在保留以上設定的前提下自己手動給swagger-ui.html新增靜態資源路徑呢?

package com.sailing.springbootmybatis.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 
/**
 * 在SpringBoot2.0及Spring 5.0 WebMvcConfigurerAdapter已被廢棄,目前找到解決方案就有
 * 1 直接實現WebMvcConfigurer (官方推薦)
 * 2 直接繼承WebMvcConfigurationSupport
 * @ https://blog.csdn.net/lenkvin/article/details/79482205
 */
@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

發現通過以上程式碼手動給swagger-ui.html指定路徑也可以解決404的問題。

Springboot整合Swagger遇到無限死迴圈

解決方法

1.萬能辦法,重啟,我自己用好使

2.同事說的方法,因重啟無效,斷網一會

3.修改埠號,目前一直用的

以上為個人經驗,希望能給大家一個參考,也希望大家多多支援it145.com。


IT145.com E-mail:sddin#qq.com