快捷導(dǎo)航

SpringSecurity注銷(xiāo)設(shè)置的方法

更新時(shí)間：2022年09月06日 14:23:12 作者：搞錢(qián)自律

這篇文章主要為大家詳細(xì)介紹了SpringSecurity注銷(xiāo)設(shè)置的方法，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

Spring Security中也提供了默認(rèn)的注銷(xiāo)配置，在開(kāi)發(fā)時(shí)也可以按照自己需求對(duì)注銷(xiāo)進(jìn)行個(gè)性化定制

開(kāi)啟注銷(xiāo) 默認(rèn)開(kāi)啟

package com.example.config;

import com.example.handler.MyAuthenticationFailureHandler;
import com.example.handler.MyAuthenticationSuccessHandler;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
public class WebSecurityConfigurer extends WebSecurityConfigurerAdapter {


? ? @Override
? ? public void configure(HttpSecurity http) throws Exception {

? ? ? ? //【注意事項(xiàng)】放行資源要放在前面，認(rèn)證的放在后面
? ? ? ? http.authorizeRequests()
? ? ? ? ? ? ? ? .mvcMatchers("/index").permitAll() //代表放行index的所有請(qǐng)求
? ? ? ? ? ? ? ? .mvcMatchers("/loginHtml").permitAll() //放行l(wèi)oginHtml請(qǐng)求
? ? ? ? ? ? ? ? .anyRequest().authenticated()//代表其他請(qǐng)求需要認(rèn)證
? ? ? ? ? ? ? ? .and()
? ? ? ? ? ? ? ? .formLogin()//表示其他需要認(rèn)證的請(qǐng)求通過(guò)表單認(rèn)證
? ? ? ? ? ? ? ? //loginPage 一旦你自定義了這個(gè)登錄頁(yè)面，那你必須要明確告訴SpringSecurity日后哪個(gè)url處理你的登錄請(qǐng)求
? ? ? ? ? ? ? ? .loginPage("/loginHtml")//用來(lái)指定自定義登錄界面，不使用SpringSecurity默認(rèn)登錄界面 ?注意：一旦自定義登錄頁(yè)面，必須指定登錄url
? ? ? ? ? ? ? ? //loginProcessingUrl ?這個(gè)doLogin請(qǐng)求本身是沒(méi)有的，因?yàn)槲覀冎恍枰鞔_告訴SpringSecurity，日后只要前端發(fā)起的是一個(gè)doLogin這樣的請(qǐng)求，
? ? ? ? ? ? ? ? //那SpringSecurity應(yīng)該把你username和password給捕獲到
? ? ? ? ? ? ? ? .loginProcessingUrl("/doLogin")//指定處理登錄的請(qǐng)求url
? ? ? ? ? ? ? ? .usernameParameter("uname") //指定登錄界面用戶(hù)名文本框的name值，如果沒(méi)有指定，默認(rèn)屬性名必須為username
? ? ? ? ? ? ? ? .passwordParameter("passwd")//指定登錄界面密碼密碼框的name值，如果沒(méi)有指定，默認(rèn)屬性名必須為password
// ? ? ? ? ? ? ? ?.successForwardUrl("/index")//認(rèn)證成功 forward 跳轉(zhuǎn)路徑，forward代表服務(wù)器內(nèi)部的跳轉(zhuǎn)之后，地址欄不變 始終在認(rèn)證成功之后跳轉(zhuǎn)到指定請(qǐng)求
// ? ? ? ? ? ? ? ?.defaultSuccessUrl("/index")//認(rèn)證成功 之后跳轉(zhuǎn)，重定向 redirect 跳轉(zhuǎn)后，地址會(huì)發(fā)生改變 ?根據(jù)上一保存請(qǐng)求進(jìn)行成功跳轉(zhuǎn)
? ? ? ? ? ? ? ? .successHandler(new MyAuthenticationSuccessHandler()) //認(rèn)證成功時(shí)處理 ?前后端分離解決方案
// ? ? ? ? ? ? ? ?.failureForwardUrl("/loginHtml")//認(rèn)證失敗之后 forward 跳轉(zhuǎn)
// ? ? ? ? ? ? ? ?.failureUrl("/login.html")//認(rèn)證失敗之后 ?redirect 跳轉(zhuǎn)
? ? ? ? ? ? ? ? .failureHandler(new MyAuthenticationFailureHandler())//用來(lái)自定義認(rèn)證失敗之后處理 ?前后端分離解決方案
? ? ? ? ? ? ? ? .and()
? ? ? ? ? ? ? ? .logout()
? ? ? ? ? ? ? ? .logoutUrl("/logout") //指定注銷(xiāo)登錄url ?默認(rèn)請(qǐng)求方式必須：GET
? ? ? ? ? ? ? ? .invalidateHttpSession(true) //會(huì)話(huà)失效 默認(rèn)值為true，可不寫(xiě)
? ? ? ? ? ? ? ? .clearAuthentication(true) //清除認(rèn)證標(biāo)記 默認(rèn)值為true，可不寫(xiě)
? ? ? ? ? ? ? ? .logoutSuccessUrl("/loginHtml") //注銷(xiāo)成功之后跳轉(zhuǎn)頁(yè)面
? ? ? ? ? ? ? ? .and()
? ? ? ? ? ? ? ? .csrf().disable(); //禁止csrf 跨站請(qǐng)求保護(hù)
? ? }
}

