Java轻量级权限认证框架Sa-Token的使用

< dependency >

     < groupId >cn.dev33</ groupId >

     < artifactId >sa-token-spring-boot-starter</ artifactId >

     < version >1.29.0</ version >

</ dependency >

@RestController

@RequestMapping

public class LoginController {

    @GetMapping ( "doLogin" )

    public ResultModel doLogin(String name, String pwd) {

        // 此处仅作模拟示例，真实项目需要从数据库中查询数据进行比对

        if ( "jayjay" .equals(name) && "123456" .equals(pwd)) {

            StpUtil.login( 1001 );

            return ResultModel.success( "登录成功" ,StpUtil.getTokenInfo());

        }

        return ResultModel.error( "登录失败" );

    }

    @GetMapping ( "isLogin" )

    public ResultModel isLogin() {

        return ResultModel.success( "是否登录：" +StpUtil.isLogin(),StpUtil.getTokenInfo());

    }

    @GetMapping ( "logout" )

    public ResultModel logout() {

        StpUtil.logout();

        return ResultModel.success( "登出成功" );

    }

}

// 然后在需要校验登录处调用以下方法：

// 如果当前会话未登录，这句代码会抛出 `NotLoginException` 异常

StpUtil.checkLogin();

StpUtil.login( 10001 );    // 标记当前会话登录的账号id

StpUtil.getLoginId();    // 获取当前会话登录的账号id

StpUtil.isLogin();    // 获取当前会话是否已经登录, 返回true或false

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

StpUtil.kickout( 10001 );    // 将账号为10001的会话踢下线

StpUtil.hasRole( "super-admin" );    // 查询当前账号是否含有指定角色标识, 返回true或false

StpUtil.hasPermission( "user:add" );    // 查询当前账号是否含有指定权限, 返回true或false

StpUtil.getSession();    // 获取当前账号id的Session

StpUtil.getSessionByLoginId( 10001 );    // 获取账号id为10001的Session

StpUtil.getTokenValueByLoginId( 10001 );    // 获取账号id为10001的token令牌值

StpUtil.login( 10001 , "PC" );    // 指定设备标识登录，常用于[同端互斥登录]

StpUtil.kickout( 10001 , "PC" );    // 指定账号指定设备标识踢下线 (不同端不受影响)

StpUtil.openSafe( 120 );    // 在当前会话开启二级认证，有效期为120秒

StpUtil.checkSafe();    // 校验当前会话是否处于二级认证有效期内，校验失败会抛出异常

StpUtil.switchTo( 10044 );    // 将当前会话身份临时切换为其它账号

@Configuration

public class SaTokenConfigure implements WebMvcConfigurer {

     // 注册Sa-Token的注解拦截器，打开注解式鉴权功能

     @Override

     public void addInterceptors(InterceptorRegistry registry) {

         // 注册注解拦截器，并排除不需要注解鉴权的接口地址 (与登录拦截器无关)

         registry.addInterceptor( new SaAnnotationInterceptor()).addPathPatterns( "/**" );   

     }

}

# Sa-Token配置

sa-token:

     # token名称 (同时也是cookie名称)

     token-name: satoken

     # token有效期，单位s 默认30天, -1代表永不过期

     timeout: 2592000

     # token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒

     activity-timeout: -1

     # 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)

     is-concurrent: true

     # 在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token)

     is-share: false

     # token风格

     token-style: uuid

     # 是否输出操作日志

     is-log: false

/**

  * Sa-Token代码方式进行配置

  */

@Configuration

public class SaTokenConfigure {

    // 获取配置Bean (以代码的方式配置Sa-Token, 此配置会覆盖yml中的配置)

    @Bean

    @Primary

    public SaTokenConfig getSaTokenConfigPrimary() {

        SaTokenConfig config = new SaTokenConfig();

        config.setTokenName( "satoken" );             // token名称 (同时也是cookie名称)

        config.setTimeout( 30 * 24 * 60 * 60 );       // token有效期，单位s 默认30天

        config.setActivityTimeout(- 1 );               // token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒

        config.setIsConcurrent( true );               // 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录) 

        config.setIsShare( true );                     // 在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token) 

        config.setTokenStyle( "uuid" );               // token风格 

        config.setIsLog( false );                     // 是否输出操作日志 

        return config;

    }

}