SpringBoot 中使用 Spring Security
我們在編寫Web應用時，經常需要對頁面做一些安全控制，比如：對於沒有訪問許可權的使用者需要轉到登入表單頁面。要實現訪問控制的方法多種多樣，可以通過Aop、攔截器實現，也可以通過框架實現（如：Apache Shiro、Spring Security）。
本文將具體介紹在Spring Boot中如何使用Spring Security進行安全控制。
準備工作
首先，構建一個簡單的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。
完整示例：Chapter4-3-1