SpringBoot淺析安全管理之Shiro框架

2022-08-12 14:00:33

Shiro 簡介

Apache Shiro 是一個開源的輕量級的 Java 安全框架，它提供身份驗證、授權、密碼管理以及對談管理等功能。相對於 Spring Security ，Shiro 框架更加直觀、易用，同時也能提供健壯的安全性。

在傳統的 SSM 框架中，手動整合 Shiro 的設定步驟還是比較多的，針對 Spring Boot ，Shiro 官方提供了 shiro-spring-boot-web-starter 用來簡化 Shiro 在 Spring Boot 中的設定。

整合 Shiro

1. 建立專案

首先建立一個普通的 Spring Boot Web 專案，新增 Shiro 依賴以及頁面模板依賴

<dependency>
  <groupId>org.apache.shiro</groupId>
  <artifactId>shiro-spring-boot-web-starter</artifactId>
  <version>1.4.0</version>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
  <groupId>com.github.theborakompanioni</groupId>
  <artifactId>thymeleaf-extras-shiro</artifactId>
  <version>2.0.0</version>
</dependency>

這裡不需要新增 spring-boot-starter-web 依賴，shiro-spring-boot-web-starter 中已經依賴了 spring-boot-starter-web 。同時，此處使用 Thymeleaf 模板，為了在 Thymeleaf 使用 shiro 標籤，加入了 thymeleaf-extras-shiro 依賴。

2. Shiro基本設定

在 application.properties 中設定 Shiro 的基本資訊

# 開啟 Shiro 設定，預設為 true
shiro.enabled=true
# 開啟 Shiro Web 設定，預設為 true
shiro.web.enabled=true
# 設定登入地址，預設為 /login.jsp
shiro.loginUrl=/login
# 設定登入成功的地址，預設為 /
shiro.successUrl=/index
# 未獲授權預設跳轉地址
shiro.unauthorizedUrl=/unauthorized
# 是否允許通過 URL 引數實現對談跟蹤，如果網站支援 Cookie，可以關閉此選項，預設為 true
shiro.sessionManager.sessionIdUrlRewritingEnabled=true
# 是否允許通過 Cookie 實現對談跟蹤，預設為 true
shiro.sessionManager.sessionIdCookieEnabled=true

然後在 Java 程式碼中設定 Shiro ，提供兩個最基本的 Bean 即可

@Configuration
public class ShiroConfig {
    @Bean
    public Realm realm() {
        TextConfigurationRealm realm = new TextConfigurationRealm();
        realm.setUserDefinitions("sang=123,usern admin=123,admin");
        realm.setRoleDefinitions("admin=read,writen user=read");
        return realm;
    }
    @Bean
    public ShiroFilterChainDefinition shiroFilterChainDefinition() {
        DefaultShiroFilterChainDefinition chainDefinition =
                new DefaultShiroFilterChainDefinition();
        chainDefinition.addPathDefinition("/login", "anon");
        chainDefinition.addPathDefinition("/doLogin", "anon");
        chainDefinition.addPathDefinition("/logout", "logout");
        chainDefinition.addPathDefinition("/**", "authc");
        return chainDefinition;
    }
    @Bean
    public ShiroDialect shiroDialect() {
        return new ShiroDialect();
    }
}

程式碼解釋：

這裡提供兩個關鍵的 Bean ，一個是 Realm，另一個是 ShiroFilterChainDefinition 。至於 ShiroDialect 則是為了支援在 Thymeleaf 中使用 Shiro 標籤，如果不在 Thymeleaf 中使用 Shiro 標籤，那麼可以不提供 ShiroDialect
Realm 可以是自定義的 Realm，也可以是 Shiro 提供的 Realm，簡單起見，此處沒有設定資料庫連線，直接設定了兩個使用者：sang/123 和 admin/123 ，分別對應角色 user 和 admin。
ShiroFilterChainDefinition Bean 中設定了基本的過濾規則，“/login” 和 “/doLogin”，可以匿名存取，“/logout”是一個登出登入請求，其餘請求則都需要認證後才能存取

然後設定登入介面以及頁面存取介面

