实际项目开发：Spring集成Redis，并实现短信登录功能

蚊子码农

已于 2024-06-23 22:16:06 修改

阅读量957

点赞数 28

文章标签： spring redis java 实际开发

于 2024-06-23 21:30:20 首次发布

本文链接：https://blog.csdn.net/weixin_62411896/article/details/139905575

版权

redis新手，学了几种基本数据类型，却不知道怎么使用？
总是一边学一边忘？
学会了Redis的大多数使用命令，却不知道如何在项目中使用？
本文将从实际出发，为大家解决这些问题。
我是蚊子码农，欢迎各位的点赞、关注和收藏，有了你们的激励，我会带来更好的作品。

一、环境准备

从环境出发。

第一，基础环境：

JDK版本：JDK1.8。
构建工具：Maven。
开发工具：IDEA。
基础依赖：SpringBoot通用依赖。
前后端验证机制：JWT令牌机制【如果是Token，可以看成一样；如果是cookie或session，则需要按情况改变】

第二，个人环境：

Redis环境（操作系统）：Windows10
使用的Redis客户端：lettuce

二、在pom文件导入Redis的相关依赖、配置Redis相关信息

注意：本文的基础，是已经安装好Redis，并且学会启动Redis服务器的用户。
简要安装步骤：来到Redis官网，按照版本下载—》解压Redis的压缩包到某个目录—》在这个解压包里，找到redis-server.exe打开服务器。【这个方法的好处是，不用配置系统变量，当然，也不能随时随地通过CMD命令启动Redis】

        <!--    redis的依赖    -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
            <version>2.11.1</version>

完成依赖的导入后，需要配置appliacation.yml文件的配置信息。
这个信息和MySQL非常类似，如下：

  redis:
    host: 127.0.0.1 # 服务器的IP地址
    port: 6379 # 默认端口号
    # 默认密码是null，如果设定密码则修改
    password: 
	# lettuce客户端
    lettuce:
      # 连接池的配置信息，和线程池类似
      pool:
        max-active: 8   # 最大连接数，负数表示无限制
        max-wait: -1    # 最大阻塞等待时间，负数则表示无限制
        max-idle: 8     # 连接池最大空闲连接

三、写Redis操作的通用类RedisUtil【基于StringRedisTemplate类】

在Spring集成Redis的项目中，通常可以使用RedisTemplate和StringRedisTemplate来操作Redis。
RedisTemplate<K, V>，是一个泛型类，允许很多种结构，灵活性很高。
而StringRedisTemplate<String, String>，继承自RedisTemplate，只允许字符串对字符串的映射，相对来说灵活性较差，但是开发字符串结构的业务，非常方便高效。
本文的短信验证机制，只需要String对String即可，因此，使用StringRedisTemplate开发。
工具类代码如下，本质只有读、写两个操作：

// 可以写接口和实现类，来充分解耦，本文不解耦
@Component
public class RedisUtil {
    @Autowired
    private StringRedisTemplate stringRedisTemplate;
    // 向Redis中，设定验证码【手机号映射code的方式】
    public void redisSetCode(String phone, String code){
	// 设定手机号、验证码、5分钟的过期时间【最后的参数，是时间单位】
        stringRedisTemplate.opsForValue().set(phone, code, 60 * 5, TimeUnit.SECONDS);
    }
    
    // 从Redis中得到验证码，如果返回null，表示没有这个phone，在此不做验证
    public String redisGetCode(String phone){
        return stringRedisTemplate.opsForValue().get(phone);
    }
}

四、短信登陆功能的开发步骤

短信登录验证是市面上最火的登录验证方式之一。
从B/S的交互角度来看，它一共有4步：

第一，用户输入手机号，并向服务器发送请求。
第二，服务器验证手机号有效性，生成验证码，并将验证码返回客户端。
第三，用户输入手机号、验证码，并向服务器发送请求。
第四，服务器验证二者的对应关系和有效性，返回结果。

我们可以发现，这个验证机制的关键只有2个，手机号、验证码。
二者有一对一的关系，为了保证安全，验证码还必须有过期策略。因此，在没有其它业务逻辑的情况下，可以使用redis方便地完成这个功能。
不使用MySQL的原因：该验证机制较为简单，使用MySQL却需要建立一张难以变化的表，很不值得，加上访问速度也没有Redis快。
本文面向后端用户，所以前端的开发流程在此不说明，我们重点关注以下步骤：

第一，得到手机号。

这一步，需要做至少3件事：

手机号有效性检测【判断数据库有没有这个人（如果该验证机制，不允许使用手机号注册的话）】
生成验证码
将验证码写进Redis
注：借用短信API将验证码发给用户。【这一步不好写】

第二，得到手机号、验证码

需要做2件事：

