Redis

关注公众号 jb51net

关闭
首页 > 数据库 > Redis > Redis短信登录

Satoken+Redis实现短信登录、注册、鉴权功能

作者：阿辉___

这篇文章主要介绍了Satoken+Redis实现短信登录、注册、鉴权功能,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧

Springboot集成Satoken

添加依赖

注：如果你使用的是 SpringBoot 3.x，只需要将 sa-token-spring-boot-starter 修改为 sa-token-spring-boot3-starter 即可。

<!-- Sa-Token 权限认证，在线文档：https://sa-token.cc -->
<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>1.34.0</version>
</dependency>

设置配置文件

# 端口
server.port=8081
############## Sa-Token 配置 (文档: https://sa-token.cc) ##############
# token名称 (同时也是cookie名称)
sa-token.token-name=satoken
# token有效期，单位s 默认30天, -1代表永不过期 
sa-token.timeout=2592000
# token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒
sa-token.activity-timeout=-1
# 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录) 
sa-token.is-concurrent=true
# 在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token) 
sa-token.is-share=true
# token风格
sa-token.token-style=uuid
# 是否输出操作日志 
sa-token.is-log=false

启动类

在项目中新建包 com.pj ，在此包内新建主类 SaTokenDemoApplication.java，复制以下代码：

@SpringBootApplication
public class SaTokenDemoApplication {
    public static void main(String[] args) throws JsonProcessingException {
        SpringApplication.run(SaTokenDemoApplication.class, args);
        System.out.println("启动成功：Sa-Token配置如下：" + SaManager.getConfig());
    }
}

登录

用户输入手机号，调用登录接口，根据手机号查询是否存在该用户

@PostMapping("/login")
public Boolean login(@RequestBody String phone) {
  //从数据库查询该手机号的用户
  User user = userInfoDao.selectUser(phone);
  //若不存在该用户返回false，存在返回true
  return user == null ? false : true;
}

确认用户存在后就可以调用发送验证码接口，再校验验证码是否正确

/**
 * 发送验证码：
 * 在redis中用hash存储用户的相关信息，用PHONE_NUM+手机号作为用户hash的key，
 * “code”作为用户信息hash中验证码的小key，查询redis中用户的验证码信息，
 * "num"是验证次数的小key
 */
@PostMapping("/sendCaptcha")
public String sendCaptcha(String phone){
    //验证码verCode
    String verCode;
    String key = "PHONE_NUM"+phone;
    //如果redis中有缓存的验证码
    Object object = redisTemplate.opsForHash().get(key, "code");
    if(null != object){
        throw Error("该用户验证码已发送，且未过期，请输入验证码登录或注册！");
    }else {
        Random r = new Random(System.currentTimeMillis());
        int low = 100000;
        int high = 999999;
        //根据时间随机生成验证码verCode，将其放入redis中
        int code = (r.nextInt(high - low) + low);
        verCode = String.valueOf(code);
        redisTemplate.opsForHash().put(key,"code",verCode);
        //放入检验次数num=5
        redisTemplate.opsForHash().put(key,"num",5);
        //设置过期时间
        redisTemplate.expire(key,60*5,TimeUnit.SECONDS);
    }
    try {
        //调用发送验证码的接口发送验证码
        String smsResult= sendMsg(phone, verCode);
    }catch (Throwable throwable){
        redisTemplate.delete(key);
        throw Error("短信发送失败！");
    }
    return "发送成功";
}

重点！！！

/**
 * 校验验证码：
 * 验证成功就StpUtil.login(user.getId())进行登录，自动生成token并写入cookie中
 */
@PostMapping("/checkCaptcha")
public String checkCaptcha(String phone,String verCode){
    if(phone==null||verCode==null||phone==""||verCode==""){
        throw Errorr("请输入手机及验证码！");
    }
    //从redis中获取该手机号用户的信息
    String key = "PHONE_NUM"+phone;
    Object object = redisTemplate.opsForHash().get(key, "code");
    if(null == object){
        throw Error("未请求验证码或验证码已失效，请重新登录！");
    }
    String code= object.toString();
    if(code.equals(verCode)){
        //验证码比对正确，删除redis中验证码记录
        redisTemplate.delete(key);
        //从数据库查询出该用户的信息，并调用stputil进行登录
        User user = userService.findUser(phone);
        StpUtil.login(user.getId());
        return "登陆成功";
    }else{
        //验证码比对错误，校验次数减1
        double num = redisTemplate.opsForHash().increment(key,"num",-1);
        //若校验次数小于0则验证码失效，不小于0则抛出验证码错误
        if(num < 0 ){
            redisTemplate.delete(key);
            return "未请求验证码或验证码已失效，请重新登录！";
        } else {
            return "验证码错误！";
        }
    }
}