通過(guò)logout()方法開(kāi)啟注銷(xiāo)配置
logoutUrl指定退出登錄請(qǐng)求地址，默認(rèn)是GET請(qǐng)求，路徑為/logout
invalidateHttpSession 退出時(shí)是否是session失效，默認(rèn)值為true
clearAuthentication 退出時(shí)是否清除認(rèn)證信息，默認(rèn)值為true
logoutSuccessUrl 退出登錄時(shí)跳轉(zhuǎn)地址

測(cè)試

先訪(fǎng)問(wèn)http://localhost:8080/hello，會(huì)自動(dòng)跳轉(zhuǎn)到http://localhost:8080/loginHtml登錄界面，輸入用戶(hù)名和密碼，地址欄會(huì)變化為：http://localhost:8080/doLogin，然后重新訪(fǎng)問(wèn)http://localhost:8080/hello，此時(shí)可以看到hello的數(shù)據(jù)，表示登錄認(rèn)證成功然后訪(fǎng)問(wèn)http://localhost:8080/logout，會(huì)自動(dòng)跳轉(zhuǎn)到http://localhost:8080/loginHtml登錄頁(yè)面，然后在訪(fǎng)問(wèn)http://localhost:8080/hello，發(fā)現(xiàn)會(huì)跳轉(zhuǎn)到http://localhost:8080/loginHtml登錄界面，表示后端認(rèn)定你未登錄了，需要你登錄認(rèn)證

配置多個(gè)注銷(xiāo)登錄請(qǐng)求

如果項(xiàng)目中也有需要，開(kāi)發(fā)者還可以配置多個(gè)注銷(xiāo)登錄的請(qǐng)求，同時(shí)還可以指定請(qǐng)求的方法

新增退出controller

package com.example.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class LogoutController {

? ? @RequestMapping("/logoutHtml")
? ? public String logout(){
? ? ? ? return "logout";
? ? }
}

新增退出界面

logout.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org/" lang="en">
<head>
? ? <meta charset="UTF-8">
? ? <title>注銷(xiāo)</title>
</head>
<body>
? ? <h1>注銷(xiāo)</h1>
? ? <form th:action="@{/bb}" method="post">
? ? ? ? <input type="submit" value="注銷(xiāo)">
? ? </form>
</body>
</html>

修改配置信息

package com.example.config;

import com.example.handler.MyAuthenticationFailureHandler;
import com.example.handler.MyAuthenticationSuccessHandler;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
import org.springframework.security.web.util.matcher.OrRequestMatcher;