判断手机号与验证码是否对应
如果对应，返回个人信息；如果不对应，报错。

五、后端得到手机号

在开发前，我们要保证，前端传来的手机号没有异常。【在本文不判断手机号null的情况】

第一步，搜索数据库，查找有没有这个人

说明：这一步可以省略，可以直接返回验证码，等到用户拿到验证码后，再从数据库拿数据判断，这样可以节省一点后端资源。【不过，用户使用起来是比较难受的，所以建议先判断】
判断的代码比较简单，在此不说明。

第二步，生成验证码

这个业务，可能需要各种复用，干脆写成一个工具类。
代码如下：

public class GeneCodeUtil {
    // 验证码的范围，如果想使用复杂字符，可以写i、g、a、b等
    public static final String VERIFY_CODES = "1234567890";

	// 验证码生成函数，指定验证码的位数【比如4位验证码：1234、5144】
    public static String CodeGenerate(int verifySize){
        String sources = VERIFY_CODES;
        int codesLen = sources.length();
		// 以当前的毫秒数为种子，生成随机数
        Random rand = new Random(System.currentTimeMillis());
	
		// 使用StringBuilder结构存储数据
        StringBuilder sb = new StringBuilder(verifySize);
        for(int i = 0; i < verifySize; i++){
        	// 添加到sb里
            sb.append(sources.charAt(rand.nextInt(codesLen-1)));
        }
        return sb.toString();
    }
}

第三，将手机号、验证码写入Redis数据库。

由于我们已经写好了Redis的工具类，在此调用工具类的set方法即可。
下面的代码，是手机号发送的业务逻辑：
下面的一些类，比较简单，就不分开讲解了，我都在第一次使用时，做了说明。

	// 验证有效性，生成验证码，写入Redis数据库
    @PostMapping("/login")
    public CodeDTO loginGenerateCode(@RequestBody PhoneCodeDTO phoneCodeDTO){
    	// CodeDTO类：包含通用的返回信息、返回状态码；比如【1，验证码成功发送】
		// PhoneCodeDTO类：包含验证码、手机号，为了方便接收前端的数据，现在验证码属性为null

        String phone = phoneCodeDTO.getPhone();        
		// 查找有没有这个人
        String tempPhone = new String(phone);
        // Public类：一个数据类，不重要
        LambdaQueryWrapper<Public> publicLambdaQueryWrapper = new LambdaQueryWrapper<>();
        publicLambdaQueryWrapper.eq(Public::getPubNum,Long.parseLong(tempPhone));
		// 得到这个人
        Public pub = publicService.getOne(publicLambdaQueryWrapper);
		// 空表示没有，说明失败
        if(pub == null){
        	// codeFail：返回CodeDTO的对象，输入的数据，即为返回信息
            return CodeDTO.codeFail("不存在此用户");
        }

		// codeRedisAndSend：send函数做了2件事。。1.生成验证码；2.写入Redis服务器
        codeRedisAndSend.send(phone);
		// 可以在这里，写一些代码，调用信息发送API，将信息发送给用户

		// codeSuccess：返回CodeDTO对象，输入的数据为返回信息
        return CodeDTO.codeSuccess("验证码发送成功");
    }

六、阶段效果演示

使用Postman，发送请求给服务器
不存在用户时：
用户不存在时的展示
将该用户添加到数据库表中后：
验证码成功发布

七、后端拿到验证码、手机号

其实业务逻辑比较简单，所以直接看代码即可。

 	// 请求URL
    @RequestMapping("/codeLogin")
	// 效验验证码，如果有这个人，返回这个人的数据，JWT令牌
    public PublicDataDTO loginByCode(@RequestBody PhoneCodeDTO phoneCodeDTO){
        // PublicDataDTO类：包含用户信息、JWT令牌及一些附带信息
        // PhoneCodeDTO类：包含验证码、手机号信息
        
        String phone = phoneCodeDTO.getPhone();
		// 判断手机号、验证码是否对应，getCode方法是从Redis服务器拿到验证码
        if( phoneCodeDTO.getCode().equals(codeRedisAndSend.getCode(phone)) ){
             LambdaQueryWrapper<Public> publicLambdaQueryWrapper = new LambdaQueryWrapper<>();
             publicLambdaQueryWrapper.eq(Public::getPubNum,Long.parseLong(phone));
			// 得到此人信息
             Public pub = publicService.getOne(publicLambdaQueryWrapper);

			// getPublicDataDTO方法：返回一个PublicDataDTO对象
			// JWT令牌是JWT工具类生成的，传给前端，用作后续效验
             return PublicDataDTO.getPublicDataDTO(pub);
         }

		// 不相同，则返回null
         return PublicDataDTO.getPublicDataDTO(null);
    }