SpringCloud整合Sa-token

1、目的

之前写项目一致都使用的是 SpringSecurity ，但总是感觉SpringSecurity用起来比较繁琐，所以就打算使用sa-token 进行权限校验以及 登录验证，角色校验，集成比较简单.

2、设计思路

整个项目 使用SpringCloud GateWay 进行网关，统一将服务注册到nacos 上去

​ 即 mall_auth : 提供用户登录的功能

​ mall-mbg: 提供对数据库的查询操作

​ mall_common: 公共的方法

​ mall_product: 提供产品查询方法

​ gateway_test : 充当网关功能，对请求做权限校验然后对请求进行分发

3、实现过程

1、 父项目 pom 依赖

```java 4.0.0

org.example
test_sa_token
pom
1.0-SNAPSHOT



    org.springframework.boot
    spring-boot-starter-parent
    2.7.0
     





    3.5.9
    8.0.29
    2021.0.3
    2021.0.1.0
    1.4.1
    1.4.2




    gateway_test
    mall_auth
    mall_common
    mall_product




    
        org.projectlombok
        lombok
    

    
        org.springframework.boot
        spring-boot-configuration-processor
        true
    

    
    
        io.github.openfeign
        feign-okhttp
    

    
    
        org.springframework.cloud
        spring-cloud-starter-openfeign
    


    
        org.springframework.cloud
        spring-cloud-starter-bootstrap
        3.1.0
    

    
        org.springframework.boot
        spring-boot-configuration-processor
        true
    

    
    
        org.springframework.boot
        spring-boot-starter-data-redis
    


    
        com.alibaba.cloud
        spring-cloud-starter-alibaba-nacos-discovery
    
    
        com.alibaba.cloud
        spring-cloud-starter-alibaba-nacos-config
    




    

        
        
            org.springframework.cloud
            spring-cloud-dependencies
            ${spring-cloud.version}
            pom
            import
        
        
        
            com.alibaba.cloud
            spring-cloud-alibaba-dependencies
            ${spring-cloud-alibaba.version}
            pom
            import
        


        
        
            org.mybatis
            mybatis
            ${mybatis.version}
        

        
        
            org.mybatis.generator
            mybatis-generator-core
            ${mybatis-generator.version}
        

        
        
            com.github.pagehelper
            pagehelper-spring-boot-starter
            ${pagehelper-starter.version}
        

        
        
            mysql
            mysql-connector-java
            ${mysql-connector.version}
        
    

```

2、 gateway_test 项目

pom.xml

```java 4.0.0 org.example test satoken 1.0-SNAPSHOT com.example gateway test 0.0.1-SNAPSHOT gatewaytest 用于测试sa_token 1.8 org.springframework.cloud spring-cloud-starter-gateway

        org.example
        1.0-SNAPSHOT
        mall_common
    







    
        org.springframework.cloud
        spring-cloud-starter-openfeign
    

    
        cn.dev33
        sa-token-dao-redis-jackson
        1.34.0
    

    
        org.springframework.cloud
        spring-cloud-starter-loadbalancer
    


    
    
        cn.dev33
        sa-token-reactor-spring-boot-starter
        1.34.0
    


    
        
            org.springframework.cloud
            spring-cloud-dependencies
            ${spring-cloud.version}
            pom
            import
        
    



    
        
            org.springframework.boot
            spring-boot-maven-plugin
            
                
                    
                        org.projectlombok
                        lombok
                    
                
            
        
    

```

application.yml 配置

```java server: port: 8201

spring: # redis 相关配置 redis: # Redis数据库索引(默认为0) database: 1 # Redis服务器地址 host: 127.0.0.1 # Redis服务器连接端口 port: 6379 # Redis服务器连接密码(默认为空) # password: # 连接超时时间 timeout: 10s lettuce: pool: # 连接池最大连接数 max-active: 200 # 连接池最大阻塞等待时间(使用负值表示没有限制) max-wait: -1ms # 连接池中的最大空闲连接 max-idle: 10 # 连接池中的最小空闲连接 min-idle: 0

mvc: pathmatch: matching-strategy: antpathmatcher cloud: gateway: discovery: locator: enabled: true lower-case-service-id: true # 使用小写的service-id routes: # 配置路由路径 - id: mall-auth # 认证中心 uri: lb://mall-auth predicates: - Path=mall-auth/* filters: - StripPrefix=1 - id: mall-product # 产品模块 uri: lb://mall-product predicates: - Path=/mall-product/* filters: - StripPrefix=1

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

```

