Sa-Token 开源项目使用教程

Sa-Token 开源项目使用教程

Sa-Token 一个轻量级 Java 权限认证框架，让鉴权变得简单、优雅！—— 登录认证、权限认证、分布式Session会话、微服务网关鉴权、单点登录、OAuth2.0 项目地址: https://gitcode.com/gh_mirrors/sa/Sa-Token

1. 项目介绍

Sa-Token 是一个轻量级的 Java 权限认证框架，旨在让鉴权变得简单、优雅。它目前拥有五大核心模块：登录认证、权限认证、单点登录、OAuth2.0 和微服务鉴权。Sa-Token 支持多种 Web 框架，如 SpringBoot、Solon、JFinal 等，并提供集成包，实现开箱即用。

2. 项目快速启动

以下以 SpringBoot 项目为例，展示如何快速集成 Sa-Token。

首先，在项目的 pom.xml 文件中添加 Sa-Token 的依赖：

<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>1.41.0</version>
</dependency>

然后，在 SpringBoot 主类中添加 Sa-Token 的配置：

import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.stp.StpUtil;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SaTokenApplication {

    public static void main(String[] args) {
        SpringApplication.run(SaTokenApplication.class, args);
        // 初始化 Sa-Token
        SaManager.init();
    }
    
    // 示例：登录接口
    public void login(Integer userId) {
        StpUtil.login(userId);
    }
    
    // 示例：校验登录接口
    public void checkLogin() {
        StpUtil.checkLogin();
    }
}

这样，就完成了 Sa-Token 的基本配置和登录校验。

3. 应用案例和最佳实践

• 登录认证：使用 Sa-Token 实现用户登录，可支持单端登录、多端登录、同端互斥登录等模式。
• 权限认证：通过 Sa-Token 的注解式鉴权，优雅地将鉴权与业务代码分离。
• 会话管理：利用 Sa-Token 的会话管理功能，实现全端共享Session或单端独享Session。
• 单点登录：采用 Sa-Token 的 SSO 单点登录功能，支持多种架构模式，如同域、跨域、共享Redis等。

4. 典型生态项目

• Snowy：国内首个国密前后分离快速开发平台，采用 Vue3 + AntDesignVue3 + Vite + SpringBoot + Mp + HuTool + SaToken。
• RuoYi-Vue-Plus：重写RuoYi-Vue所有功能，集成 Sa-Token + Mybatis-Plus + Jackson + Xxl-Job + knife4j + Hutool + OSS。
• Smart-Admin：国内首个以“高质量代码”为核心，“简洁、高效、安全”的中后台快速开发平台。
• 灯灯：专注于多租户解决方案的微服务中后台快速开发平台。

Sa-Token 一个轻量级 Java 权限认证框架，让鉴权变得简单、优雅！—— 登录认证、权限认证、分布式Session会话、微服务网关鉴权、单点登录、OAuth2.0 项目地址: https://gitcode.com/gh_mirrors/sa/Sa-Token