Spring Boot集成sa-token的項目實踐

更新時間：2024年05月21日 09:32:42 作者：源夢倩影

本文主要介紹了Spring Boot集成sa-token的項目實踐,實現(xiàn)了基本的登錄和權限控制功能,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

sa-token 是一個輕量級且功能強大的權限認證框架，它基于Java語言，專為Java開發(fā)者設計，以簡化權限管理的復雜性。在Spring Boot項目中集成sa-token，可以快速實現(xiàn)會話管理、權限控制等功能。本文將通過教程式寫作，帶領讀者一步步實現(xiàn)Spring Boot與sa-token的集成。

環(huán)境準備

JDK 1.8 或以上版本
Maven 或 Gradle 作為構建工具
Spring Boot 2.x 版本
IntelliJ IDEA 或 Eclipse 作為開發(fā)IDE

集成步驟

添加依賴

首先，需要在項目的pom.xml文件中添加sa-token的依賴。以Maven為例：

<dependencies>
    <!-- 引入sa-token核心模塊 -->
    <dependency>
        <groupId>cn.dev33</groupId>
        <artifactId>sa-token-spring-boot-starter</artifactId>
        <version>1.21.0</version>
    </dependency>
    <!-- 其他Spring Boot依賴 -->
</dependencies>

配置文件

在application.properties或application.yml中，可以對sa-token進行一些基本配置，例如：

sa-token.token-name = sa-token
sa-token.token-time = 3600

啟用sa-token

創(chuàng)建一個配置類，啟用sa-token：

import org.springframework.context.annotation.Configuration;
import cn.dev33.satoken.spring.SaTokenConfig;

@Configuration
public class SaTokenConfigDemo implements SaTokenConfig {
    @Override
    public void config() {
        // 此處可以配置sa-token的行為
    }
}

編寫登錄邏輯

實現(xiàn)一個登錄方法，用于生成token：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.SaToken;
import cn.dev33.satoken.stp.SaLoginModel;

@RestController
public class LoginController {

    @PostMapping("/login")
    public String login(@RequestParam("username") String username,
                        @RequestParam("password") String password) {
        // 假設此處有數(shù)據庫校驗邏輯
        if ("admin".equals(username) && "123456".equals(password)) {
            // 賬號密碼校驗成功后，使用sa-token進行登錄
            SaManager.login(10001); // 假設10001是當前登錄用戶的id
            return "登錄成功";
        } else {
            return "賬號或密碼錯誤";
        }
    }
}

權限控制

使用@SaCheckPermission注解實現(xiàn)權限控制：

import cn.dev33.satoken.annotation.SaCheckPermission;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class SecureController {

    @GetMapping("/secure")
    @SaCheckPermission("admin") // 只有擁有admin權限的才能訪問
    public String secureInfo() {
        return "這是受保護的信息";
    }
}

示例代碼

以下是一些示例代碼的匯總，供讀者參考：

// SaTokenConfigDemo.java
@Configuration
public class SaTokenConfigDemo implements SaTokenConfig {
    @Override
    public void config() {
        // 配置sa-token行為
    }
}

// LoginController.java
@RestController
public class LoginController {
    @PostMapping("/login")
    public String login(@RequestParam("username") String username,
                        @RequestParam("password") String password) {
        // 登錄邏輯
    }
}

// SecureController.java
@RestController
public class SecureController {
    @GetMapping("/secure")
    @SaCheckPermission("admin")
    public String secureInfo() {
        // 受保護的信息
    }
}