博客 / 詳情

返回

Spring Security6 全新寫法,大變樣!

@[toc]
Spring Security 在最近幾個版本中配置的寫法都有一些變化,很多常見的方法都廢棄了,並且將在未來的 Spring Security7 中移除,因此鬆哥在去年舊文的基礎之上,又補充了一些新的內容,重新發一下,供各位使用 Spring Security 的小夥伴們參考。

接下來,我把從 Spring Security5.7 開始(對應 Spring Boot2.7 開始),各種已知的變化都來和小夥伴們梳理一下。

1. WebSecurityConfigurerAdapter

首先第一點,就是各位小夥伴最容易發現的 WebSecurityConfigurerAdapter 過期了,在目前最新的 Spring Security6.1 中,這個類已經完全被移除了,想湊合着用都不行了。

準確來説,Spring Security 是在 5.7.0-M2 這個版本中將 WebSecurityConfigurerAdapter 過期的,過期的原因是因為官方想要鼓勵各位開發者使用基於組件的安全配置。

那麼什麼是基於組件的安全配置呢?我們來舉幾個例子:

以前我們配置 SecurityFilterChain 的方式是下面這樣:

@Configuration
public class SecurityConfiguration extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeHttpRequests((authz) -> authz
                .anyRequest().authenticated()
            )
            .httpBasic(withDefaults());
    }

}

那麼以後就要改為下面這樣了:

@Configuration
public class SecurityConfiguration {

    @Bean
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        http
            .authorizeHttpRequests((authz) -> authz
                .anyRequest().authenticated()
            )
            .httpBasic(withDefaults());
        return http.build();
    }

}

如果懂之前的寫法的話,下面這個代碼其實是很好理解的,我就不做過多解釋了,不過還不懂 Spring Security 基本用法的小夥伴,可以在公眾號後台回覆 ss,有鬆哥寫的教程。

以前我們配置 WebSecurity 是這樣:

@Configuration
public class SecurityConfiguration extends WebSecurityConfigurerAdapter {

    @Override
    public void configure(WebSecurity web) {
        web.ignoring().antMatchers("/ignore1", "/ignore2");
    }

}

以後就得改成下面這樣了:

@Configuration
public class SecurityConfiguration {

    @Bean
    public WebSecurityCustomizer webSecurityCustomizer() {
        return (web) -> web.ignoring().antMatchers("/ignore1", "/ignore2");
    }

}

另外還有一個就是關於 AuthenticationManager 的獲取,以前可以通過重寫父類的方法來獲取這個 Bean,類似下面這樣:

@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    @Bean
    public AuthenticationManager authenticationManagerBean() throws Exception {
        return super.authenticationManagerBean();
    }
}

以後就只能自己創建這個 Bean 了,類似下面這樣:

@Configuration
public class SecurityConfig {

    @Autowired
    UserService userService;

    @Bean
    AuthenticationManager authenticationManager() {
        DaoAuthenticationProvider daoAuthenticationProvider = new DaoAuthenticationProvider();
        daoAuthenticationProvider.setUserDetailsService(userService);
        ProviderManager pm = new ProviderManager(daoAuthenticationProvider);
        return pm;
    }
}

當然,也可以從 HttpSecurity 中提取出來 AuthenticationManager,如下:

@Configuration
public class SpringSecurityConfiguration {

    AuthenticationManager authenticationManager;

    @Autowired
    UserDetailsService userDetailsService;

    @Bean
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {

        AuthenticationManagerBuilder authenticationManagerBuilder = http.getSharedObject(AuthenticationManagerBuilder.class);
        authenticationManagerBuilder.userDetailsService(userDetailsService);
        authenticationManager = authenticationManagerBuilder.build();

        http.csrf().disable().cors().disable().authorizeHttpRequests().antMatchers("/api/v1/account/register", "/api/v1/account/auth").permitAll()
            .anyRequest().authenticated()
            .and()
            .authenticationManager(authenticationManager)
            .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS);
        return http.build();
    }

}

這也是一種辦法。

我們來看一個具體的例子。

首先我們新建一個 Spring Boot 工程,引入 Web 和 Spring Security 依賴,注意 Spring Boot 選擇最新版。

