SpringBoot集成Swagger使用SpringSecurity控制訪問權限問題

更新時間：2024年05月22日 10:37:01 作者：π大星的日常

這篇文章主要介紹了SpringBoot集成Swagger使用SpringSecurity控制訪問權限問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

1.加入swagger依賴

這是添加Swagger的Maven依賴配置。

在項目的pom.xml文件中添加以上兩個依賴可以使用Swagger。

其中springfox-swagger2是Swagger API的核心依賴，springfox-swagger-ui是Swagger的UI依賴。

 		 <dependency><!--添加Swagger依賴 -->
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency><!--添加Swagger-UI依賴 -->
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2.編寫swagger配置類

這是一個Swagger配置類，使用了Spring Boot的@Configuration注解，表示這是一個配置類，使用@EnableSwagger2注解啟用Swagger2，然后定義了一個名為customDocket的Bean，返回一個Docket對象，其中設置了apiInfo和select兩個屬性。

apiInfo方法返回一個ApiInfo對象，用于設置文檔說明和版本說明。
select方法返回一個ApiSelectorBuilder對象，設置了掃描的包路徑。

這里設置了掃描com.hu.oneclick.controller包下的所有API接口。

@Configuration //聲明該類為配置類
@EnableSwagger2 //聲明啟動Swagger2
public class SwaggerConfig{
    @Bean
    public Docket customDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.hu.oneclick.controller"))//掃描的包路徑
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("oneclick")//文檔說明
                .version("1.0.0")//文檔版本說明
                .build();
    }
}

3.編寫SpringSecurity配置類

放開swagger訪問資源界面

這段代碼是使用Spring Security來配置安全性，允許Swagger訪問資源界面而不需要進行認證和授權。

其中使用了 http.authorizeRequests() 來控制訪問權限，設置了一些訪問地址不需要進行認證，如 /swagger-ui.html, /v2/**, /swagger-resources/** 等等。

同時，也設置了一些靜態(tài)頭信息，如 Access-Control-Allow-Origin, Access-Control-Expose-Headers 等等。

最后，通過 permissiveRequestUrls() 方法設置了無權限接口。

@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
 
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .antMatchers("/login").anonymous()
                .antMatchers("/user/register").anonymous()
                .antMatchers("/user/sendEmailCode").anonymous()
                .antMatchers("/user/sendEmailRegisterCode").anonymous()
                .antMatchers("/swagger-ui.html").anonymous()
                .antMatchers("/v2/**").anonymous()
                .antMatchers("/swagger-resources/**").anonymous()
                .antMatchers("/webjars/springfox-swagger-ui").anonymous()
                .antMatchers("/webjars/springfox-swagger-ui/**").anonymous()
                .anyRequest().authenticated()
                .and()
                .csrf().disable()
                .formLogin().disable()
                .sessionManagement().disable()
                .cors()
                .and()
                .headers().addHeaderWriter(new StaticHeadersWriter(Arrays.asList(
                new Header("Access-Control-Allow-Origin", "*"),
                new Header("Access-Control-Expose-Headers", "Authorization"))))
                .and()
                .addFilterAfter(new OptionsRequestFilter(), CorsFilter.class)
                .apply(new JsonLoginConfigurer<>()).loginSuccessHandler(jsonLoginSuccessHandler)
                .and()
                .apply(new JwtLoginConfigurer<>()).tokenValidSuccessHandler(jwtRefreshSuccessHandler)
                //設置無權限接口
                .permissiveRequestUrls("/login","/user/register","/user/sendEmailCode",
                        "/user/sendEmailRegisterCode","/swagger-ui.html","/swagger-resources/**",
                        "/v2/**","/webjars/springfox-swagger-ui/**","/webjars/springfox-swagger-ui")
                .and()
                .logout()
                .logoutUrl("/logout")
                .addLogoutHandler(tokenClearLogoutHandler)
                .logoutSuccessHandler(new HttpStatusReturningLogoutSuccessHandler())
                .and()
                .sessionManagement().disable();
    }