SpringBoot + Redis验证码缓存校验

时间久了 大多解释都在注释里面 回顾一下:

用户登录时需要用手机号生成验证码,然后用验证码进行登录

这里先通过手机号生成验证码,存储在redis里,登录时我们去进行判断是否与redis中的相同

上代码:

package.png

配置项

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.liyanyan</groupId>
    <artifactId>test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>test</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!--web核心依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--mysql数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <!--mybatis-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.0</version>
        </dependency>

        <!-- pageHelper Springboot和Spring引用的包不一样 这里请注意 要不然分页不起作用 引用的是Spring包的话会一直查出所有的值 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.5</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.apache.shiro/shiro-core -->
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-core</artifactId>
            <version>1.4.0</version>
        </dependency>

        <!--集成redis-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!-- fastjson json转换器 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.47</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

主要用的是集成 redis 的pom文件 导入后进行maven --> reimport

server.port=8080
# spring.datasource.url=jdbc:mysql://127.0.0.1:3306/shope_springboot?serverTimezone=UTC&characterEncoding=UTF-8
spring.datasource.username=root
spring.datasource.password=admin
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

mybatis.mapper-locations= classpath:mapper/*.xml
mybatis.type-aliases-package= com.liyanyan.test.pojo

pagehelper.helper-dialect=mysql
pagehelper.reasonable=true
pagehelper.support-methods-arguments=true
pagehelper.params=count=countSql

# Redis服务器地址
spring.redis.host=127.0.0.1
# Redis数据库索引(默认为0)
spring.redis.database=0
# Redis服务器连接端口号
spring.redis.port=6379
# 连接池中最大连接数(使用负值则表示没有限制)
spring.redis.jedis.pool.max-active=8
# 连接池中最大阻塞等待时间(使用负值则表示没有限制)
spring.redis.jedis.pool.max-wait=-1ms
# 连接池中的最大空闲连接
spring.redis.jedis.pool.max-idle=8
# 连接池中的最小空闲连接
spring.redis.jedis.pool.min-idle=0
# 连接超时时间
spring.redis.timeout=3000ms

上面为application.properties 配置文件 我们用到的也就只是redis相关的配置

包装返回结果

CommonResult

package com.liyanyan.tiny3.api;

public class CommonResult<T> {
    private long code;
    private String name;
    private T data;
    public long getCode() {
        return code;
    }
    public void setCode(long code) {
        this.code = code;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public T getData() {
        return data;
    }
    public void setData(T data) {
        this.data = data;
    }
    public CommonResult() {
    }
    public CommonResult(long code, String name, T data) {
        this.code = code;
        this.name = name;
        this.data = data;
    }
    public CommonResult(ResultCode resultCode, T data) {
        this.code = resultCode.getCode();
        this.name = resultCode.getMessage();
        this.data = data;
    }
    public CommonResult(ResultCode resultCode) {
        this.code = resultCode.getCode();
        this.name = resultCode.getMessage();
    }
}

ResultCode

package com.liyanyan.tiny3.api;

public enum ResultCode {
    SUCCESS(200, "操作成功"),
    FAILED(500, "操作失败"),
    VALIDATE_FAILED(404, "参数教研失败"),
    UNAUTHORIZED(401, "暂未登录或token已过期"),
    FORBIDDEN(403, "没有相关权限");
    private long code;
    private String message;
    ResultCode(long code, String message) {
        this.code = code;
        this.message = message;
    }
    public long getCode() {
        return code;
    }
    public void setCode(long code) {
        this.code = code;
    }
    public String getMessage() {
        return message;
    }
    public void setMessage(String message) {
        this.message = message;
    }
}

Controller层

UmsMemberController

package com.liyanyan.tiny3.controller;

import com.liyanyan.tiny3.api.CommonResult;
import com.liyanyan.tiny3.service.UmsMemberService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
/**
 * 添加根据电话号码获取验证码的接口和校验码的接口
 *
 * 会员登录注册管理
 */
@RestController
@Api(tags = "UmsMemberController", description = "会员登录注册管理")
@RequestMapping("/sso")
public class UmsMemberController {
    @Autowired
    private UmsMemberService umsMemberService;
    @ApiOperation("获取验证码")
    @GetMapping("/getAuthCode")
    public CommonResult getAuthCode(@RequestParam String telephone) {
        return umsMemberService.generateAuthCode(telephone);
    }
    @ApiOperation("判断验证码是否正确")
    @PostMapping("/verifyAuthCode")
    public CommonResult verifyAuthCode(@RequestParam String telephone, @RequestParam String authCode) {
        return umsMemberService.verifyAuthCode(telephone, authCode);
    }
}

Service层

RedisService

package com.liyanyan.tiny3.service;

/**
 * redis操作Service
 * 对象和数组都以json进行存储
 */
