Sa-Token与Spring WebFlux响应式框架集成实战指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00633/article/details/148375141

Sa-Token与Spring WebFlux响应式框架集成实战指南

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

前言

在现代Java开发中，响应式编程模型因其高效的资源利用率和良好的伸缩性而备受关注。本文将详细介绍如何将轻量级权限认证框架Sa-Token与Spring WebFlux响应式框架进行集成，帮助开发者构建安全可靠的响应式应用。

响应式编程与WebFlux基础

响应式编程是一种基于异步数据流的编程范式，Spring WebFlux是Spring框架提供的响应式Web编程模块。与传统的Servlet模型相比，WebFlux采用非阻塞IO模型，能够更好地处理高并发场景。

项目创建与配置

1. 初始化项目

创建一个标准的Spring Boot项目，选择WebFlux作为Web框架。项目结构应包含以下核心组件：

主启动类
配置类
控制器类
依赖管理文件

2. 添加Sa-Token依赖

根据项目使用的构建工具和Spring Boot版本，添加对应的Sa-Token响应式支持依赖：

Maven配置示例

<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-reactor-spring-boot-starter</artifactId>
    <version>${sa.top.version}</version>
</dependency>

Gradle配置示例

implementation 'cn.dev33:sa-token-reactor-spring-boot-starter:${sa.top.version}'

版本注意：对于Spring Boot 3.x项目，需要使用sa-token-reactor-spring-boot3-starter。

核心配置实现

1. 主启动类

创建标准Spring Boot启动类，初始化应用上下文：

@SpringBootApplication
public class SaTokenDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(SaTokenDemoApplication.class, args);
        System.out.println("Sa-Token配置信息：" + SaManager.getConfig());
    }
}

2. 全局过滤器配置

响应式环境下，需要通过过滤器实现认证逻辑：

@Configuration
public class SaTokenConfigure {
    
    @Bean
    public SaReactorFilter saReactorFilter() {
        return new SaReactorFilter()
            .addInclude("/**")  // 拦截所有路径
            .addExclude("/favicon.ico")  // 排除静态资源
            .setAuth(obj -> {
                // 认证逻辑
                System.out.println("执行全局认证");
            })
            .setError(e -> {
                // 异常处理
                System.out.println("捕获全局异常");
                return SaResult.error(e.getMessage());
            });
    }
}

关键点说明：

addInclude：定义需要拦截的路由
addExclude：定义放行的路由
setAuth：设置认证逻辑函数
setError：定义异常处理逻辑

业务逻辑实现

1. 用户认证控制器

创建处理用户登录和认证状态的端点：

@RestController
@RequestMapping("/user/")
public class UserController {
    
    // 模拟登录接口
    @RequestMapping("doLogin")
    public String doLogin(String username, String password) {
        if("zhang".equals(username) && "123456".equals(password)) {
            StpUtil.login(10001);  // 为ID为10001的用户登录
            return "登录成功";
        }
        return "登录失败";
    }
    
    // 检查登录状态接口
    @RequestMapping("isLogin")
    public String isLogin() {
        return "当前会话是否登录：" + StpUtil.isLogin();
    }
}

2. 路由级权限控制

在全局过滤器中可以添加细粒度的路由控制：

.setAuth(obj -> {
    // 只对/test路径下的请求进行登录检查
    SaRouter.match("/test/**", () -> StpUtil.checkLogin());
    
    // 更复杂的权限校验示例
    SaRouter.match("/admin/**", () -> {
        StpUtil.checkLogin();
        StpUtil.checkPermission("admin");
    });
})