接下來我們提供一個簡單的測試接口,如下:

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "hello 江南一點雨!";
    }
}

小夥伴們知道,在 Spring Security 中,默認情況下,只要添加了依賴,我們項目的所有接口就已經被統統保護起來了,現在啓動項目,訪問 /hello 接口,就需要登錄之後才可以訪問,登錄的用户名是 user,密碼則是隨機生成的,在項目的啓動日誌中。

現在我們的第一個需求是使用自定義的用户,而不是系統默認提供的,這個簡單,我們只需要向 Spring 容器中註冊一個 UserDetailsService 的實例即可,像下面這樣:

@Configuration
public class SecurityConfig {

    @Bean
    UserDetailsService userDetailsService() {
        InMemoryUserDetailsManager users = new InMemoryUserDetailsManager();
        users.createUser(User.withUsername("javaboy").password("{noop}123").roles("admin").build());
        users.createUser(User.withUsername("江南一點雨").password("{noop}123").roles("admin").build());
        return users;
    }

}

這就可以了。

當然我現在的用户是存在內存中的,如果你的用户是存在數據庫中,那麼只需要提供 UserDetailsService 接口的實現類並注入 Spring 容器即可,這個之前在 vhr 視頻中講過多次了(公號後台回覆 666 有視頻介紹),這裏就不再贅述了。

但是假如説我希望 /hello 這個接口能夠匿名訪問,並且我希望這個匿名訪問還不經過 Spring Security 過濾器鏈,要是在以前,我們可以重寫 configure(WebSecurity) 方法進行配置,但是現在,得換一種玩法:

@Configuration
public class SecurityConfig {

    @Bean
    UserDetailsService userDetailsService() {
        InMemoryUserDetailsManager users = new InMemoryUserDetailsManager();
        users.createUser(User.withUsername("javaboy").password("{noop}123").roles("admin").build());
        users.createUser(User.withUsername("江南一點雨").password("{noop}123").roles("admin").build());
        return users;
    }

    @Bean
    WebSecurityCustomizer webSecurityCustomizer() {
        return new WebSecurityCustomizer() {
            @Override
            public void customize(WebSecurity web) {
                web.ignoring().antMatchers("/hello");
            }
        };
    }

}

以前位於 configure(WebSecurity) 方法中的內容,現在位於 WebSecurityCustomizer Bean 中,該配置的東西寫在這裏就可以了。

那如果我還希望對登錄頁面,參數等,進行定製呢?繼續往下看:

@Configuration
public class SecurityConfig {

    @Bean
    UserDetailsService userDetailsService() {
        InMemoryUserDetailsManager users = new InMemoryUserDetailsManager();
        users.createUser(User.withUsername("javaboy").password("{noop}123").roles("admin").build());
        users.createUser(User.withUsername("江南一點雨").password("{noop}123").roles("admin").build());
        return users;
    }

    @Bean
    SecurityFilterChain securityFilterChain() {
        List<Filter> filters = new ArrayList<>();
        return new DefaultSecurityFilterChain(new AntPathRequestMatcher("/**"), filters);
    }

}

Spring Security 的底層實際上就是一堆過濾器,所以我們之前在 configure(HttpSecurity) 方法中的配置,實際上就是配置過濾器鏈。現在過濾器鏈的配置,我們通過提供一個 SecurityFilterChain Bean 來配置過濾器鏈,SecurityFilterChain 是一個接口,這個接口只有一個實現類 DefaultSecurityFilterChain,構建 DefaultSecurityFilterChain 的第一個參數是攔截規則,也就是哪些路徑需要攔截,第二個參數則是過濾器鏈,這裏我給了一個空集合,也就是我們的 Spring Security 會攔截下所有的請求,然後在一個空集合中走一圈就結束了,相當於不攔截任何請求。

此時重啓項目,你會發現 /hello 也是可以直接訪問的,就是因為這個路徑不經過任何過濾器。

其實我覺得目前這中新寫法比以前老的寫法更直觀,更容易讓大家理解到 Spring Security 底層的過濾器鏈工作機制。