bootstrap.yml 文件

```java spring: profiles: active: dev application: name: mall-gateway

```

增加SaTokenConfigure 类用于sa-token 的配置

```java package com.example.gateway_test.config;

import cn.dev33.satoken.context.SaHolder; import cn.dev33.satoken.reactor.filter.SaReactorFilter; import cn.dev33.satoken.router.SaRouter; import cn.dev33.satoken.stp.StpUtil; import cn.dev33.satoken.util.SaResult; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration;

/* * [Sa-Token 权限认证] 全局配置类 */ @Configuration public class SaTokenConfigure { // 注册 Sa-Token全局过滤器 @Bean public SaReactorFilter getSaReactorFilter() { return new SaReactorFilter() // 拦截地址 .addInclude("/") / 拦截全部path */ // 开放地址 .addExclude("/favicon.ico") // 鉴权方法：每次访问进入 .setAuth(obj -> { // 登录校验 -- 拦截所有路由，并排除/account/user/doLogin用于开放登录 SaRouter.match("/", "/mall-auth/auth/token", r -> StpUtil.checkLogin());

// // 权限认证 -- 不同模块, 校验不同权限

/*           SaRouter.match("/mall-product/**", r -> StpUtil.checkRole("normal_role"));

                SaRouter.match("/admin/**", r -> StpUtil.checkRole("system_role"));
              SaRouter.match("/account/**", r -> StpUtil.checkRole("user"));
                SaRouter.match("/admin/**", r -> StpUtil.checkRole("admin"));
                SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
                SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));*/
                // 更多匹配 ...  */
            })
            .setBeforeAuth(obj -> {
                // ------设置跨域响应头
                SaHolder.getResponse()
                        // 允许指定域访问跨域资源
                        .setHeader("Access-Control-Allow-Origin", "*")
                        // 允许所有请求方式
                        .setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE")
                        // 有效时间
                        .setHeader("Access-Control-Max-Age", "3600")
                        // 允许的header参数
                        .setHeader("Access-Control-Allow-Headers", "*");

            })
            // 异常处理方法：每次setAuth函数出现异常时进入
            .setError(e -> {
                return SaResult.error(e.getMessage());
            })
            ;
}

}

```

增加 StpInterfaceImpl 实现了sa-token 对角色与权限的查询

```java package com.example.gateway_test.config;

import cn.dev33.satoken.stp.StpInterface; import com.example.common.api.RedisKey; import com.example.common.util.RedisUtil; import org.springframework.stereotype.Component;

import javax.annotation.Resource; import java.util.ArrayList; import java.util.List;

/** * @author zhangyang * @version 1.0 * @Date 2023/5/17 14:09 * @Description 对权限进行校验 */ @Component public class StpInterfaceImpl implements StpInterface {

@Resource
private RedisUtil redisUtil;


@Override
public List getPermissionList(Object loginId, String loginType) {
    // 根据用户的id 来查询出对应的
    Integer userId = Integer.valueOf(String.valueOf(loginId));
    List permissionList = redisUtil.getCacheList(RedisKey.getUserPermissionList(userId));
    return permissionList;
}

@Override
public List getRoleList(Object loginId, String loginType) {
    // 获取缓存
    Integer userId = Integer.valueOf(String.valueOf(loginId));
    List roleList = redisUtil.getCacheList(RedisKey.getUserRoleList(userId));
    return roleList;
}

}

```

增加GlobalException 用于捕获全局异常类

```java package com.example.gateway_test.exception;

import cn.dev33.satoken.exception.NotLoginException; import cn.dev33.satoken.exception.NotPermissionException; import cn.dev33.satoken.exception.NotRoleException; import com.example.common.api.CommonResult; import lombok.extern.slf4j.Slf4j; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.ResponseBody;

/** * @author zhangyang * @version 1.0 * @Date 2023/5/17 13:40 * @Description 拦截全局异常类 */ @Slf4j public class GlobalException {

@ResponseBody
@ExceptionHandler
public CommonResult