[SpringBoot]使用token 短信验证码 Redis的功能实现基本的登陆注册操作（含Redis token 验证码如何配置）

最新推荐文章于 2024-08-02 10:53:21 发布

原创最新推荐文章于 2024-08-02 10:53:21 发布 · 1.7k 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#redis #spring boot #java #数据库

本文介绍了使用SpringBoot实现登录注册功能，涉及Token、Redis和短信验证码的运用。通过Token减少服务器压力，利用Redis存储用户信息，短信验证码增强安全性。详细阐述了各模块的实现思路，并提供了部分代码示例，包括Redis的配置和使用，以及腾讯云短信服务的集成。

浅谈对于登录注册业务的思路以及部分代码的实现

近期开始了与移动端项目的开发，由于我个人是后台方面的所以肯定避免不了要实现每个app都应该具有的功能：登录与注册，我一开始写也是感觉非常的没有头绪，所以这里写一篇博客分享给大家如何实现一个基本的登录与注册的功能，希望有意见也积极提出！
那么首先先说一下标题提到的几个词汇的功能：

token

如果我们每次关闭客户端再次打开的时候都需要进行登录操作甚至是每次访问controller之前都需要进行是否登录的判断，那么每次如果都要访问持久化数据库的话，那么对于服务器的压力是很大的，于是就有了基于token的登录状态token在我看来就是根据时间戳，机型号，以及对应的用户id以及其它可以获得的一些信息运用算法生成的一个基本上不会重复的字符串，我们可以将这样一个字符串放到请求头里，然后我们使用这个字符串进行后续的交互就可以了，就可以不用每次都进行账号与密码的核对，减小服务器的压力。

短信验证码

我们也知道短信验证码也是现在app应用中重要的一环，那我们要如何实现这个功能呢？如果是自制简易app项目的话，那我们肯定就要借助一些第三方的sdk，像是阿里云阿，腾讯云阿这种服务平台上的服务，开通服务以后我们要找到对应的api文档然后进行对应的配置，然后就可以实现核对验证码的功能了。

Redis

运行在内存中的数据库，可以方便的存储一些需要用到的键值对，用法也比较简单，然后读写的速度也要比SQL要快很多，我们如果要运营一个项目一味的使用持久化数据库那样带来的压力会很大，所以我们也要考虑到什么东西应该放到内存数据库当中去，所以知道Redis也是很有必要的。

怎样与客户端进行交互？

其实与web端交互是差不了太多的，都是通过url来传递信息，然后获取到参数以后我们返回一个标准形式的json字符串，客户端接收到以后再做其他的操作，现在前后端分离是很明显的，我们后端开发就只需要返回他们需要的数据就足够了

登录与注册两个模块分别实现的大致思路:

这里由于用到的都是SpringBoot中的知识，详细的代码我也就不贴了就给大家一个思路即可有关于我上述说到的验证码、Redis、token后文我会做如何使用的补充

注册：

用户要注册先发送验证码验证
进入验证的接口，验证成功以后返回成功对应的json
然后进行基本信息的填写
提交以后后台进行持久化的保存返回成功

Redis如何使用？

我们首先需要学完Redis对应的基础知识，然后我们来到SpringBoot的项目中
首先我们要导入Redis的依赖

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

然后来到application.yml（注意这里我习惯于用yml 个人觉得比properties好用一点）配置关于Redis的基本配置

spring:
  redis:
    host: "主机ip"
    port: "Redis的端口号"
    password: "Redis设置的密码" #这里要注意运行的时候主机中的Redis一定也要是运行状态的

然后我们就可以使用对应的模板类了，这里需要注意一件事我们需要对Redis进行序列化的配置不然会导致我们传递上去的键值对是乱码的形式传递到服务器中去的 Redis如何进行序列化大家可以去查阅相关的资料哦然后进行Redis模板对象的自定义配置就好了
这里给大家附上一个工具类里面就是对应的方法了

