开发公司SpringCloud整合Sa-Token登录认证+Gateway网关拦截

Sa-Token介绍：Sa-Token 开发公司是一个轻量级 Java 开发公司权限认证框架，主要解决：登录认证、权限认证、单点登录、OAuth2.0、分布式Session会话、开发公司微服务网关鉴权 开发公司等一系列权限相关问题

开发公司本文章框架使用：

SpringCloudAlibaba、SpringBoot2.1.13、sa-token1.30.0、redis

服务架构

 开始

一、开发公司首先配置服务

1、pom.xml

  1.       <!-- Sa-Token 权限认证（Reactor开发公司响应式集成） -->
  2.         <dependency>
  3.             <groupId>cn.dev33</groupId>
  4.             <artifactId>sa-token-reactor-spring-boot-starter</artifactId>
  5.             <version>1.30.0</version>
  6.         </dependency>
  7.         <!-- Sa-Token 整合 Redis (使用jackson开发公司序列化方式) -->
  8.         <dependency>
  9.             <groupId>cn.dev33</groupId>
  10.             <artifactId>sa-token-dao-redis-jackson</artifactId>
  11.             <version>1.30.0</version>
  12.         </dependency>
  13.         <!--GateWay 网关-->
  14.         <dependency>
  15.             <groupId>org.springframework.cloud</groupId>
  16.             <artifactId>spring-cloud-starter-gateway</artifactId>
  17.         </dependency>

2、bootstrap.yml引入sa-token配置

  1.  
  2. # Sa-Token配置
  3. sa-token:
  4.   # token名称 (同时也是cookie名称)
  5.   token-name: satoken
  6.   # token有效期，单位秒，-1开发公司代表永不过期
  7.   timeout: 2592000
  8.   # token开发公司临时有效期 (开发公司指定时间内无操作就视为token过期)，单位秒
  9.   activity-timeout: -1
  10.   # 开发公司是否允许同一账号并发登录 (为false开发公司时新登录挤掉旧登录)
  11.   is-concurrent: true
  12.   # 开发公司在多人登录同一账号时，是否共用一个token (为false时每次登录新建一个token)
  13.   is-share: false
  14.   # token风格
  15.   token-style: uuid
  16.   # 是否输出操作日志
  17.   is-log: false
  18.   # 是否从cookie中读取token
  19.   is-read-cookie: false
  20.   # 是否从head中读取token
  21.   is-read-head: true

3、新建类SaTokenConfigure，实现网关拦截

  1. package com.frontop.meta.config;
  2.  
  3. import cn.dev33.satoken.config.SaTokenConfig;
  4. import cn.dev33.satoken.context.SaHolder;
  5. import cn.dev33.satoken.reactor.context.SaReactorSyncHolder;
  6. import cn.dev33.satoken.reactor.filter.SaReactorFilter;
  7. import cn.dev33.satoken.router.SaHttpMethod;
  8. import cn.dev33.satoken.router.SaRouter;
  9. import cn.dev33.satoken.stp.StpUtil;
  10. import cn.dev33.satoken.util.SaResult;
  11. import com.frontop.meta.util.ResultJsonUtil;
  12. import org.springframework.context.annotation.Bean;
  13. import org.springframework.context.annotation.Configuration;
  14. import org.springframework.context.annotation.Primary;
  15. import org.springframework.web.server.ServerWebExchange;
  16.  
  17. /**
  18.  * @author YangBoss
  19.  * @title: SaTokenConfigure
  20.  * @projectName meta
  21.  * @description: TODO
  22.  * @date 2022/8/18 10:12
  23.  */
  24. @Configuration
  25. public class SaTokenConfigure {
  26.     // 注册 Sa-Token全局过滤器
  27.     @Bean
  28.     public SaReactorFilter getSaReactorFilter() {
  29.         return new SaReactorFilter()
  30.                 // 拦截地址
  31.                 .addInclude("/**")
  32.                 // 开放地址
  33.                 .addExclude("/favicon.ico")
  34.                 // 鉴权方法：每次访问进入
  35.                 .setAuth(obj -> {
  36.                     // 登录校验 -- 拦截所有路由，并排除/user/doLogin 用于开放登录
  37.                     SaRouter.match("/**", "/meta-auth/phoneLogin", r -> StpUtil.checkLogin());
  38.                     // 角色认证 -- 拦截以 admin 开头的路由，必须具备 admin 角色或者 super-admin 角色才可以通过认证
  39.                     SaRouter.match("/admin/**", r -> StpUtil.checkRoleOr("admin", "super-admin"));
  40.                     // 权限认证 -- 不同模块, 校验不同权限
  41.                     SaRouter.match("/meta-system/**", r -> StpUtil.checkPermission("system-no"));
  42.                     SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
  43.                     SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
  44.                     SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
  45.                 })
  46.                 // 异常处理方法：每次setAuth函数出现异常时进入
  47.                 .setError(e -> {
  48.                     // 设置错误返回格式为JSON
  49.                     ServerWebExchange exchange = SaReactorSyncHolder.getContext();
  50.                     exchange.getResponse().getHeaders().set("Content-Type", "application/json; charset=utf-8");
  51. //                    return new ResultJsonUtil().fail(e.getMessage());
  52.                     return SaResult.error(e.getMessage());
  53.                 })
  54.                 .setBeforeAuth(obj -> {
  55.                     // ---------- 设置跨域响应头 ----------
  56.                     SaHolder.getResponse()
  57.                             // 允许指定域访问跨域资源
  58.                             .setHeader("Access-Control-Allow-Origin", "*")
  59.                             // 允许所有请求方式
  60.                             .setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE")
  61.                             // 有效时间
  62.                             .setHeader("Access-Control-Max-Age", "3600")
  63.                             // 允许的header参数
  64.                             .setHeader("Access-Control-Allow-Headers", "*");
  65.  
  66.                     // 如果是预检请求，则立即返回到前端
  67.                     SaRouter.match(SaHttpMethod.OPTIONS)
  68.                             .free(r -> System.out.println("--------OPTIONS预检请求，不做处理"))
  69.                             .back();
  70.                 });
  71.     }
  72.  
  73.  
  74. }