有小夥伴會説,這寫法跟我以前寫的也不一樣呀!這麼配置,我也不知道 Spring Security 中有哪些過濾器,其實,換一個寫法,我們就可以將這個配置成以前那種樣子:

@Configuration
public class SecurityConfig {

    @Bean
    UserDetailsService userDetailsService() {
        InMemoryUserDetailsManager users = new InMemoryUserDetailsManager();
        users.createUser(User.withUsername("javaboy").password("{noop}123").roles("admin").build());
        users.createUser(User.withUsername("江南一點雨").password("{noop}123").roles("admin").build());
        return users;
    }

    @Bean
    SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .anyRequest().authenticated()
                .and()
                .formLogin()
                .permitAll()
                .and()
                .csrf().disable();
        return http.build();
    }

}

這麼寫,就跟以前的寫法其實沒啥大的差別了。

2. 使用 Lambda

在最新版中,小夥伴們發現,很多常見的方法廢棄了,如下圖:

包括大家熟悉的用來連接各個配置項的 and() 方法現在也廢棄了,並且按照官方的説法,將在 Spring Security7 中徹底移除該方法。

也就是説,你以後見不到類似下面這樣的配置了:

@Override
protected void configure(HttpSecurity http) throws Exception {
    InMemoryUserDetailsManager users = new InMemoryUserDetailsManager();
    users.createUser(User.withUsername("javagirl").password("{noop}123").roles("admin").build());
    http.authorizeRequests()
            .anyRequest().authenticated()
            .and()
            .formLogin()
            .and()
            .csrf().disable()
            .userDetailsService(users);
    http.addFilterAt(loginFilter(), UsernamePasswordAuthenticationFilter.class);
}

and() 方法將被移除!

其實,鬆哥覺得移除 and 方法是個好事,對於很多初學者來説,光是理解 and 這個方法就要好久。

從上面 and 方法的註釋中小夥伴們可以看到,官方現在是在推動基於 Lambda 的配置來代替傳統的鏈式配置,所以以後我們的寫法就得改成下面這樣啦:

@Configuration
public class SecurityConfig {

    @Bean
    SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
        http
                .authorizeHttpRequests(auth -> auth.requestMatchers("/hello").hasAuthority("user").anyRequest().authenticated())
                .formLogin(form -> form.loginProcessingUrl("/login").usernameParameter("name").passwordParameter("passwd"))
                .csrf(csrf -> csrf.disable())
                .sessionManagement(session -> session.maximumSessions(1).maxSessionsPreventsLogin(true));
        return http.build();
    }
}

其實,這裏的幾個方法倒不是啥新方法,只不過有的小夥伴可能之前不太習慣用上面這幾個方法進行配置,習慣於鏈式配置。可是往後,就得慢慢習慣上面這種按照 Lambda 的方式來配置了,配置的內容倒很好理解,我覺得沒啥好解釋的。

3. 自定義 JSON 登錄

自定義 JSON 登錄也和之前舊版不太一樣了。

3.1 自定義 JSON 登錄

小夥伴們知道,Spring Security 中默認的登錄接口數據格式是 key-value 的形式,如果我們想使用 JSON 格式來登錄,那麼就必須自定義過濾器或者自定義登錄接口,下面鬆哥先來和小夥伴們展示一下這兩種不同的登錄形式。

3.1.1 自定義登錄過濾器

Spring Security 默認處理登錄數據的過濾器是 UsernamePasswordAuthenticationFilter,在這個過濾器中,系統會通過 request.getParameter(this.passwordParameter) 的方式將用户名和密碼讀取出來,很明顯這就要求前端傳遞參數的形式是 key-value。

如果想要使用 JSON 格式的參數登錄,那麼就需要從這個地方做文章了,我們自定義的過濾器如下:

public class JsonLoginFilter extends UsernamePasswordAuthenticationFilter {
    @Override
    public Authentication attemptAuthentication(HttpServletRequest request, HttpServletResponse response) throws AuthenticationException {
        //獲取請求頭,據此判斷請求參數類型
        String contentType = request.getContentType();
        if (MediaType.APPLICATION_JSON_VALUE.equalsIgnoreCase(contentType) || MediaType.APPLICATION_JSON_UTF8_VALUE.equalsIgnoreCase(contentType)) {
            //説明請求參數是 JSON
            if (!request.getMethod().equals("POST")) {
                throw new AuthenticationServiceException("Authentication method not supported: " + request.getMethod());
            }
            String username = null;
            String password = null;
            try {
                //解析請求體中的 JSON 參數
                User user = new ObjectMapper().readValue(request.getInputStream(), User.class);
                username = user.getUsername();
                username = (username != null) ? username.trim() : "";
                password = user.getPassword();
                password = (password != null) ? password : "";
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
            //構建登錄令牌
            UsernamePasswordAuthenticationToken authRequest = UsernamePasswordAuthenticationToken.unauthenticated(username,
                    password);
            // Allow subclasses to set the "details" property
            setDetails(request, authRequest);
            //執行真正的登錄操作
            Authentication auth = this.getAuthenticationManager().authenticate(authRequest);
            return auth;
        } else {
            return super.attemptAuthentication(request, response);
        }
    }
}

看過鬆哥之前的 Spring Security 系列文章的小夥伴,這段代碼應該都是非常熟悉了。

  1. 首先我們獲取請求頭,根據請求頭的類型來判斷請求參數的格式。
  2. 如果是 JSON 格式的參數,就在 if 中進行處理,否則説明是 key-value 形式的參數,那麼我們就調用父類的方法進行處理即可。
  3. JSON 格式的參數的處理邏輯和 key-value 的處理邏輯是一致的,唯一不同的是參數的提取方式不同而已。

最後,我們還需要對這個過濾器進行配置:

@Configuration
public class SecurityConfig {

    @Autowired
    UserService userService;

    @Bean
    JsonLoginFilter jsonLoginFilter() {
        JsonLoginFilter filter = new JsonLoginFilter();
        filter.setAuthenticationSuccessHandler((req,resp,auth)->{
            resp.setContentType("application/json;charset=utf-8");
            PrintWriter out = resp.getWriter();
            //獲取當前登錄成功的用户對象
            User user = (User) auth.getPrincipal();
            user.setPassword(null);
            RespBean respBean = RespBean.ok("登錄成功", user);
            out.write(new ObjectMapper().writeValueAsString(respBean));
        });
        filter.setAuthenticationFailureHandler((req,resp,e)->{
            resp.setContentType("application/json;charset=utf-8");
            PrintWriter out = resp.getWriter();
            RespBean respBean = RespBean.error("登錄失敗");
            if (e instanceof BadCredentialsException) {
                respBean.setMessage("用户名或者密碼輸入錯誤,登錄失敗");
            } else if (e instanceof DisabledException) {
                respBean.setMessage("賬户被禁用,登錄失敗");
            } else if (e instanceof CredentialsExpiredException) {
                respBean.setMessage("密碼過期,登錄失敗");
            } else if (e instanceof AccountExpiredException) {
                respBean.setMessage("賬户過期,登錄失敗");
            } else if (e instanceof LockedException) {
                respBean.setMessage("賬户被鎖定,登錄失敗");
            }
            out.write(new ObjectMapper().writeValueAsString(respBean));
        });
        filter.setAuthenticationManager(authenticationManager());
        filter.setFilterProcessesUrl("/login");
        return filter;
    }

    @Bean
    AuthenticationManager authenticationManager() {
        DaoAuthenticationProvider daoAuthenticationProvider = new DaoAuthenticationProvider();
        daoAuthenticationProvider.setUserDetailsService(userService);
        ProviderManager pm = new ProviderManager(daoAuthenticationProvider);
        return pm;
    }

    @Bean
    SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
        //開啓過濾器的配置
        http.authorizeHttpRequests()
                //任意請求,都要認證之後才能訪問
                .anyRequest().authenticated()
                .and()
                //開啓表單登錄,開啓之後,就會自動配置登錄頁面、登錄接口等信息
                .formLogin()
                //和登錄相關的 URL 地址都放行
                .permitAll()
                .and()
                //關閉 csrf 保護機制,本質上就是從 Spring Security 過濾器鏈中移除了 CsrfFilter
                .csrf().disable();
        http.addFilterBefore(jsonLoginFilter(), UsernamePasswordAuthenticationFilter.class);
        return http.build();
    }

}

