sa-token 路由拦截式鉴权使用示例详解

 更新时间:2023年07月18日 11:58:52   作者:知知.  
这篇文章主要为大家介绍了sa-token 路由拦截式鉴权使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

前言

假设我们有如下需求:

项目中所有接口均需要登录验证,只有‘’登录接口‘’本身对外开放

我们怎么实现呢?给每个接口加上鉴权注解?手写全局拦截器?似乎都不是非常方便。 在这个需求中我们真正需要的是一种基于路由拦截的鉴权模式, 那么在sa-token怎么实现路由拦截鉴权呢?

使用方式

1、注册路由拦截器

以 springboot2.0 为例, 新建配置类MySaTokenConfig.java

@Configuration
    public class MySaTokenConfig implements WebMvcConfigurer {
    // 注册sa-token的登录拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册登录拦截器,并排除登录接口地址 
        registry.addInterceptor(new SaRouteInterceptor()).addPathPatterns("/**").excludePathPatterns("/user/doLogin"); 
   }
}

以上代码,我们注册了一个登录验证拦截器,并且排除了 /user/doLogin 接口用来开放登录 那么我们如何进行权限认证拦截呢,且往下看

2、所有拦截器示例

@Configuration
public class MySaTokenConfig implements WebMvcConfigurer {
 // 注册sa-token的所有拦截器
 @Override
 public void addInterceptors(InterceptorRegistry registry) {
 // 注册一个登录验证拦截器 
 registry.addInterceptor(SaRouteInterceptor.createLoginVal()).addPathPatterns("/**").excludePathPatterns("/user/doLogin"); 
 // 注册一个角色认证拦截器 
 registry.addInterceptor(SaRouteInterceptor.createRoleVal("super-admin")).addPathPatterns("/**"); 
 // 注册一个权限认证拦截器 
 registry.addInterceptor(SaRouteInterceptor.createPermissionVal("user:add", "user:deelete")).addPathPatterns("/UserController/**"); 
 // 注册一个自定义认证拦截器 (可以写任意认证代码)
 registry.addInterceptor(new SaRouteInterceptor((request, response, handler)->{
 System.out.println("---------- 进入自定义认证 --------------- ");
 // 你可以在这里写任意认证代码, 例如: StpUtil.checkLogin(); 
 })).addPathPatterns("/**");
 }
}

(你不必像上面的示例一样注册所有拦截器,只要按需注册即可 )

3、让我们利用自定义拦截器做点快活的事情

你可以根据路由划分模块,不同模块不同鉴权

@Configuration
public class MySaTokenConfig implements WebMvcConfigurer {
 // 注册sa-token的所有拦截器
 @Override
 public void addInterceptors(InterceptorRegistry registry) {
     registry.addInterceptor(new SaRouteInterceptor((request, response, handler)->{
    // 根据路由划分模块,不同模块不同鉴权 
     SaRouterUtil.match("/user/**", () -> StpUtil.checkPermission("user"));
     SaRouterUtil.match("/admin/**", () -> StpUtil.checkPermission("admin"));
     SaRouterUtil.match("/goods/**", () -> StpUtil.checkPermission("goods"));
     SaRouterUtil.match("/orders/**", () -> StpUtil.checkPermission("orders"));
     SaRouterUtil.match("/notice/**", () -> StpUtil.checkPermission("notice"));
     SaRouterUtil.match("/comment/**", () -> StpUtil.checkPermission("comment"));
 })).addPathPatterns("/**");
 }
}

4、完整的示例

最终的代码,可能会类似于下面的样子:

@Configuration
public class MySaTokenConfig implements WebMvcConfigurer {
 // 注册sa-token的拦截器
 @Override
 public void addInterceptors(InterceptorRegistry registry) {
 // 自定义验证拦截器 
 registry.addInterceptor(new SaRouteInterceptor((request, response, handler) -> {
 // 登录验证 -- 拦截所有路由,并排除/user/doLogin 用于开放登录 
 SaRouterUtil.match("/**", "/user/doLogin", () -> StpUtil.checkLogin());
 // 角色认证 -- 拦截以 admin 开头的路由,必须具备[admin]角色或者[super-admin]角色才可以通过认证 
 SaRouterUtil.match("/admin/**", () -> StpUtil.checkRoleOr("admin", "super-admin"));
 // 权限认证 -- 不同模块, 校验不同权限 
 SaRouterUtil.match("/user/**", () -> StpUtil.checkPermission("user"));
 SaRouterUtil.match("/admin/**", () -> StpUtil.checkPermission("admin"));
 SaRouterUtil.match("/goods/**", () -> StpUtil.checkPermission("goods"));
 SaRouterUtil.match("/orders/**", () -> StpUtil.checkPermission("orders"));
 SaRouterUtil.match("/notice/**", () -> StpUtil.checkPermission("notice"));
 SaRouterUtil.match("/comment/**", () -> StpUtil.checkPermission("comment"));
 // 匹配RESTful风格路由 
 SaRouterUtil.match("/article/get/{id}", () -> StpUtil.checkPermission("article"));
 })).addPathPatterns("/**");
 }
}

仓库地址

以上就是sa-token 路由拦截式鉴权使用示例详解的详细内容,更多关于sa-token路由拦截式鉴权的资料请关注脚本之家其它相关文章!

相关文章

  • Java Pattern和Matcher字符匹配方式

    Java Pattern和Matcher字符匹配方式

    这篇文章主要介绍了Java Pattern和Matcher字符匹配方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • 在Spring中如何使用动态代理?

    在Spring中如何使用动态代理?

    上篇文章记录自定义切面,下边记录使用注解来编写自定义切面,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • Springboot 接口对接文件及对象的操作方法

    Springboot 接口对接文件及对象的操作方法

    这篇文章主要介绍了Springboot 接口对接文件及对象的操作,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • Java日期时间调整的几种方式汇总

    Java日期时间调整的几种方式汇总

    Calendar类是一个抽象类,在实际使用时实现特定的子类的对象,创建对象的过程对程序员来说是透明的,只需要使用getInstance方法创建即可,这篇文章主要介绍了Java日期时间调整的几种方式,需要的朋友可以参考下
    2023-05-05
  • Java报错:ClassCastException问题解决方法

    Java报错:ClassCastException问题解决方法

    异常是程序中的一些错误,但并不是所有的错误都是异常,并且错误有时候是可以避免的,下面这篇文章主要给大家介绍了关于Java报错:ClassCastException问题解决方法,需要的朋友可以参考下
    2024-07-07
  • mysql+mybatis下全文搜索的使用方法

    mysql+mybatis下全文搜索的使用方法

    本文主要介绍了mysql+mybatis下全文搜索的使用方法,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • python中jieba库(中文分词库)使用安装教程

    python中jieba库(中文分词库)使用安装教程

    这篇文章主要介绍了python中jieba库(中文分词库)使用安装教程,jieba库是通过中文词库的方式来识别分词的。它首先利用一个中文词库,通过词库计算汉字之间构成词语的关联概率,所以通过计算汉字之间的概率,就可以形成分词的结果,需要的朋友可以参考下
    2023-04-04
  • java随机生成字符串(字符随机生成类 生成随机字符组合)

    java随机生成字符串(字符随机生成类 生成随机字符组合)

    java随机生成字符串,字符组合多样,可以大小字组合、大+小字符+数字等方式,大家参考使用吧
    2013-12-12
  • JAVA 实现磁盘文件加解密操作的示例代码

    JAVA 实现磁盘文件加解密操作的示例代码

    这篇文章主要介绍了JAVA 实现磁盘文件加解密操作的示例代码,帮助大家利用Java实现文件的加解密,感兴趣的朋友可以了解下
    2020-09-09
  • Java中import static使用方式小结

    Java中import static使用方式小结

    import static是Java中用于导入静态成员的特性,可以直接导入静态方法、常量、内部类和枚举成员,本文就来介绍一下Java中import static使用,感兴趣的可以了解一下
    2025-08-08

最新评论