概述

Sa-Token介绍

Sa-Token是一个轻量级Java权限认证框架，主要解决登录认证、权限认证、Session会话、单点登录、OAuth2.0、微服务网关鉴权等一系列权限相关问题。它的API设计简单，易于上手，同时功能强大，能够满足多种复杂的权限认证需求。

使用

导入依赖

在SpringBoot项目中，首先需要导入Sa-Token的依赖：

xml

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

SpringBoot的简单集成

配置文件

在application.yml中配置Sa-Token：

yaml

sa-token:
  token-name: xc_satoken
  timeout: 2592000
  activity-timeout: -1
  is-concurrent: true
  is-share: false
  token-style: uuid
  is-log: false

Controller

在Controller层使用Sa-Token进行权限控制：

java

@RestController
@RequestMapping("/user")
public class UserController {
    @PostMapping("/login")
    public String login(String username, String password) {
        if ("xx".equals(username) && "123456".equals(password)) {
            StpUtil.login(1001);
            return "登陆成功";
        }
        return "登陆失败";
    }
    
    @GetMapping("/isLogin")
    public String islogin() {
        return "当前会话是否登录：" + StpUtil.isLogin();
    }
    
    @GetMapping("/checkLogin")
    public String checkLogin() {
        StpUtil.checkLogin();
        return "已登录";
    }
    
    // 更多权限控制方法...
}

功能详解

登录认证

使用Sa-Token进行登录认证非常简单，只需要调用StpUtil.login(id)方法即可。同时，可以使用StpUtil.isLogin()和StpUtil.checkLogin()方法来检查当前会话是否已经登录。

权限认证

在实现权限认证之前，需要实现StpInterface接口，来编写自己的权限集合。例如：

java

@Component
public class StpInterfaceImpl implements StpInterface {
    @Override
    public List<String> getPermissionList(Object loginId, String loginType) {
        List<String> list = new ArrayList<>();
        list.add("user:update");
        list.add("user:delete");
        list.add("user:select");
        return list;
    }
    
    @Override
    public List<String> getRoleList(Object loginId, String loginType) {
        List<String> list = new ArrayList<>();
        list.add("admin");
        list.add("user");
        return list;
    }
}

然后，可以使用StpUtil.hasPermission("permission")和StpUtil.checkPermission("permission")等方法来进行权限校验。

注解式鉴权

Sa-Token提供了注解式鉴权的方式，可以在Controller层进行注解鉴权：

java

@SaCheckLogin
@RequestMapping("info")
public String info() {
    return "查询用户信息";
}

@SaCheckRole("super-admin")
@RequestMapping("add")
public String add() {
    return "用户增加";
}

@SaCheckPermission("user-add")
@RequestMapping("add")
public String add() {
    return "用户增加";
}

异常处理

在全局异常处理中，可以捕获Sa-Token抛出的异常，进行统一处理：

java

@RestControllerAdvice
public class MyExceptionHandle {
    @ExceptionHandler(Exception.class)
    public String handlerException(Exception e) {
        if (e instanceof NotLoginException) {
            return "账号未登录";
        } else if (e instanceof NotRoleException) {
            return "无此角色权限";
        } else if (e instanceof NotPermissionException) {
            return "无此权限";
        } else {
            return "未知错误";
        }
    }
}

总结

Sa-Token作为一个轻量级的权限认证框架，其简单易用的API和强大的功能，使其成为Java项目中一个不错的选择。