企業分布式微服務雲SpringCloud SpringBoot mybatis (六)Spring Boot中使用Spring Security進行安全控制
準備工作
首先,構建一個簡單的Web工程,以用於後續添加安全控制,也可以用之前Chapter3-1-2做為基礎工程。若對如何使用Spring Boot構建Web應用,可以先閱讀《Spring Boot開發Web應用》一文。
Web層實現請求映射
@Controller public class HelloController { @RequestMapping("/") public String index() { return "index"; } @RequestMapping("/hello") public String hello() { return "hello"; } }
/
:映射到index.html/hello
:映射到hello.html
實現映射的頁面
- src/main/resources/templates/index.html
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org" xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity3"> <head> <title>Spring Security入門</title> </head> <body> <h1>歡迎使用Spring Security!</h1> <p>點擊 <a th:href="@{/hello}">這裏</a> 打個招呼吧</p> </body> </html>
- src/main/resources/templates/hello.html
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org" xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity3"> <head> <title>Hello World!</title> </head> <body> <h1>Hello world!</h1> </body> </html>
可以看到在index.html中提供到
/hello
的鏈接,顯然在這裏沒有任何安全控制,所以點擊鏈接後就可以直接跳轉到hello.html頁面。整合Spring Security
在這一節,我們將對
/hello
頁面進行權限控制,必須是授權用戶才能訪問。當沒有權限的用戶訪問後,跳轉到登錄頁面。添加依賴
在pom.xml中添加如下配置,引入對Spring Security的依賴。
<dependencies> ... <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency> ... </dependencies>
Spring Security配置
創建Spring Security的配置類
WebSecurityConfig
,具體如下:@Configuration @EnableWebSecurity public class WebSecurityConfig extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { http .authorizeRequests() .antMatchers("/", "/home").permitAll() .anyRequest().authenticated() .and() .formLogin() .loginPage("/login") .permitAll() .and() .logout() .permitAll(); } @Autowired public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception { auth .inMemoryAuthentication() .withUser("user").password("password").roles("USER"); } }
- 通過
@EnableWebSecurity
註解開啟Spring Security的功能 - 繼承
WebSecurityConfigurerAdapter
,並重寫它的方法來設置一些web安全的細節 configure(HttpSecurity http)
方法- 通過
authorizeRequests()
定義哪些URL需要被保護、哪些不需要被保護。例如以上代碼指定了/
和/home
不需要任何認證就可以訪問,其他的路徑都必須通過身份驗證。 - 通過
formLogin()
定義當需要用戶登錄時候,轉到的登錄頁面。
- 通過
configureGlobal(AuthenticationManagerBuilder auth)
方法,在內存中創建了一個用戶,該用戶的名稱為user,密碼為password,用戶角色為USER。-
新增登錄請求與頁面
在完成了Spring Security配置之後,我們還缺少登錄的相關內容。
HelloController中新增
/login
請求映射至login.html
@Controller public class HelloController { // 省略之前的內容... @RequestMapping("/login") public String login() { return "login"; } }
新增登錄頁面:src/main/resources/templates/login.html
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org" xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity3"> <head> <title>Spring Security Example </title> </head> <body> <div th:if="${param.error}"> 用戶名或密碼錯 </div> <div th:if="${param.logout}"> 您已註銷成功 </div> <form th:action="@{/login}" method="post"> <div><label> 用戶名 : <input type="text" name="username"/> </label></div> <div><label> 密 碼 : <input type="password" name="password"/> </label></div> <div><input type="submit" value="登錄"/></div> </form> </body> </html>
可以看到,實現了一個簡單的通過用戶名和密碼提交到/login
的登錄方式。
根據配置,Spring Security提供了一個過濾器來攔截請求並驗證用戶身份。如果用戶身份認證失敗,頁面就重定向到/login?error
,並且頁面中會展現相應的錯誤信息。若用戶想要註銷登錄,可以通過訪問/login?logout
請求,在完成註銷之後,頁面展現相應的成功消息。
到這裏,我們啟用應用,並訪問http://localhost:8080/
,可以正常訪問。但是訪問http://localhost:8080/hello
的時候被重定向到了http://localhost:8080/login
頁面,因為沒有登錄,用戶沒有訪問權限,通過輸入用戶名user和密碼password進行登錄後,跳轉到了Hello World頁面,再也通過訪問http://localhost:8080/login?logout
,就可以完成註銷操作。
為了讓整個過程更完成,我們可以修改hello.html
,讓它輸出一些內容,並提供“註銷”的鏈接。
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org" xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity3"> <head> <title>Hello World!</title> </head> <body> <h1 th:inline="text">Hello [[${#httpServletRequest.remoteUser}]]!</h1> <form th:action="@{/logout}" method="post"> <input type="submit" value="註銷"/> </form> </body> </html>
源碼來源
本文通過一個最簡單的示例完成了對Web應用的安全控制,Spring Security提供的功能還遠不止於此,更多Spring Security的使用可參見Spring Security Reference。
企業分布式微服務雲SpringCloud SpringBoot mybatis (六)Spring Boot中使用Spring Security進行安全控制