4、新建全局异常处理类GlobalException

  1. package com.frontop.meta.config;
  2.  
  3. import cn.dev33.satoken.exception.DisableLoginException;
  4. import cn.dev33.satoken.exception.NotLoginException;
  5. import cn.dev33.satoken.exception.NotPermissionException;
  6. import cn.dev33.satoken.exception.NotRoleException;
  7. import com.frontop.meta.constant.ResponseCodeConstant;
  8. import com.frontop.meta.constant.ResponseMessageConstant;
  9. import com.frontop.meta.util.ResultJsonUtil;
  10. import org.springframework.web.bind.annotation.ExceptionHandler;
  11. import org.springframework.web.bind.annotation.ResponseBody;
  12.  
  13. /**
  14.  * @author YangBoss
  15.  * @title: GlobalException
  16.  * @projectName meta
  17.  * @description: 拦截全局异常类
  18.  * @date 2022/8/19 15:39
  19.  */
  20. public class GlobalException {
  21.     // 全局异常拦截（拦截项目中的所有异常）
  22.     @ResponseBody
  23.     @ExceptionHandler
  24.     public ResultJsonUtil<Object> handlerException(Exception e) {
  25.  
  26.         // 打印堆栈，以供调试
  27. //        System.out.println("全局异常---------------");
  28.         e.printStackTrace();
  29.  
  30.         // 不同异常返回不同状态码
  31.         ResultJsonUtil<Object> re = null;
  32.         if (e instanceof NotLoginException) {	// 如果是未登录异常
  33.             NotLoginException ee = (NotLoginException) e;
  34.             re =  new ResultJsonUtil().customized(
  35.                     ResponseCodeConstant.OAUTH_TOKEN_FAILURE,
  36.                     ResponseMessageConstant.OAUTH_TOKEN_MISSING,
  37.                     null
  38.             );
  39.         }
  40.         else if(e instanceof NotRoleException) {		// 如果是角色异常
  41.             NotRoleException ee = (NotRoleException) e;
  42.             re =  new ResultJsonUtil().customized(
  43.                     ResponseCodeConstant.OAUTH_TOKEN_DENIED,
  44.                     "无此角色：" + ee.getRole(),
  45.                     null
  46.             );
  47.         }
  48.         else if(e instanceof NotPermissionException) {	// 如果是权限异常
  49.             NotPermissionException ee = (NotPermissionException) e;
  50.             re =  new ResultJsonUtil().customized(
  51.                     ResponseCodeConstant.OAUTH_TOKEN_DENIED,
  52.                     "无此角色：" + ee.getCode(),
  53.                     null
  54.             );
  55.         }
  56.         else if(e instanceof DisableLoginException) {	// 如果是被封禁异常
  57.             DisableLoginException ee = (DisableLoginException) e;
  58.             re =  new ResultJsonUtil().customized(
  59.                     ResponseCodeConstant.USER_LOCK,
  60.                     "账号被封禁：" + ee.getDisableTime() + "秒后解封",
  61.                     null
  62.             );
  63.         }
  64.         else {	// 普通异常, 输出：500 + 异常信息
  65.             re =  new ResultJsonUtil().fail(e.getMessage());
  66.         }
  67.  
  68.         // 返回给前端
  69.         return re;
  70.     }
  71. }

