解决添加上@RequiresPermissions权限注解后无法访问接口，swagger读取不到的问题

逃离我推掉我的手 2024-03-16 19:20 70阅读 0赞

**目录**

一、先搭建 Swagger

1、添加依赖库

2、创建Swagger配置类

3、配置yml

4、编写测试Web接口

5、测试Web接口

二、解决问题

1、出现的问题

2、解决问题

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

## 一、先搭建 Swagger ##

开发前后端分离架构的项目，往往调试后端Web接口需要用到POSTMAN工具。虽然POSTMAN  
工具的功能非常强大，但是请求参数很多的情况下，我们手写这些参数和数据还是非常麻烦的。  
因此我们需要一个调试后端Web接口更加简便的方法。恰好Swagger提供了REST API调用方  
式，我们不需要借助任何工具的情况下，访问Swagger页面，就可以对Web接口进行调用和调  
试，这种调试方式的效率要远超POSTMAN软件。

### 1、添加依赖库 ###

在 pom.xml 文件中添加Swagger依赖库，这里我们使用的是Swagger2版本，在UI方面，比  
Swagger1版本要好看很多。

<dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.9.2</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.9.2</version>
            </dependency>

### 2、创建Swagger配置类 ###

package com.buba.wechatmini.common.utils;
    
    /**
     * @author qlx
     */
    
    import io.swagger.annotations.ApiOperation;
    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.service.ApiKey;
    import springfox.documentation.service.AuthorizationScope;
    import springfox.documentation.service.SecurityReference;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spi.service.contexts.SecurityContext;
    import springfox.documentation.spring.web.plugins.ApiSelectorBuilder;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    import java.util.ArrayList;
    import java.util.List;
    
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        @Bean
        public Docket createRestApi() {
            Docket docket = new Docket(DocumentationType.SWAGGER_2);
            // ApiInfoBuilder 用于在Swagger界面上添加各种信息
            ApiInfoBuilder builder = new ApiInfoBuilder();
            builder.title("BUBA在线办公系统");
            ApiInfo apiInfo = builder.build();
            docket.apiInfo(apiInfo);
            // ApiSelectorBuilder 用来设置哪些类中的方法会生成到REST API中
            ApiSelectorBuilder selectorBuilder = docket.select();
            selectorBuilder.paths(PathSelectors.any()); //所有包下的类
            //使用@ApiOperation的方法会被提取到REST API中
            selectorBuilder.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class));
            docket = selectorBuilder.build();
            /*
             * 下面的语句是开启对JWT的支持，当用户用Swagger调用受JWT认证保护的方法，
             * 必须要先提交参数（例如令牌）
             */
            //存储用户必须提交的参数
            List<ApiKey> apikey = new ArrayList();
            //规定用户需要输入什么参数
            apikey.add(new ApiKey("token", "token", "header"));
            docket.securitySchemes(apikey);
            //如果用户JWT认证通过，则在Swagger中全局有效
            AuthorizationScope scope = new AuthorizationScope("global", "accessEverything");
            AuthorizationScope[] scopeArray = {scope};
            //存储令牌和作用域
            SecurityReference reference = new SecurityReference("token", scopeArray);
            List refList = new ArrayList();
            refList.add(reference);
            SecurityContext context =
                    SecurityContext.builder().securityReferences(refList).build();
            List cxtList = new ArrayList();
            cxtList.add(context);
            docket.securityContexts(cxtList);
            return docket;
        }
    }

### 3、配置yml ###

Springboot2.6以后将SpringMVC 默认路径匹配策略从AntPathMatcher 更改为PathPatternParser，导致出错如下：  
`ERROR Application run failed org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException`

解决上述问题需要application.yml配置如下

spring:
      mvc:
        pathmatch:
          matching-strategy: ant_path_matcher

### 4、编写测试Web接口 ###

package com.buba.wechatmini.controller;
    
    import com.buba.wechatmini.common.utils.JwtUtil;
    import com.buba.wechatmini.common.utils.Result;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.io.UnsupportedEncodingException;
    import java.util.HashMap;
    import java.util.Map;
    
    /**
     * @author qlx
     */
    @RestController
    @RequestMapping("/test")
    @Api("测试Web接口")
    public class TestController {
    
        @Autowired
        private JwtUtil jwtUtil;
    
        @ApiOperation("最简单的测试方法")
        @GetMapping("/get1")
        public Result get1(){
            Map map = new HashMap();
            map.put("msa","aaaaaaa");
            return Result.ok(map);
        }
        @RequestMapping(value = "/getToken",method = RequestMethod.OPTIONS)
        public Result getToken() throws UnsupportedEncodingException {
            Map map = new HashMap();
            map.put("token",jwtUtil.createToken(123));
            return Result.ok(map);
        }
    }