@Controller
public class UserController {
    @PostMapping("/doLogin")
    public String doLogin(String username, String password, Model model) {
        UsernamePasswordToken token = new UsernamePasswordToken(username, password);
        Subject subject = SecurityUtils.getSubject();
        try {
            subject.login(token);
        } catch (AuthenticationException e) {
            model.addAttribute("error", "使用者名稱或密碼輸入錯誤!");
            return "login";
        }
        return "redirect:/index";
    }
    @RequiresRoles("admin")
    @GetMapping("/admin")
    public String admin() {
        return "admin";
    }
    @RequiresRoles(value = {"admin", "user"}, logical = Logical.OR)
    @GetMapping("/user")
    public String user() {
        return "user";
    }
}

程式碼解釋：

在 doLogin 方法中，首先構建一個 UsernamePasswordToken 範例，然後獲取一個 Subject 物件並呼叫該物件中的 login 方法執行登入操作，在登入操作執行過程中，當有異常丟擲時，說明登入失敗，攜帶錯誤資訊返回登入檢視；當登入成功時，則重定向到“/index”
接下來暴露兩個介面“/admin”和“/user”，對於“/admin”介面，需要具有 admin 角色才可以存取；對於“/user”介面，具備 admin 角色和 user角色其中任意一個即可存取

對於其他不需要角色就能存取的介面，直接在 WebMvc 中設定即可

@Configuration
public class WebMvcConfig implements WebMvcConfigurer{
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/login").setViewName("login");
        registry.addViewController("/index").setViewName("index");
        registry.addViewController("/unauthorized").setViewName("unauthorized");
    }
}

接下來建立全域性例外處理器進行全域性例外處理，此處主要是處理授權異常

@ControllerAdvice
public class ExceptionController {
    @ExceptionHandler(AuthorizationException.class)
    public ModelAndView error(AuthorizationException e) {
        ModelAndView mv = new ModelAndView("unauthorized");
        mv.addObject("error", e.getMessage());
        return mv;
    }
}

當用戶存取未授權的資源時，跳轉到 unauthorized 檢視中，並攜帶出錯誤資訊。

設定完成後，最後在 resources/templates 目錄下建立 5 個 HTML 頁面進行測試。

（1）index.html

<!DOCTYPE html>
<html lang="en" xmlns:shiro="http://www.pollix.at/thymeleaf/shiro">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h3>Hello, <shiro:principal/></h3>
<h3><a href="/logout" rel="external nofollow" >登出登入</a></h3>
<h3><a shiro:hasRole="admin" href="/admin" rel="external nofollow" >管理員頁面</a></h3>
<h3><a shiro:hasAnyRoles="admin,user" href="/user" rel="external nofollow" >普通使用者頁面</a></h3>
</body>
</html>

（2）login.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<div>
    <form action="/doLogin" method="post">
        <input type="text" name="username"><br>
        <input type="password" name="password"><br>
        <div th:text="${error}"></div>
        <input type="submit" value="登入">
    </form>
</div>
</body>
</html>

（3）user.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>普通使用者頁面</h1>
</body>
</html>

（4）admin.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>管理員頁面</h1>
</body>
</html>

（5）unauthorized.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<div>
    <h3>未獲授權，非法存取</h3>
    <h3 th:text="${error}"></h3>
</div>
</body>
</html>

3. 測試

啟動專案，存取登入頁面，使用 sang/123 登入

注意：由於 sang 使用者不具備 admin 角色，因此登入成功後的頁面沒有前往管理員頁面的超連結。

然後使用 admin/123 登入。

如果使用者使用 sang 登入，然後去存取：http://localhost:8080/admin，會跳轉到未授權頁面

以上通過一個簡單的案例展示瞭如何在 Spring Boot 中整合 Shiro 以及如何在 Thymeleaf 中使用 Shiro 標籤，一旦整合成功，接下來 Shiro 的用法就和原來的一模一樣。此處主要將 Spring Boot 整合 Shiro，對於 Shiro 的其它用法，可以參考 Shiro 官方檔案。

到此這篇關於SpringBoot淺析安全管理之Shiro框架的文章就介紹到這了,更多相關SpringBoot Shiro框架內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！