5、新建类StpInterfaceImpl，实现获取当前账号权限角色集合

  1. package com.frontop.meta.config;
  2.  
  3. import cn.dev33.satoken.stp.StpInterface;
  4. import org.springframework.stereotype.Component;
  5.  
  6. import java.util.ArrayList;
  7. import java.util.List;
  8.  
  9. /**
  10.  * @author YangBoss
  11.  * @title: StpInterfaceImpl
  12.  * @projectName meta
  13.  * @description: TODO
  14.  * @date 2022/8/18 10:26
  15.  */
  16. @Component
  17. public class StpInterfaceImpl implements StpInterface {
  18.     /**
  19.     *当前全部是模拟数据，真实情况使用根据loginId动态查询对应角色和权限
  20.     */
  21.     @Override
  22.     public List<String> getPermissionList(Object loginId, String loginType) {
  23.         // 返回此 loginId 拥有的权限列表
  24.         List<String> strs = new ArrayList<>();
  25.         strs.add("system");
  26.         return strs;
  27.     }
  28.  
  29.     @Override
  30.     public List<String> getRoleList(Object loginId, String loginType) {
  31.         // 返回此 loginId 拥有的角色列表
  32.         List<String> strs = new ArrayList<>();
  33.         strs.add("admin");
  34.         return strs;
  35.     }
  36.  
  37. }

二、配置授权服务

1、pom.xml

  1.  <!-- Sa-Token 权限认证, 在线文档：http://sa-token.dev33.cn/ -->
  2.         <dependency>
  3.             <groupId>cn.dev33</groupId>
  4.             <artifactId>sa-token-spring-boot-starter</artifactId>
  5.             <version>1.30.0</version>
  6.         </dependency>
  7.  
  8.  
  9.         <!-- Sa-Token 整合 Redis (使用jackson序列化方式) -->
  10.         <dependency>
  11.             <groupId>cn.dev33</groupId>
  12.             <artifactId>sa-token-dao-redis-jackson</artifactId>
  13.             <version>1.30.0</version>
  14.         </dependency>

2、bootstarp.yml引入sa-token配置

  1.  
  2. # Sa-Token配置
  3. sa-token:
  4.   # token名称 (同时也是cookie名称)
  5.   token-name: satoken
  6.   # token有效期，单位秒，-1代表永不过期
  7.   timeout: 2592000
  8.   # token临时有效期 (指定时间内无操作就视为token过期)，单位秒
  9.   activity-timeout: -1
  10.   # 是否允许同一账号并发登录 (为false时新登录挤掉旧登录)
  11.   is-concurrent: true
  12.   # 在多人登录同一账号时，是否共用一个token (为false时每次登录新建一个token)
  13.   is-share: false
  14.   # token风格
  15.   token-style: uuid
  16.   # 是否输出操作日志
  17.   is-log: false
  18.   # 是否从cookie中读取token
  19.   is-read-cookie: false
  20.   # 是否从head中读取token
  21.   is-read-head: true

3、编写一个简单的登录

  1. package com.frontop.meta.controller;
  2.  
  3. import cn.dev33.satoken.stp.StpUtil;
  4. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  5. import com.frontop.meta.util.ResultJsonUtil;
  6. import io.swagger.annotations.Api;
  7. import io.swagger.annotations.ApiOperation;
  8. import org.springframework.web.bind.annotation.GetMapping;
  9. import org.springframework.web.bind.annotation.PostMapping;
  10. import org.springframework.web.bind.annotation.RestController;
  11.  
  12. /**
  13.  * @author YangBoss
  14.  * @title: UserLoginController
  15.  * @projectName meta
  16.  * @description: TODO
  17.  * @date 2022/8/19 14:44
  18.  */
  19. @RestController
  20. @Api(tags = "用户授权登录")
  21. public class UserLoginController {
  22.  
  23.     @ApiOperation(value = "手机+密码登录")
  24.     @PostMapping("/phoneLogin")
  25.     public ResultJsonUtil<Object> getAwardCount(String phone,String password) {
  26.         
  27.         if(phone.equals("18874288923") && password.equals("123")){
  28.             StpUtil.login(1001,"PC");
  29.             return new ResultJsonUtil().success(StpUtil.getTokenInfo());
  30.         }
  31.         return new ResultJsonUtil().fail("手机号或密码错误");
  32.     }
  33.  
  34.  
  35. }

三、测试效果

1、启动网关服务和授权服务后调用登录接口

 redis中

 到这里简单的登录就完成了

