SpringBoot+spring Security+JWT整合swagger

SpringBoot+spring Security+JWT整合swagger

  1. 前言

第一次写博客,由于是个菜鸟,感觉怪怪的,只是想把自己所学的记录下。望各位大神进行指点。公司前后端分离。怎么样友好的对接口进行调试。所以最近看资料学习swagger2,swagger2是款强大的接口调试工具。

  1. 整合
    首先需要创建一个swagger2的配置类SwaggerConfig,这个swaggerConfig配置类最好放在启动类同一级目录并去继承WebMvcConfigurationSupport。重写父类的addResourceHandlers方法。这个是固定的。感觉这个有点累赘。可能算是springboot整合swagger2的一个小小劣势点吧,

导入依赖

<dependency>
				<groupId>io.springfox</groupId>
				<artifactId>springfox-swagger2</artifactId>
				<version>2.7.0</version>
			</dependency>
			<dependency>
				<groupId>io.springfox</groupId>
				<artifactId>springfox-swagger-ui</artifactId>
				<version>2.7.0</version>
			</dependency>
			<dependency>
				<groupId>com.google.guava</groupId>
				<artifactId>guava</artifactId>
				<version>18.0</version>
			</dependency>
package com.*.*;

import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import org.springframework.context.annotation.*;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;



@Configuration
@EnableSwagger2
@PropertySources({ @PropertySource(value = "classpath:swagger2.properties", ignoreResourceNotFound = true, encoding = "UTF-8") })
public class SwaggerConfig extends WebMvcConfigurationSupport {

    @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/");

    }

    @Bean
    public Docket createApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(SwaggerConfig.basePackage("com.xx.xxx.xxx.controller,com.xxx.xxx.xxx.controller,com.xxx.xxx.xxx.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目Api接口")
                .version("1.0.0")
                .termsOfServiceUrl("#")
                .description("应用开发平台api接口")
                .build();
    }


    public static Predicate<RequestHandler> basePackage(final String basePackage) {
        return new Predicate<RequestHandler>() {
            @Override
            public boolean apply(RequestHandler input) {
                return declaringClass(input).transform(handlerPackage(basePackage)).or(true);
            }
        };
    }

    /**
     * 处理包路径配置规则,支持多路径扫描匹配以逗号隔开
     *
     * @param basePackage 扫描包路径
     * @return Function
     */
    private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) {
        return new Function<Class<?>, Boolean>() {

            @Override
            public Boolean apply(Class<?> input) {
                for (String strPackage : basePackage.split(",")) {
                    boolean isMatch = input.getPackage().getName().startsWith(strPackage);
                    if (isMatch) {
                        return true;
                    }
                }
                return false;
            }
        };
    }

    /**
     * @param input RequestHandler
     * @return Optional
     */
    private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
        return Optional.fromNullable(input.declaringClass());
    }

}

因为我的controller包不在同一个工程下所以需要进行多包扫描。下面这段代码是对多包扫描的配置

 public static Predicate<RequestHandler> basePackage(final String basePackage) {
        return new Predicate<RequestHandler>() {
            @Override
            public boolean apply(RequestHandler input) {
                return declaringClass(input).transform(handlerPackage(basePackage)).or(true);
            }
        };
    }

    /**
     * 处理包路径配置规则,支持多路径扫描匹配以逗号隔开
     *
     * @param basePackage 扫描包路径
     * @return Function
     */
    private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) {
        return new Function<Class<?>, Boolean>() {

            @Override
            public Boolean apply(Class<?> input) {
                for (String strPackage : basePackage.split(",")) {
                    boolean isMatch = input.getPackage().getName().startsWith(strPackage);
                    if (isMatch) {
                        return true;
                    }
                }
                return false;
            }
        };
    }

    /**
     * @param input RequestHandler
     * @return Optional
     */
    private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
        return Optional.fromNullable(input.declaringClass());
    }

}

下面就是整合权限框架security的部分。在security配置类里面进行swagger-ui的权限放开

@Configuration
@EnableResourceServer
public class ResourceServerConfig extends ResourceServerConfigurerAdapter {

	@Override
	public void configure(HttpSecurity http) throws Exception {
		http.csrf().disable().authorizeRequests()
				.antMatchers(Constant.IGNORE_PATHS.toArray(new
			 String[Constant.IGNORE_PATHS.size()])).permitAll()
				.anyRequest().authenticated();
	}
//下面是Constant常量类的配置
/**
	 * 不拦截的路径
	 */
	public static final List<String> IGNORE_PATHS;
	static {
		IGNORE_PATHS = new ArrayList<>();
		IGNORE_PATHS.add("/v2/api-docs");
		IGNORE_PATHS.add("/swagger-ui.html");
		IGNORE_PATHS.add("/swagger-resources/**");
		IGNORE_PATHS.add("/webjars/**");
	}

整合完成之后的效果
在这里插入图片描述

小弟第一次写博客,请各位大神尽情指点,拜谢了
感谢下面的博主的资料
[1]: https://blog.csdn.net/hu_zhiting/article/details/80462110
[2]: https://blog.csdn.net/weixin_39723544/article/details/81085387?from=timeline

已标记关键词 清除标记
©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页