### 5、测试Web接口 ###

浏览器访问地址：`http://127.0.0.1:8080/swagger-ui.html`  
![在这里插入图片描述][843230cc2e20431aa28a111a60a54d90.png]

## 二、解决问题 ##

### 1、出现的问题 ###

**我如果添加上权限注解，会是什么效果呢？**

![c2d2ec9dc7764e0fabec785fe62ae78c.png][]

**执行项目，访问swagger,发现没有访问接口了，读取不到了，那么问题就出现了**

![e55f96ae5e6642228fab67b955e4b9e5.png][]

### 2、解决问题 ###

在swagger配置类中添加以下

package com.WeChatMiNi.yka.config.swagger;
    
    /**
     * @author qlx
     */
    
    import io.swagger.annotations.ApiOperation;
    import org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator;
    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.service.ApiKey;
    import springfox.documentation.service.AuthorizationScope;
    import springfox.documentation.service.SecurityReference;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spi.service.contexts.SecurityContext;
    import springfox.documentation.spring.web.plugins.ApiSelectorBuilder;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * Swagger配置类
     */
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        @Bean
        public Docket createRestApi() {
            Docket docket = new Docket(DocumentationType.SWAGGER_2);
            // ApiInfoBuilder 用于在Swagger界面上添加各种信息
            ApiInfoBuilder builder = new ApiInfoBuilder();
            builder.title("BUBA在线办公系统");
            ApiInfo apiInfo = builder.build();
            docket.apiInfo(apiInfo);
            // ApiSelectorBuilder 用来设置哪些类中的方法会生成到REST API中
            ApiSelectorBuilder selectorBuilder = docket.select();
            selectorBuilder.paths(PathSelectors.any()); //所有包下的类
            //使用@ApiOperation的方法会被提取到REST API中
            selectorBuilder.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class));
            docket = selectorBuilder.build();
            /*
             * 下面的语句是开启对JWT的支持，当用户用Swagger调用受JWT认证保护的方法，
             * 必须要先提交参数（例如令牌）
             */
            //存储用户必须提交的参数
            List<ApiKey> apikey = new ArrayList();
            //规定用户需要输入什么参数
            apikey.add(new ApiKey("token", "token", "header"));
            docket.securitySchemes(apikey);
            //如果用户JWT认证通过，则在Swagger中全局有效
            AuthorizationScope scope = new AuthorizationScope("global", "accessEverything");
            AuthorizationScope[] scopeArray = {scope};
            //存储令牌和作用域
            SecurityReference reference = new SecurityReference("token", scopeArray);
            List refList = new ArrayList();
            refList.add(reference);
            SecurityContext context =
                    SecurityContext.builder().securityReferences(refList).build();
            List cxtList = new ArrayList();
            cxtList.add(context);
            docket.securityContexts(cxtList);
            return docket;
        }
    
        /**
         * 解决添加上@RequiresPermissions注解后无法访问接口，swagger读取不到的问题
         * @return
         */
        @Bean
        public DefaultAdvisorAutoProxyCreator defaultAdvisorAutoProxyCreator() {
            DefaultAdvisorAutoProxyCreator defaultAdvisorAutoProxyCreator =
                    new DefaultAdvisorAutoProxyCreator();
            defaultAdvisorAutoProxyCreator.setUsePrefix(true);
    
            return defaultAdvisorAutoProxyCreator;
        }
    }

**重启项目，再次访问，访问成功**

![13bac9407ba24f90be6ad0a8b96bf301.png][]

[843230cc2e20431aa28a111a60a54d90.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/b13da3d968da4a9cba6898530d16d1f7.png
[c2d2ec9dc7764e0fabec785fe62ae78c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5509a69c6180451c847b8c7cf47b611a.png
[e55f96ae5e6642228fab67b955e4b9e5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/607cb84f395b4a60abe3b6cee12fdb40.png
[13bac9407ba24f90be6ad0a8b96bf301.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/74394842d84e4d879db55a90813d0e69.png