這裏就是配置一個 JsonLoginFilter 的 Bean,並將之添加到 Spring Security 過濾器鏈中即可。

在 Spring Boot3 之前(Spring Security6 之前),上面這段代碼就可以實現 JSON 登錄了。

但是從 Spring Boot3 開始,這段代碼有點瑕疵了,直接用已經無法實現 JSON 登錄了,具體原因鬆哥下文分析。

3.1.2 自定義登錄接口

另外一種自定義 JSON 登錄的方式是直接自定義登錄接口,如下:

@RestController
public class LoginController {

    @Autowired
    AuthenticationManager authenticationManager;

    @PostMapping("/doLogin")
    public String doLogin(@RequestBody User user) {
        UsernamePasswordAuthenticationToken unauthenticated = UsernamePasswordAuthenticationToken.unauthenticated(user.getUsername(), user.getPassword());
        try {
            Authentication authenticate = authenticationManager.authenticate(unauthenticated);
            SecurityContextHolder.getContext().setAuthentication(authenticate);
            return "success";
        } catch (AuthenticationException e) {
            return "error:" + e.getMessage();
        }
    }
}

這裏直接自定義登錄接口,請求參數通過 JSON 的形式來傳遞。拿到用户名密碼之後,調用 AuthenticationManager#authenticate 方法進行認證即可。認證成功之後,將認證後的用户信息存入到 SecurityContextHolder 中。

最後再配一下登錄接口就行了:

@Configuration
public class SecurityConfig {

    @Autowired
    UserService userService;

    @Bean
    AuthenticationManager authenticationManager() {
        DaoAuthenticationProvider provider = new DaoAuthenticationProvider();
        provider.setUserDetailsService(userService);
        ProviderManager pm = new ProviderManager(provider);
        return pm;
    }

    @Bean
    SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
        http.authorizeHttpRequests()
                //表示 /doLogin 這個地址可以不用登錄直接訪問
                .requestMatchers("/doLogin").permitAll()
                .anyRequest().authenticated().and()
                .formLogin()
                .permitAll()
                .and()
                .csrf().disable();
        return http.build();
    }
}

這也算是一種使用 JSON 格式參數的方案。在 Spring Boot3 之前(Spring Security6 之前),上面這個方案也是沒有任何問題的。

從 Spring Boot3(Spring Security6) 開始,上面這兩種方案都出現了一些瑕疵。

具體表現就是:當你調用登錄接口登錄成功之後,再去訪問系統中的其他頁面,又會跳轉回登錄頁面,説明訪問登錄之外的其他接口時,系統不知道你已經登錄過了。

3.2 原因分析

產生上面問題的原因,主要在於 Spring Security 過濾器鏈中有一個過濾器發生變化了:

在 Spring Boot3 之前,Spring Security 過濾器鏈中有一個名為 SecurityContextPersistenceFilter 的過濾器,這個過濾器在 Spring Boot2.7.x 中廢棄了,但是還在使用,在 Spring Boot3 中則被從 Spring Security 過濾器鏈中移除了,取而代之的是一個名為 SecurityContextHolderFilter 的過濾器。

在第一小節和小夥伴們介紹的兩種 JSON 登錄方案在 Spring Boot2.x 中可以運行在 Spring Boot3.x 中無法運行,就是因為這個過濾器的變化導致的。

所以接下來我們就來分析一下這兩個過濾器到底有哪些區別。

先來看 SecurityContextPersistenceFilter 的核心邏輯:

private void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
        throws IOException, ServletException {
    HttpRequestResponseHolder holder = new HttpRequestResponseHolder(request, response);
    SecurityContext contextBeforeChainExecution = this.repo.loadContext(holder);
    try {
        SecurityContextHolder.setContext(contextBeforeChainExecution);
        chain.doFilter(holder.getRequest(), holder.getResponse());
    }
    finally {
        SecurityContext contextAfterChainExecution = SecurityContextHolder.getContext();
        SecurityContextHolder.clearContext();
        this.repo.saveContext(contextAfterChainExecution, holder.getRequest(), holder.getResponse());
    }
}