@Configuration
public class WebSecurityConfigurer extends WebSecurityConfigurerAdapter {


? ? @Override
? ? public void configure(HttpSecurity http) throws Exception {

? ? ? ? //【注意事項(xiàng)】放行資源要放在前面，認(rèn)證的放在后面
? ? ? ? http.authorizeRequests()
? ? ? ? ? ? ? ? .mvcMatchers("/index").permitAll() //代表放行index的所有請(qǐng)求
? ? ? ? ? ? ? ? .mvcMatchers("/loginHtml").permitAll() //放行l(wèi)oginHtml請(qǐng)求
? ? ? ? ? ? ? ? .anyRequest().authenticated()//代表其他請(qǐng)求需要認(rèn)證
? ? ? ? ? ? ? ? .and()
? ? ? ? ? ? ? ? .formLogin()//表示其他需要認(rèn)證的請(qǐng)求通過(guò)表單認(rèn)證
? ? ? ? ? ? ? ? //loginPage 一旦你自定義了這個(gè)登錄頁(yè)面，那你必須要明確告訴SpringSecurity日后哪個(gè)url處理你的登錄請(qǐng)求
? ? ? ? ? ? ? ? .loginPage("/loginHtml")//用來(lái)指定自定義登錄界面，不使用SpringSecurity默認(rèn)登錄界面 ?注意：一旦自定義登錄頁(yè)面，必須指定登錄url
? ? ? ? ? ? ? ? //loginProcessingUrl ?這個(gè)doLogin請(qǐng)求本身是沒(méi)有的，因?yàn)槲覀冎恍枰鞔_告訴SpringSecurity，日后只要前端發(fā)起的是一個(gè)doLogin這樣的請(qǐng)求，
? ? ? ? ? ? ? ? //那SpringSecurity應(yīng)該把你username和password給捕獲到
? ? ? ? ? ? ? ? .loginProcessingUrl("/doLogin")//指定處理登錄的請(qǐng)求url
? ? ? ? ? ? ? ? .usernameParameter("uname") //指定登錄界面用戶(hù)名文本框的name值，如果沒(méi)有指定，默認(rèn)屬性名必須為username
? ? ? ? ? ? ? ? .passwordParameter("passwd")//指定登錄界面密碼密碼框的name值，如果沒(méi)有指定，默認(rèn)屬性名必須為password
// ? ? ? ? ? ? ? ?.successForwardUrl("/index")//認(rèn)證成功 forward 跳轉(zhuǎn)路徑，forward代表服務(wù)器內(nèi)部的跳轉(zhuǎn)之后，地址欄不變 始終在認(rèn)證成功之后跳轉(zhuǎn)到指定請(qǐng)求
// ? ? ? ? ? ? ? ?.defaultSuccessUrl("/index")//認(rèn)證成功 之后跳轉(zhuǎn)，重定向 redirect 跳轉(zhuǎn)后，地址會(huì)發(fā)生改變 ?根據(jù)上一保存請(qǐng)求進(jìn)行成功跳轉(zhuǎn)
? ? ? ? ? ? ? ? .successHandler(new MyAuthenticationSuccessHandler()) //認(rèn)證成功時(shí)處理 ?前后端分離解決方案
// ? ? ? ? ? ? ? ?.failureForwardUrl("/loginHtml")//認(rèn)證失敗之后 forward 跳轉(zhuǎn)
// ? ? ? ? ? ? ? ?.failureUrl("/login.html")//認(rèn)證失敗之后 ?redirect 跳轉(zhuǎn)
? ? ? ? ? ? ? ? .failureHandler(new MyAuthenticationFailureHandler())//用來(lái)自定義認(rèn)證失敗之后處理 ?前后端分離解決方案
? ? ? ? ? ? ? ? .and()
? ? ? ? ? ? ? ? .logout()
// ? ? ? ? ? ? ? ?.logoutUrl("/logout") //指定注銷(xiāo)登錄url ?默認(rèn)請(qǐng)求方式必須：GET
? ? ? ? ? ? ? ? .logoutRequestMatcher(new OrRequestMatcher(
? ? ? ? ? ? ? ? ? ? ? ? new AntPathRequestMatcher("/aa","GET"),
? ? ? ? ? ? ? ? ? ? ? ? new AntPathRequestMatcher("/bb","POST")
? ? ? ? ? ? ? ? ? ? ? ? )
? ? ? ? ? ? ? ? )
? ? ? ? ? ? ? ? .invalidateHttpSession(true) //會(huì)話(huà)失效 默認(rèn)值為true，可不寫(xiě)
? ? ? ? ? ? ? ? .clearAuthentication(true) //清除認(rèn)證標(biāo)記 默認(rèn)值為true，可不寫(xiě)
? ? ? ? ? ? ? ? .logoutSuccessUrl("/loginHtml") //注銷(xiāo)成功之后跳轉(zhuǎn)頁(yè)面
? ? ? ? ? ? ? ? .and()
? ? ? ? ? ? ? ? .csrf().disable(); //禁止csrf 跨站請(qǐng)求保護(hù)
? ? }
}