@Component //声明组件
public class RedisUtils {
    @Autowired //自动注入
    RedisTemplate<String,Object> redisTemplate;
    public String get(String key){
        return (String)redisTemplate.opsForValue().get(key);
    }
    public  void set(String key,Object value){
        redisTemplate.opsForValue().set(key,value);
    }
    public boolean set(String key, Object value, long time) {//加入了过期时间的方法
        try {
            if (time > 0) {
                redisTemplate.opsForValue().set(key,value,time,TimeUnit.SECONDS);
            } else {
                set(key, value);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

}//这里只实现了简单的getset，如果大家要实现drop等功能也可以去查阅资料

token如何使用？

首先为什么要先提到Redis呢？因为我们可以把账号对应的主键以及token字符串以键值对的形式保存到Redis中
token字符串生成时是按照算法加密的，同样我们也可以进行解密我们可以这样配置一个拦截器，拦截请求的时候拿到token然后将token解密拿出用户的uid，然后从Redis中查出对应的token，如果匹配的话那我们就放行，至于为什么不直接使用用户的uid进行存储呢这可能就涉及到了安全方面的问题，可能我们使用用户独立的uid不断的进行操作，可能请求头中每次都携带这用户的uid不是一种安全的做法，所以我们就使用token进行一次加密，这个我了解的也不是很深。
大致思路就是这样下面进入代码的实现：
首先要导入对应的依赖

   <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt-api</artifactId>
            <version>0.11.2</version>
        </dependency>
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt-impl</artifactId>
            <version>0.11.2</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt-jackson</artifactId> <!-- or jjwt-gson if Gson is preferred -->
            <version>0.11.2</version>
            <scope>runtime</scope>
        </dependency>

然后我们要实现生成token对应的工具类

public class TokenUtils {
    private final String tokenKey="自定义的密钥，字符串的形式";
    byte[] bytes=tokenKey.getBytes();
    private final Key key= Keys.hmacShaKeyFor(Decoders.BASE64.decode(tokenKey));
    private String Token(String userId, Date date) {
        System.out.println(bytes.length);
        SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
        JwtBuilder builder = Jwts.builder()
                .setIssuedAt(date) // 设置签发时间
                .setExpiration(new Date(date.getTime() + 1000 * 60 * 60))
                .claim("userId",String.valueOf(userId) ) // 设置内容，这里很重要因为后面
                                                          // 需要解析它
                .signWith(key); 
        String jwt = builder.compact();
        return jwt;
    }
    public String getToken(String userId){
        Date date=new Date();
        int nowTime =(int) (date.getTime()/1000);
        System.out.println(nowTime);
        String TokenStr=Token(userId,date);
        return TokenStr;
    }
}

然后我们要配置拦截器实现使用token验证登录这里只写一个preHandle方法的重写，具体的配置类以及如何整理到MVC中大家可以去查阅资料

    @Autowired
    RedisUtils redisUtils;
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if(request.getRequestURI().contains("/login") ||
         request.getRequestURI().contains("/register") || 
         request.getRequestURI().contains("/static"))
            return true;
        final String headerToken=request.getHeader("token");
        log.info("获得token:"+headerToken);
        if(null==headerToken || headerToken.trim().equals("")){
            response.sendRedirect("/login403");
            return false;
        }
        System.out.println("========================");
        try{
            Claims claims= Jwts.parser()
            .setSigningKey("与之前自己设置的key字符串相同") //注意这里要自己改
            // **如果key过于短 会报错的
            .parseClaimsJws(headerToken).getBody();
            String tokenUserId=(String)claims.get("userId");
            log.info("解析到uid:"+tokenUserId);
            String RedisToken=redisUtils.get(tokenUserId); //Redis的查询操作
            if(RedisToken==null){
             //   request.setAttribute("uid",tokenUserId);
                response.sendRedirect("/login403"); //重定向到一个返回没有权限的controller
                return false;
            }
            if(!headerToken.equals(RedisToken)){
                response.sendRedirect("/login403");
                return false;
            }
            return true;
        }catch (Exception e){
            System.out.println(e);
            return false;
        }
    }

token的生成应该运用在登录模块中，这里大家按照逻辑来写就好了对应的工具类已经贴上了

如何实现短信服务？

这里我是使用了腾讯云对应的第三方SDK

首先我们需要来到腾讯云的首页然后搜索短信功能开通服务
然后我们跟着快速入门来

在这个地方创建对应的签名与正文，这里注意要严格按照要求不然会不通过的，然后我们要找到它对应的SDK文档

import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;

//导入可选配置类
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.profile.HttpProfile;

// 导入对应SMS模块的client
import com.tencentcloudapi.sms.v20210111.SmsClient;

// 导入要请求接口对应的request response类
import com.tencentcloudapi.sms.v20210111.models.SendSmsRequest;
import com.tencentcloudapi.sms.v20210111.models.SendSmsResponse;

/**
 * Tencent Cloud Sms Sendsms
 *
 */
public class SendSms
{
    public static void main(String[] args)
    {
        try {
            /* 必要步骤：
             * 实例化一个认证对象，入参需要传入腾讯云账户密钥对secretId，secretKey。
             * 这里采用的是从环境变量读取的方式，需要在环境变量中先设置这两个值。
             * 你也可以直接在代码中写死密钥对，但是小心不要将代码复制、上传或者分享给他人，
             * 以免泄露密钥对危及你的财产安全。
             * SecretId、SecretKey 查询: https://console.cloud.tencent.com/cam/capi */
            Credential cred = new Credential("secretId", "secretKey");

            // 实例化一个http选项，可选，没有特殊需求可以跳过
            HttpProfile httpProfile = new HttpProfile();
            // 设置代理
            // httpProfile.setProxyHost("真实代理ip");
            // httpProfile.setProxyPort(真实代理端口);
            /* SDK默认使用POST方法。
             * 如果你一定要使用GET方法，可以在这里设置。GET方法无法处理一些较大的请求 */
            httpProfile.setReqMethod("POST");
            /* SDK有默认的超时时间，非必要请不要进行调整
             * 如有需要请在代码中查阅以获取最新的默认值 */
            httpProfile.setConnTimeout(60);
            /* SDK会自动指定域名。通常是不需要特地指定域名的，但是如果你访问的是金融区的服务
             * 则必须手动指定域名，例如sms的上海金融区域名： sms.ap-shanghai-fsi.tencentcloudapi.com */
            httpProfile.setEndpoint("sms.tencentcloudapi.com");

            /* 非必要步骤:
             * 实例化一个客户端配置对象，可以指定超时时间等配置 */
            ClientProfile clientProfile = new ClientProfile();
            /* SDK默认用TC3-HMAC-SHA256进行签名
             * 非必要请不要修改这个字段 */
            clientProfile.setSignMethod("HmacSHA256");
            clientProfile.setHttpProfile(httpProfile);
            /* 实例化要请求产品(以sms为例)的client对象
             * 第二个参数是地域信息，可以直接填写字符串ap-guangzhou，支持的地域列表参考 https://cloud.tencent.com/document/api/382/52071#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8 */
            SmsClient client = new SmsClient(cred, "ap-guangzhou",clientProfile);
            /* 实例化一个请求对象，根据调用的接口和实际情况，可以进一步设置请求参数
             * 你可以直接查询SDK源码确定接口有哪些属性可以设置
             * 属性可能是基本类型，也可能引用了另一个数据结构
             * 推荐使用IDE进行开发，可以方便的跳转查阅各个接口和数据结构的文档说明 */
            SendSmsRequest req = new SendSmsRequest();

            /* 填充请求参数,这里request对象的成员变量即对应接口的入参
             * 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
             * 基本类型的设置:
             * 帮助链接：
             * 短信控制台: https://console.cloud.tencent.com/smsv2
             * sms helper: https://cloud.tencent.com/document/product/382/3773 */

            /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId，示例如1400006666 */
            String sdkAppId = "1400009099";
            req.setSmsSdkAppId(sdkAppId);

            /* 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名，签名信息可登录 [短信控制台] 查看 */
            String signName = "签名内容";
            req.setSignName(signName);

            /* 国际/港澳台短信 SenderId: 国内短信填空，默认未开通，如需开通请联系 [sms helper] */
            String senderid = "";
            req.setSenderId(senderid);

            /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息，server 会原样返回 */
            String sessionContext = "xxx";
            req.setSessionContext(sessionContext);

            /* 短信号码扩展号: 默认未开通，如需开通请联系 [sms helper] */
            String extendCode = "";
            req.setExtendCode(extendCode);

            /* 模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看 */
            String templateId = "400000";
            req.setTemplateId(templateId);

            /* 下发手机号码，采用 E.164 标准，+[国家或地区码][手机号]
             * 示例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号，最多不要超过200个手机号 */
            String[] phoneNumberSet = {"+8621212313123", "+8612345678902", "+8612345678903"};
            req.setPhoneNumberSet(phoneNumberSet);

            /* 模板参数: 若无模板参数，则设置为空 */
            String[] templateParamSet = {"5678"};
            req.setTemplateParamSet(templateParamSet);

            /* 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的
             * 返回的 res 是一个 SendSmsResponse 类的实例，与请求对象对应 */
            SendSmsResponse res = client.SendSms(req);

            // 输出json格式的字符串回包
            System.out.println(SendSmsResponse.toJsonString(res));

            // 也可以取出单个值，你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
            System.out.println(res.getRequestId());

        } catch (TencentCloudSDKException e) {
            e.printStackTrace();
        }
    }
}

我们按照文档进行相应的配置以后，把它封装成对应的工具类，调用对应的函数就可以实现了。
以上就是我对于登录注册进行的难点上的梳理把算是，给大家提供一些思路但是也不是说做的好只不过是把自己学到的东西整理到博客上，如果有更好的解决方案大家也可以积极评论提出