2、在system业务服务中简单配置一个测试接口

 system业务服务中也需要引入sa-token，bootsrap.yml配置都是一样的

  1. <!-- Sa-Token 权限认证（Reactor响应式集成）, 在线文档：http://sa-token.dev33.cn/ -->
  2.         <dependency>
  3.             <groupId>cn.dev33</groupId>
  4.             <artifactId>sa-token-reactor-spring-boot-starter</artifactId>
  5.             <version>1.30.0</version>
  6.         </dependency>
  7.         <!-- Sa-Token 整合 Redis (使用jackson序列化方式) -->
  8.         <dependency>
  9.             <groupId>cn.dev33</groupId>
  10.             <artifactId>sa-token-dao-redis-jackson</artifactId>
  11.             <version>1.30.0</version>
  12.         </dependency>

3、不携带token值访问接口

 4、携带token访问 

这里报无权限的原因就是网关实现了拦截，在上面配置中网关配置了meta-system路由的权限必须使用system-no

而我们在添加权限集合时候没有该权限所以被拦截 

角色拦截配置也是类似

四、使用注解拦截

1、如果想使用注解拦截，只能写在业务服务的接口层

2、首先要在业务服务中开启注解拦截配置

  1. package com.frontop.meta;
  2.  
  3. import cn.dev33.satoken.interceptor.SaAnnotationInterceptor;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
  6. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  7.  
  8. /**
  9.  * @author YangBoss
  10.  * @title: SaTokenConfigure
  11.  * @projectName meta
  12.  * @description: TODO
  13.  * @date 2022/9/7 10:53
  14.  */
  15. @Configuration
  16. public class SaTokenConfigure implements WebMvcConfigurer {
  17.     // 注册Sa-Token的注解拦截器，打开注解式鉴权功能
  18.     @Override
  19.     public void addInterceptors(InterceptorRegistry registry) {
  20.         // 注册注解拦截器，并排除不需要注解鉴权的接口地址 (与登录拦截器无关)
  21.         registry.addInterceptor(new SaAnnotationInterceptor()).addPathPatterns("/**");
  22.     }
  23. }

3、也需要配置获取角色和权限的集合类

  1. package com.frontop.meta;
  2.  
  3. import cn.dev33.satoken.stp.StpInterface;
  4. import org.springframework.stereotype.Component;
  5.  
  6. import java.util.ArrayList;
  7. import java.util.List;
  8.  
  9. /**
  10.  * @author YangBoss
  11.  * @title: StpInterfaceImpl
  12.  * @projectName meta
  13.  * @description: TODO
  14.  * @date 2022/8/18 10:26
  15.  */
  16. @Component
  17. public class StpInterfaceImpl implements StpInterface {
  18.  
  19.     @Override
  20.     public List<String> getPermissionList(Object loginId, String loginType) {
  21.         // 返回此 loginId 拥有的权限列表
  22.         List<String> strs = new ArrayList<>();
  23.         strs.add("system-no");
  24.         return strs;
  25.     }
  26.  
  27.     @Override
  28.     public List<String> getRoleList(Object loginId, String loginType) {
  29.         // 返回此 loginId 拥有的角色列表
  30.         List<String> strs = new ArrayList<>();
  31.         strs.add("admin");
  32.         return strs;
  33.     }
  34.  
  35. }

4、接口配置注解拦截

  1. @RestController
  2. @RequestMapping("/test")
  3. @Api(tags = "测试")
  4. public class TestContorller {
  5.  
  6.     @ApiOperation(value = "请求汇总",consumes = "application/json;charset=UTF-8")
  7.     @RequestMapping(value = "/apiGather", method = RequestMethod.POST)
  8.     @SaCheckRole("super-admin2")//必须拥有该角色可访问
  9.     @SaCheckPermission("system-no")//必须拥有该权限可访问
  10.     public ResultJsonUtil<Object> apiGather(){
  11.         return new ResultJsonUtil().success("111");
  12.     }
  13.  
  14. }

5、测试效果

 

网站建设定制开发 软件系统开发定制 定制软件开发 软件开发定制 定制app开发 app开发定制 app开发定制公司 电商商城定制开发 定制小程序开发 定制开发小程序 客户管理系统开发定制 定制网站 定制开发 crm开发定制 开发公司 小程序开发定制 定制软件 收款定制开发 企业网站定制开发 定制化开发 android系统定制开发 定制小程序开发费用 定制设计 专注app软件定制开发 软件开发定制定制 知名网站建设定制 软件定制开发供应商 应用系统定制开发 软件系统定制开发 企业管理系统定制开发 系统定制开发