Spring Boot 整合 SA-Token 使用详解_sa-token-spring-boot-starter

Spring Boot 整合 SA-Token 使用详解

在现代Web开发中，用户认证与授权是构建安全应用的基础。SA-Token是一个轻量级的Java权限认证框架，它以其简洁的API设计、高效的执行效率以及丰富的功能特性，成为了众多开发者在Spring Boot项目中实现用户认证与授权的首选方案。本文将详细介绍如何在Spring Boot项目中整合SA-Token，包括环境搭建、基本使用、高级功能以及最佳实践等内容。

一、SA-Token 简介

SA-Token是一个基于Token的Java权限认证框架，主要解决：登录认证、权限认证、Session会话、踢出登录、单点登录、OAuth2.0、微服务网关鉴权等一系列权限相关问题。SA-Token以“简单、易用、安全”为设计目标，致力于打造一个轻量级的权限认证框架。

二、环境搭建

1. 引入SA-Token依赖

首先，你需要在Spring Boot项目的pom.xml文件中引入SA-Token的Maven依赖。SA-Token的最新版本可以通过其GitHub仓库或Maven中央仓库查询。

<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>你的SA-Token版本号</version>
</dependency>
1
2
3
4
5

2. 配置application.yml

通常，SA-Token不需要过多的配置即可直接使用。但你可以通过application.yml或application.properties文件对SA-Token进行一些基础配置，如Token名称、Token有效期等。

sa-token:
  # token名称 (同时也是cookie名称)
  token-name: Authorization
  # token有效期，单位s, 默认30天, -1代表永不过期
  timeout: 2592000
  # token临时有效期 (指定时间内无操作, token自动延长有效期)，单位s, 默认0代表不自动续期
  activity-timeout: -1
  # 是否允许同一账号并发登录 (为多个设备登录同一账号的情况提供支持)
  is-concurrent: true
  # 是否允许在浏览器中存储token (默认为false，存储在内存中，关闭浏览器则失效)
  is-remember-me: false
  # 在多人登录同一账号时, 是否互相踢下线(默认true)
  is-kick-online: true
  # token风格
  token-style: jwt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

三、基本使用

1. 登录认证

SA-Token提供了简单的登录认证API，你可以通过调用StpUtil.login()方法实现用户登录，并生成Token。

@RestController
@RequestMapping("/auth")
public class AuthController {