測(cè)試

GET /aa 跟上面測(cè)試方法一樣

POST /bb

先訪(fǎng)問(wèn)http://localhost:8080/hello，會(huì)自動(dòng)跳轉(zhuǎn)到http://localhost:8080/loginHtml登錄界面，輸入用戶(hù)名和密碼，地址欄會(huì)變化為：http://localhost:8080/doLogin，然后重新訪(fǎng)問(wèn)http://localhost:8080/hello，此時(shí)可以看到hello的數(shù)據(jù)，表示登錄認(rèn)證成功然后訪(fǎng)問(wèn)http://localhost:8080/logoutHtml，會(huì)跳出注銷(xiāo)頁(yè)面，點(diǎn)擊“注銷(xiāo)”按鈕，會(huì)返回到http://localhost:8080/loginHtml登錄界面，再重新訪(fǎng)問(wèn)http://localhost:8080/hello，發(fā)現(xiàn)會(huì)跳轉(zhuǎn)到http://localhost:8080/loginHtml登錄界面，表示注銷(xiāo)成功，需要重新登錄。

前后端分離注銷(xiāo)配置

如果是前后端分離開(kāi)發(fā)，注銷(xiāo)成功之后就不需要頁(yè)面跳轉(zhuǎn)了，只需要將注銷(xiāo)成功的信息返回前端即可，此時(shí)我們可以通過(guò)自定義LogoutSuccessHandler實(shí)現(xiàn)來(lái)返回內(nèi)容注銷(xiāo)之后信息

添加handler

package com.example.handler;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.security.core.Authentication;
import org.springframework.security.web.authentication.logout.LogoutSuccessHandler;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

/**
?* 自定義注銷(xiāo)成功之后處理
?*/
public class MyLogoutSuccessHandler implements LogoutSuccessHandler {
? ? @Override
? ? public void onLogoutSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException, ServletException {
? ? ? ? Map<String,Object> result = new HashMap<>();
? ? ? ? result.put("msg","注銷(xiāo)成功，當(dāng)前認(rèn)證對(duì)象為："+authentication);
? ? ? ? result.put("status",200);
? ? ? ? result.put("authentication",authentication);
? ? ? ? response.setContentType("application/json;charset=UTF-8");
? ? ? ? String s = new ObjectMapper().writeValueAsString(result);
? ? ? ? response.getWriter().println(s);
? ? }
}

修改配置信息

logoutSuccessHandler

package com.example.config;

import com.example.handler.MyAuthenticationFailureHandler;
import com.example.handler.MyAuthenticationSuccessHandler;
import com.example.handler.MyLogoutSuccessHandler;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
import org.springframework.security.web.util.matcher.OrRequestMatcher;

