SpringBoot集成Swagger实现JWT验证token

前言

最近有个项目涉及用户权限管理，然后之前也有看到的一个小技术JWT，简单学习了解以后结合SpringBoot Swagger实现了一个简单的demo，这个demo主要是实现用户通过用户名和密码登录系统，登录成功以后系统给一个token，之后的用户操作需要验证token，只有token符合要求才能进行其他系统资源访问操作，否则提示权限不够或者token过期有误等提示信息，现将实现过程进行简单记录。

参考链接

1. Swagger了解：https://www.jianshu.com/p/349e130e40d5

2. SpringBoot集成Swagger：https://www.jianshu.com/p/be1e772b089a

3. JWT了解：https://www.cnblogs.com/wangshouchang/p/9551748.html

4. SpringBoot实现JWT：https://blog.csdn.net/cf535261933/article/details/102603490

5. SpringBoot拦截器实现：https://blog.csdn.net/qq_30745307/article/details/80974407

实现过程

1. SpringBoot集成Swagger

1.1 导入依赖

 <!-- swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>

        <!-- swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

1.2 配置Swagger（SwaggerConfiguration）

@Configuration //SpringBoot中配置类不可少此注释
@EnableSwagger2
public class SwaggerConfiguration {
    /**
     * 注册Bean实体
     * @return
     */
    @Bean
    public Docket createRestApi(){

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //当前包名
                .apis(RequestHandlerSelectors.basePackage("com.practice.tokendemo"))
                .paths(PathSelectors.any())
                .build()
                //Lists工具类的newArrayList方法将对象转为ArrayList
                .securitySchemes(Lists.newArrayList(apiKey()));//结果是Swagger-ui上出现Authorize，可以手动点击输入token
    }

    /**
     * 构建Authorization验证key
     * @return
     */
    private ApiKey apiKey() {
        return new ApiKey(Constant.TOKEN_HEADER_STRING,Constant.TOKEN_HEADER_STRING,"header");//配置输入token的备注 TOKEN_HEADER_STRING = "Authorization"
    }

    /**
     * 构建API文档的详细信息方法
     * @return
     */
    public ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                //API页面标题
                .title("Spring Boot继承Swagger2实现JWT")
                //创建者
                .contact(new Contact("ciery","https://mp.csdn.net/console/article",""))
                //版本
                .version("1.0")
                //描述
                .description("API描述")
                .build();
    }
}

1.3 Swagger简单介绍

Swagger UI提供了一个可视化的UI页面展示描述文件。接口的调用方、测试、项目经理等都可以在该页面中对相关接口进行查阅和做一些简单的接口请求。该项目支持在线导入描述文件和本地部署UI项目。

Springfox-swagger可以通过扫描代码去生成swagger定义的描述文件（通过维护这个描述文件可以去更新接口文档），所有的信息都在代码中。代码即接口文档，接口文档即代码。

2. 基本功能的实现（用户登录）

写法和普通的controller层一致，只不过多了API的注释完成与swagger的集成。

@Api("用户操作接口") //配置swagger页面api名称
//@Controller("user") //如果controller中有多个方法ResponseMapping，那么直接使用@RestController注释，底下的所有方法都不需要再加@ReponseMapping注释，直接使用@XXXMapping表明获取参数的方式（PUT/GET/POST&