我這裏只貼出來了一些關鍵的核心代碼:

  1. 首先,這個過濾器位於整個 Spring Security 過濾器鏈的第三個,是非常靠前的。
  2. 當登錄請求經過這個過濾器的時候,首先會嘗試從 SecurityContextRepository(上文中的 this.repo)中讀取到 SecurityContext 對象,這個對象中保存了當前用户的信息,第一次登錄的時候,這裏實際上讀取不到任何用户信息。
  3. 將讀取到的 SecurityContext 存入到 SecurityContextHolder 中,默認情況下,SecurityContextHolder 中通過 ThreadLocal 來保存 SecurityContext 對象,也就是當前請求在後續的處理流程中,只要在同一個線程裏,都可以直接從 SecurityContextHolder 中提取到當前登錄用户信息。
  4. 請求繼續向後執行。
  5. 在 finally 代碼塊中,當前請求已經結束了,此時再次獲取到 SecurityContext,並清空 SecurityContextHolder 防止內存泄漏,然後調用 this.repo.saveContext 方法保存當前登錄用户對象(實際上是保存到 HttpSession 中)。
  6. 以後其他請求到達的時候,執行前面第 2 步的時候,就讀取到當前用户的信息了,在請求後續的處理過程中,Spring Security 需要知道當前用户的時候,會自動去 SecurityContextHolder 中讀取當前用户信息。

這就是 Spring Security 認證的一個大致流程。

然而,到了 Spring Boot3 之後,這個過濾器被 SecurityContextHolderFilter 取代了,我們來看下 SecurityContextHolderFilter 過濾器的一個關鍵邏輯:

private void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
        throws ServletException, IOException {
    Supplier<SecurityContext> deferredContext = this.securityContextRepository.loadDeferredContext(request);
    try {
        this.securityContextHolderStrategy.setDeferredContext(deferredContext);
        chain.doFilter(request, response);
    }
    finally {
        this.securityContextHolderStrategy.clearContext();
        request.removeAttribute(FILTER_APPLIED);
    }
}

小夥伴們看到,前面的邏輯基本上還是一樣的,不一樣的是 finally 中的代碼,finally 中少了一步向 HttpSession 保存 SecurityContext 的操作。

這下就明白了,用户登錄成功之後,用户信息沒有保存到 HttpSession,導致下一次請求到達的時候,無法從 HttpSession 中讀取到 SecurityContext 存到 SecurityContextHolder 中,在後續的執行過程中,Spring Security 就會認為當前用户沒有登錄。

這就是問題的原因!

找到原因,那麼問題就好解決了。

3.3 問題解決

首先問題出在了過濾器上,直接改過濾器倒也不是不可以,但是,既然 Spring Security 在升級的過程中拋棄了之前舊的方案,我們又費勁的把之前舊的方案寫回來,好像也不合理。

其實,Spring Security 提供了另外一個修改的入口,在 org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter#successfulAuthentication 方法中,源碼如下:

protected void successfulAuthentication(HttpServletRequest request, HttpServletResponse response, FilterChain chain,
        Authentication authResult) throws IOException, ServletException {
    SecurityContext context = this.securityContextHolderStrategy.createEmptyContext();
    context.setAuthentication(authResult);
    this.securityContextHolderStrategy.setContext(context);
    this.securityContextRepository.saveContext(context, request, response);
    this.rememberMeServices.loginSuccess(request, response, authResult);
    if (this.eventPublisher != null) {
        this.eventPublisher.publishEvent(new InteractiveAuthenticationSuccessEvent(authResult, this.getClass()));
    }
    this.successHandler.onAuthenticationSuccess(request, response, authResult);
}

這個方法是當前用户登錄成功之後的回調方法,小夥伴們看到,在這個回調方法中,有一句 this.securityContextRepository.saveContext(context, request, response);,這就表示將當前登錄成功的用户信息存入到 HttpSession 中。