注销

@PostMapping("/logout")
public Boolean logout() {
    if (!StpUtil.isLogin()) {
    throw Error("未检测到登录信息，请先登录！");
    }
    StpUtil.logout();
    return true;
}

注册

填入手机号后，若调用登录接口根据手机号查询数据库发现不存在该用户，自动跳转到注册页面

@PostMapping("/regist)
public Boolean regist(String userName，String verCode) {
    if(userName==null||verCode==null||userName==""||verCode==""){
        throw Errorr("请输入用户名或验证码！");
    }
    查询数据库检查该用户名是否已经被用；
    调用上面登录里的校验用户验证码的方法；
    用户名未被占用且验证码正确，则向数据库用户表插入该用户信息，得到用户id；
    //调用stputil进行登录
    StpUtil.login(userId());
    return true；
}

重写获取权限或角色的接口

接口的调用往往需要权限的校验，一般的系统会给用户绑定某种角色，再给此角色分配权限，设置权限码，具有此角色或者权限码才放行请求。sa-token实现权限需要进行自定义扩展，下面是获取一个用户权限码集合和角色标识集合的类：

/**
 * 自定义权限验证接口扩展
 */
@Component    // 保证此类被SpringBoot扫描，完成Sa-Token的自定义权限验证扩展
public class StpInterfaceImpl implements StpInterface {
    /**
     * 返回一个账号所拥有的权限码集合
     */
    @Override
    public List<String> getPermissionList(Object loginId, String loginType) {
        List<String> list = new ArrayList<String>();
        //1.先从redis中根据loginId取该用户的权限，有则直接返回
        //2.若是redis中没有，则从数据库中查询，再把结果添加到redis中
        return list;
        // 比如：
        // list.add("101");
        // list.add("user.add");
        // list.add("user.update");
        // list.add("user.get");
        // list.add("user.delete");
        // list.add("art.*");
    }
    /**
     * 返回一个账号所拥有的角色标识集合 (权限与角色可分开校验)
     */
    @Override
    public List<String> getRoleList(Object loginId, String loginType) {
         List<String> list = new ArrayList<String>();
        //1.先从redis中根据loginId取该用户的角色集合，有则直接返回
        //2.若是redis中没有，则从数据库中查询，再把结果添加到redis中
        return list;
        // 比如：
        // list.add("admin");
        // list.add("super-admin");
    }
}

路由拦截实现鉴权

在调用后台服务时，我们可以在路由时做一些拦截，例如添加登陆权限拦截、放开一些接口白名单等。（一定要排除 登录、注册、发送验证码等接口 的拦截）

@Configuration
public class SaTokenConfigure implements WebMvcConfigurer {
    // 注册 Sa-Token 的拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册路由拦截器，自定义认证规则
        registry.addInterceptor(new SaInterceptor(handler -> {
            //SaRouter.match（参数一：需要拦截的路由，
                              参数二：可排除的路由，
                              参数三：用来检验是否通过拦截的方法）
            // 登录校验 -- 用是否登录拦截所有路由，
            // 在最下面的.excludePathPatterns中并排除登录等接口的拦截
            SaRouter.match("/**", r -> StpUtil.checkLogin());
            // 角色校验 -- 拦截以 admin 开头的路由，必须具备 admin 角色或者 super-admin 角色才可以通过认证
            SaRouter.match("/admin/**", r -> StpUtil.checkRoleOr("admin", "super-admin"));
            // 权限校验 -- 不同模块校验不同权限
            SaRouter.match("/user/**", r -> StpUtil.checkPermission("user"));
            SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
            SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
            SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
            SaRouter.match("/notice/**", r -> StpUtil.checkPermission("notice"));
            SaRouter.match("/comment/**", r -> StpUtil.checkPermission("comment"));
            // 甚至你可以随意的写一个打印语句
            SaRouter.match("/**", r -> System.out.println("----啦啦啦----"));
            // 连缀写法
            SaRouter.match("/**").check(r -> System.out.println("----啦啦啦----"));
        })).addPathPatterns("/**")
           // 排除登录、注册、发送验证码等接口 的拦截
           .excludePathPatterns("/user/login")
           .excludePathPatterns("/user/sendCaptcha")
           .excludePathPatterns("/user/checkCaptcha")
           .excludePathPatterns("/user/regist")
        ;
    }
}

到此这篇关于Satoken+Redis实现短信登录、注册、鉴权的文章就介绍到这了,更多相关Redis短信登录内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文