public interface RedisService {
    /**
     * 存储数据
     */
    void set(String key, String value);
    /**
     * 获取数据
     */
    String get(String key);
    /**
     * 设置超期时间
     */
    boolean expire(String key, long expire);
    /**
     * 删除数据
     */
    void remove(String key);
    /**
     * 自增操作
     */
    Long increment(String key, long date);
}

UmsMemberService

package com.liyanyan.tiny3.service;

import com.liyanyan.tiny3.api.CommonResult;
public interface UmsMemberService {
    /**
     * 生成验证码
     * @param telephone
     * @return
     */
    CommonResult generateAuthCode(String telephone);
    /**
     * 判断验证码和手机号码能否匹配的上
     * @param telephone
     * @param authCode
     * @return
     */
    CommonResult verifyAuthCode(String telephone, String authCode);
}

RedisServiceImpl

package com.liyanyan.tiny3.service.impl;

import com.liyanyan.tiny3.service.RedisService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Service;
import java.util.concurrent.TimeUnit;
/**
 * redis 操作Service 的实现类 注入stringRedisTemplate,实现RedisService接口
 */
@Service
public class RedisServiceImpl implements RedisService {
    @Autowired
    private StringRedisTemplate stringRedisTemplate;
    @Override
    public void set(String key, String value) {
        stringRedisTemplate.opsForValue().set(key, value);
    }
    @Override
    public String get(String key) {
        return stringRedisTemplate.opsForValue().get(key);
    }
    @Override
    public boolean expire(String key, long expire) {
        return stringRedisTemplate.expire(key, expire, TimeUnit.SECONDS);
    }
    @Override
    public void remove(String key) {
        stringRedisTemplate.delete(key);
    }
    @Override
    public Long increment(String key, long delta) {
        return stringRedisTemplate.opsForValue().increment(key, delta);
    }
}

UmsMemberServiceImpl

package com.liyanyan.tiny3.service.impl;

import com.liyanyan.tiny3.api.CommonResult;
import com.liyanyan.tiny3.api.ResultCode;
import com.liyanyan.tiny3.service.RedisService;
import com.liyanyan.tiny3.service.UmsMemberService;
import com.liyanyan.tiny3.utils.RedisUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;
import java.util.Random;
/**
 * 会员管理Service实现类 
 * 生成验证码时,将自定义的Redis的前缀 加上 手机号作为 一个redis的key ,生成的验证码为这个key对应的value值 并存在redis中,而且设置了过期时间
 * 我们设置的是 120s
 * 验证的时候,我们先用验证码和手机号来获取 redis里的value(真实验证码) 与 传过来的 验证码 进行比对
 */
@Service
public class UmsMemberServiceImpl implements UmsMemberService {
    @Autowired
    private RedisService redisService;
    @Override
    public CommonResult generateAuthCode(String telephone) {
        StringBuilder stringBuilder = new StringBuilder();
        Random random = new Random();
        for( int i=0; i<6; i++) {
            stringBuilder.append(random.nextInt(10));
        }
        //验证码绑定手机号并存储到redis中
        redisService.set(RedisUtils.REDIS_UMS_PREFIX+telephone, stringBuilder.toString());
        redisService.expire(RedisUtils.REDIS_UMS_PREFIX+telephone, RedisUtils.REDIS_UMS_EXPIRE);
        return new CommonResult(ResultCode.SUCCESS, stringBuilder.toString());
    }
    /**
     * 对输入的验证码进行校验
     * @param telephone
     * @param authCode
     * @return
     */
    @Override
    public CommonResult verifyAuthCode(String telephone, String authCode) {
        if(StringUtils.isEmpty(authCode)) {
            return new CommonResult(ResultCode.VALIDATE_FAILED, "请输入验证码");
        }
        String realAuthCode = redisService.get(RedisUtils.REDIS_UMS_PREFIX+telephone);
        boolean result = authCode.equals(realAuthCode);
        if(result) {
            return new CommonResult(ResultCode.SUCCESS, realAuthCode + "+_+" + authCode);
        }else {
            return new CommonResult(ResultCode.VALIDATE_FAILED, realAuthCode + "+_+" + authCode);
        }
    }
}

Utils层

package com.liyanyan.tiny3.utils;

public class RedisUtils {
    //为了保证 redis 的key不会因为 不同的业务可能会相同  所以一般会在这里加上前缀
    public static final String REDIS_UMS_PREFIX = "portal:authCode";
    //redis缓存过期时间 我们设置为 120s  一般验证码时间防止暴力破解 时间都很短
    public static final Long REDIS_UMS_EXPIRE = 120L;
}

Application

package com.liyanyan.tiny3;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class TinyApplication {
    public static void main(String[] args) {
        SpringApplication.run(TinyApplication.class, args);
    }
}

最后为程序启动类

启动前 记得先启动你的redis服务 以及对号你的redis的配置哦 不然redis会连不上滴。

祝好!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容