@Configuration
public class WebSecurityConfigurer extends WebSecurityConfigurerAdapter {


? ? @Override
? ? public void configure(HttpSecurity http) throws Exception {

? ? ? ? //【注意事項(xiàng)】放行資源要放在前面，認(rèn)證的放在后面
? ? ? ? http.authorizeRequests()
? ? ? ? ? ? ? ? .mvcMatchers("/index").permitAll() //代表放行index的所有請(qǐng)求
? ? ? ? ? ? ? ? .mvcMatchers("/loginHtml").permitAll() //放行l(wèi)oginHtml請(qǐng)求
? ? ? ? ? ? ? ? .anyRequest().authenticated()//代表其他請(qǐng)求需要認(rèn)證
? ? ? ? ? ? ? ? .and()
? ? ? ? ? ? ? ? .formLogin()//表示其他需要認(rèn)證的請(qǐng)求通過(guò)表單認(rèn)證
? ? ? ? ? ? ? ? //loginPage 一旦你自定義了這個(gè)登錄頁(yè)面，那你必須要明確告訴SpringSecurity日后哪個(gè)url處理你的登錄請(qǐng)求
? ? ? ? ? ? ? ? .loginPage("/loginHtml")//用來(lái)指定自定義登錄界面，不使用SpringSecurity默認(rèn)登錄界面 ?注意：一旦自定義登錄頁(yè)面，必須指定登錄url
? ? ? ? ? ? ? ? //loginProcessingUrl ?這個(gè)doLogin請(qǐng)求本身是沒(méi)有的，因?yàn)槲覀冎恍枰鞔_告訴SpringSecurity，日后只要前端發(fā)起的是一個(gè)doLogin這樣的請(qǐng)求，
? ? ? ? ? ? ? ? //那SpringSecurity應(yīng)該把你username和password給捕獲到
? ? ? ? ? ? ? ? .loginProcessingUrl("/doLogin")//指定處理登錄的請(qǐng)求url
? ? ? ? ? ? ? ? .usernameParameter("uname") //指定登錄界面用戶(hù)名文本框的name值，如果沒(méi)有指定，默認(rèn)屬性名必須為username
? ? ? ? ? ? ? ? .passwordParameter("passwd")//指定登錄界面密碼密碼框的name值，如果沒(méi)有指定，默認(rèn)屬性名必須為password
// ? ? ? ? ? ? ? ?.successForwardUrl("/index")//認(rèn)證成功 forward 跳轉(zhuǎn)路徑，forward代表服務(wù)器內(nèi)部的跳轉(zhuǎn)之后，地址欄不變 始終在認(rèn)證成功之后跳轉(zhuǎn)到指定請(qǐng)求
// ? ? ? ? ? ? ? ?.defaultSuccessUrl("/index")//認(rèn)證成功 之后跳轉(zhuǎn)，重定向 redirect 跳轉(zhuǎn)后，地址會(huì)發(fā)生改變 ?根據(jù)上一保存請(qǐng)求進(jìn)行成功跳轉(zhuǎn)
? ? ? ? ? ? ? ? .successHandler(new MyAuthenticationSuccessHandler()) //認(rèn)證成功時(shí)處理 ?前后端分離解決方案
// ? ? ? ? ? ? ? ?.failureForwardUrl("/loginHtml")//認(rèn)證失敗之后 forward 跳轉(zhuǎn)
// ? ? ? ? ? ? ? ?.failureUrl("/login.html")//認(rèn)證失敗之后 ?redirect 跳轉(zhuǎn)
? ? ? ? ? ? ? ? .failureHandler(new MyAuthenticationFailureHandler())//用來(lái)自定義認(rèn)證失敗之后處理 ?前后端分離解決方案
? ? ? ? ? ? ? ? .and()
? ? ? ? ? ? ? ? .logout()
// ? ? ? ? ? ? ? ?.logoutUrl("/logout") //指定注銷(xiāo)登錄url ?默認(rèn)請(qǐng)求方式必須：GET
? ? ? ? ? ? ? ? .logoutRequestMatcher(new OrRequestMatcher(
? ? ? ? ? ? ? ? ? ? ? ? new AntPathRequestMatcher("/aa","GET"),
? ? ? ? ? ? ? ? ? ? ? ? new AntPathRequestMatcher("/bb","POST")
? ? ? ? ? ? ? ? ? ? ? ? )
? ? ? ? ? ? ? ? )
? ? ? ? ? ? ? ? .invalidateHttpSession(true) //會(huì)話(huà)失效 默認(rèn)值為true，可不寫(xiě)
? ? ? ? ? ? ? ? .clearAuthentication(true) //清除認(rèn)證標(biāo)記 默認(rèn)值為true，可不寫(xiě)
// ? ? ? ? ? ? ? ?.logoutSuccessUrl("/loginHtml") //注銷(xiāo)成功之后跳轉(zhuǎn)頁(yè)面
? ? ? ? ? ? ? ? .logoutSuccessHandler(new MyLogoutSuccessHandler()) //注銷(xiāo)成功之后處理 ?前后端分離解決方案
? ? ? ? ? ? ? ? .and()
? ? ? ? ? ? ? ? .csrf().disable(); //禁止csrf 跨站請(qǐng)求保護(hù)
? ? }
}

測(cè)試

跟第一個(gè)測(cè)試方法是一樣的