在當前過濾器中,securityContextRepository 的類型是 RequestAttributeSecurityContextRepository,這個表示將 SecurityContext 存入到當前請求的屬性中,那很明顯,在當前請求結束之後,這個數據就沒了。在 Spring Security 的自動化配置類中,將 securityContextRepository 屬性指向了 DelegatingSecurityContextRepository,這是一個代理的存儲器,代理的對象是 RequestAttributeSecurityContextRepository 和 HttpSessionSecurityContextRepository,所以在默認的情況下,用户登錄成功之後,在這裏就把登錄用户數據存入到 HttpSessionSecurityContextRepository 中了。

當我們自定義了登錄過濾器之後,就破壞了自動化配置裏的方案了,這裏使用的 securityContextRepository 對象就真的是 RequestAttributeSecurityContextRepository 了,所以就導致用户後續訪問時系統以為用户未登錄。

那麼解決方案很簡單,我們只需要為自定義的過濾器指定 securityContextRepository 屬性的值就可以了,如下:

@Bean
JsonLoginFilter jsonLoginFilter() {
    JsonLoginFilter filter = new JsonLoginFilter();
    filter.setAuthenticationSuccessHandler((req,resp,auth)->{
        resp.setContentType("application/json;charset=utf-8");
        PrintWriter out = resp.getWriter();
        //獲取當前登錄成功的用户對象
        User user = (User) auth.getPrincipal();
          user.setPassword(null);
        RespBean respBean = RespBean.ok("登錄成功", user);
        out.write(new ObjectMapper().writeValueAsString(respBean));
    });
    filter.setAuthenticationFailureHandler((req,resp,e)->{
        resp.setContentType("application/json;charset=utf-8");
        PrintWriter out = resp.getWriter();
        RespBean respBean = RespBean.error("登錄失敗");
        if (e instanceof BadCredentialsException) {
            respBean.setMessage("用户名或者密碼輸入錯誤,登錄失敗");
        } else if (e instanceof DisabledException) {
            respBean.setMessage("賬户被禁用,登錄失敗");
        } else if (e instanceof CredentialsExpiredException) {
            respBean.setMessage("密碼過期,登錄失敗");
        } else if (e instanceof AccountExpiredException) {
            respBean.setMessage("賬户過期,登錄失敗");
        } else if (e instanceof LockedException) {
            respBean.setMessage("賬户被鎖定,登錄失敗");
        }
        out.write(new ObjectMapper().writeValueAsString(respBean));
    });
    filter.setAuthenticationManager(authenticationManager());
    filter.setFilterProcessesUrl("/login");
    filter.setSecurityContextRepository(new HttpSessionSecurityContextRepository());
    return filter;
}

小夥伴們看到,最後調用 setSecurityContextRepository 方法設置一下就行。

Spring Boot3.x 之前之所以不用設置這個屬性,是因為這裏雖然沒保存最後還是在 SecurityContextPersistenceFilter 過濾器中保存了。

那麼對於自定義登錄接口的問題,解決思路也是類似的:

@RestController
public class LoginController {

    @Autowired
    AuthenticationManager authenticationManager;

    @PostMapping("/doLogin")
    public String doLogin(@RequestBody User user, HttpSession session) {
        UsernamePasswordAuthenticationToken unauthenticated = UsernamePasswordAuthenticationToken.unauthenticated(user.getUsername(), user.getPassword());
        try {
            Authentication authenticate = authenticationManager.authenticate(unauthenticated);
            SecurityContextHolder.getContext().setAuthentication(authenticate);
            session.setAttribute(HttpSessionSecurityContextRepository.SPRING_SECURITY_CONTEXT_KEY, SecurityContextHolder.getContext());
            return "success";
        } catch (AuthenticationException e) {
            return "error:" + e.getMessage();
        }
    }
}

小夥伴們看到,在登錄成功之後,開發者自己手動將數據存入到 HttpSession 中,這樣就能確保下個請求到達的時候,能夠從 HttpSession 中讀取到有效的數據存入到 SecurityContextHolder 中了。

好啦,Spring Boot 新舊版本交替中,一個小小的問題,希望小夥伴們能夠有所收穫。

user avatar
0 位用戶收藏了這個故事!

發佈 評論

Some HTML is okay.