    @PostMapping("/login")
    public ResponseEntity<?> login(@RequestBody User user) {
        // 假设这是你的用户验证逻辑
        if ("admin".equals(user.getUsername()) && "123456".equals(user.getPassword())) {
            // 登录成功，将id作为主键存入
            StpUtil.login(user.getId());
            return ResponseEntity.ok("登录成功");
        }
        return ResponseEntity.badRequest().body("登录失败");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

2. 权限认证

SA-Token通过@SaCheckPermission注解和StpUtil.checkPermission()方法提供权限认证功能。

@RestController
@RequestMapping("/admin")
public class AdminController {

    @GetMapping("/info")
    @SaCheckPermission("admin.info")
    public ResponseEntity<?> getInfo() {
        return ResponseEntity.ok("这是管理员信息");
    }

    // 或者在方法内部手动检查
    @GetMapping("/data")
    public ResponseEntity<?> getData() {
        // 校验当前用户是否含有admin.data权限
        if (StpUtil.checkPermission("admin.data")) {
            return ResponseEntity.ok("这是管理员数据");
        }
        return ResponseEntity.status(HttpStatus.FORBIDDEN).body("权限不足");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

3. 会话管理

SA-Token支持基于Token的会话管理，包括获取当前会话信息、注销会话等。

// 获取当前会话的Token信息
Object tokenValue = StpUtil.getTokenValue();

// 注销当前会话
StpUtil.logout();

// 强制使某个Token失效（通过Token值）
StpUtil.logoutByTokenValue(tokenValue);
1
2
3
4
5
6
7
8

四、高级功能

SA-Token不仅仅局限于基本的登录和权限认证，它还提供了许多高级功能，以满足更复杂的安全需求。

1. 角色认证

SA-Token支持基于角色的访问控制（RBAC）。你可以通过StpUtil.setRole()方法为用户设置角色，并通过@SaCheckRole注解或StpUtil.checkRole()方法检查用户是否拥有特定角色。

// 登录时设置角色
StpUtil.login(userId).setRole("admin");

// 控制器方法中使用角色认证
@GetMapping("/admin/dashboard")
@SaCheckRole("admin")
public ResponseEntity<?> adminDashboard() {
    return ResponseEntity.ok("管理员控制面板");
}

// 或者在方法内部检查
if (StpUtil.checkRole("admin")) {
    // 执行管理员相关操作
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

2. 权限字符串模式

SA-Token允许你定义复杂的权限字符串模式，以实现更细粒度的权限控制。例如，你可以使用通配符来匹配多个权限。

// 赋予用户多个权限
StpUtil.setPermission("user.add", "user.delete", "user.update.*");

// 检查用户是否拥有“user.update”下任意权限
if (StpUtil.checkPermission("user.update.*")) {
    // 允许执行相关操作
}
1
2
3
4
5
6
7

3. 自定义Token处理器

SA-Token允许你通过实现TokenProcessor接口来自定义Token的生成、解析和验证逻辑。这对于有特殊Token格式或加密需求的应用非常有用。

@Component
public class CustomTokenProcessor implements TokenProcessor {
    // 实现自定义的Token处理逻辑
}

// 在配置类中指定自定义的Token处理器
@Configuration
public class SaTokenConfig {
    @Bean
    public TokenProcessor tokenProcessor() {
        return new CustomTokenProcessor();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

4. 集成OAuth2.0

SA-Token支持OAuth2.0协议，允许你轻松实现第三方登录功能。你可以通过配置OAuth2.0客户端信息，并使用SA-Token提供的OAuth2.0工具类来处理登录流程。

// 配置OAuth2.0客户端
@Bean
public OAuth2Template oAuth2Template(RestTemplate restTemplate) {
    OAuth2Template template = new OAuth2Template("clientId", "clientSecret", "authorizationServerUrl");
    // 设置其他OAuth2.0参数
    return template;
}

// 控制器中处理OAuth2.0登录
@GetMapping("/oauth/login")
public String oauthLogin(HttpServletRequest request) {
    // 发起OAuth2.0登录请求，并处理回调
    // ...
    return "redirect:/login/success";
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

注意：上面的OAuth2.0集成示例是概念性的，SA-Token本身并不直接提供OAuth2.0客户端实现。你需要结合Spring Security OAuth2或其他OAuth2.0客户端库来实现。

5. 微服务鉴权

在微服务架构中，SA-Token可以通过网关层进行统一的鉴权。你可以将SA-Token与Spring Cloud Gateway或Zuul等网关集成，实现API级别的访问控制。

// 网关路由配置中加入鉴权过滤器
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
    return builder.routes()
            .route(p -> p
                    .path("/api/**")
                    .filters(f -> f.stripPrefix(1)
                            .filter(new SaTokenAuthGlobalFilter())) // 自定义SA-Token鉴权过滤器
                    .uri("lb://your-service"))
            .build();
}

// 实现SaTokenAuthGlobalFilter鉴权过滤器
public class SaTokenAuthGlobalFilter implements GlobalFilter, Ordered {
    // ... 实现鉴权逻辑

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 校验Token，处理权限等
        // ...
        
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return -1; // 优先级设置
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

五、最佳实践（续）

3. Token存储与过期管理：

   • 确保Token在客户端（如浏览器、移动应用）的存储方式是安全的，避免敏感信息泄露。
   • 合理使用Token的过期时间，根据应用的安全需求和用户体验来设置。过短的过期时间会增加用户的登录频率，而过长的过期时间可能会增加Token被滥用的风险。
   • 利用SA-Token提供的自动续签功能（如果可用），以减少用户因Token过期而需要重新登录的情况。

4. 日志与监控：

   • 记录所有与认证和授权相关的日志，包括登录尝试、权限检查等，以便于审计和排查安全问题。
   • 监控认证服务的性能和稳定性，确保在高并发情况下也能正常工作。
   • 设置警报系统，以便在发生异常登录尝试、权限滥用等安全事件时及时通知管理员。

5. 定期审计与安全培训：

   • 定期对系统的权限配置、用户角色和Token管理进行审计，确保没有安全漏洞。
   • 对开发人员和运维人员进行安全培训，提高他们对安全最佳实践的认识和遵守程度。

6. 使用HTTPS和HSTS：

   • 确保所有与Token传输相关的请求都通过HTTPS进行，以保护Token在传输过程中的安全。
   • 启用HTTP严格传输安全（HSTS）策略，强制浏览器通过HTTPS与服务器建立连接，即使URL以http://开头。

7. 遵循最小权限原则：

   • 在分配权限时，应遵循最小权限原则，即只授予用户完成其工作所需的最小权限集合。
   • 定期检查并清理不再需要的权限和角色，以减少潜在的安全风险。

8. Token泄露应对措施：

   • 制定Token泄露的应急响应计划，包括如何快速定位泄露源、通知受影响的用户、撤销泄露的Token等。
   • 定期对Token的存储和传输机制进行安全评估，以发现潜在的安全漏洞并及时修复。

9. 集成第三方安全工具：

   • 考虑集成第三方安全工具，如Web应用防火墙（WAF）、入侵检测/防御系统（IDS/IPS）等，以增强系统的安全防护能力。
   • 利用这些工具来监控和阻止潜在的恶意访问和攻击行为。

10. 持续更新与升级：

    • 密切关注SA-Token和相关依赖库的更新和漏洞信息，及时应用安全补丁和更新。
    • 定期评估并升级系统的安全配置和策略，以适应不断变化的安全威胁和最佳实践。

通过遵循这些最佳实践，你可以有效地提高SA-Token在你的应用中的安全性和可靠性。同时，这些实践也适用于其他认证和授权框架和库，为你的应用提供全面的安全保障。