Java实现短信登录的流程

很早之前整理的文章,发布下。

1. 了解短信登录的原理

在开始实现Java短信登录之前,我们需要先了解短信登录的原理。短信登录通常通过以下步骤实现:

用户输入手机号码并点击发送验证码按钮。
后台生成随机的验证码并通过短信服务商发送到用户的手机上。
用户在手机上收到验证码后,将其输入到登录页面。
前端将用户输入的手机号码和验证码发送到后台进行验证。
后台验证通过后,返回登录成功的信息给前端。

2. 实现短信功能

在开始编写代码之前,我们需要先搭建好Java开发环境。你可以根据自己的喜好选择集成开发环境(IDE),比如Eclipse、IntelliJ IDEA等。此外,我们还需要一个短信服务商来发送验证码,常用的有阿里云、腾讯云等。

2.1. 阿里云后台实现

阿里云官方参考文档 参考1

2.1.1. 导入相关依赖

在项目的pom.xml文件中,添加以下依赖:

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>4.0.6</version>
</dependency>
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-dysmsapi</artifactId>
    <version>1.0.0</version>
</dependency>

这里使用了阿里云的短信服务依赖。

2.1.2. 编写后台代码

创建短信验证码实体类

首先,我们需要创建一个短信验证码的实体类,用于存储手机号码和验证码信息。在你的项目中创建一个名为SmsCode的Java类,并添加以下代码:

public class SmsCode {
    private String phoneNumber;
    private String code;

    public SmsCode(String phoneNumber, String code) {
        this.phoneNumber = phoneNumber;
        this.code = code;
    }

    // 省略getter和setter方法
}

这个实体类用于存储手机号码和验证码信息。

编写发送短信的服务类

接下来,我们需要实现发送短信的服务类。在你的项目中创建一个名为SmsService的Java类,并添加以下代码:

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;

/**
 * Created on 17/6/7.
 * 短信API产品的DEMO程序,工程中包含了一个SmsDemo类,直接通过
 * 执行main函数即可体验短信产品API功能(只需要将AK替换成开通了云通信-短信产品功能的AK即可)
 * 工程依赖了2个jar包(存放在工程的libs目录下)
 * 1:aliyun-java-sdk-core.jar
 * 2:aliyun-java-sdk-dysmsapi.jar
 * <p>
 * 备注:Demo工程编码采用UTF-8
 * 国际短信发送请勿参照此DEMO
 */
public class SmsSender {

    //产品名称:云通信短信API产品,开发者无需替换
    private static final String product = "Dysmsapi";                            // 无需修改
    //产品域名,开发者无需替换
    private static final String domain = "dysmsapi.aliyuncs.com";                // 无需修改

    private static final String accessKeyId = "XXXXXXXXX";                       // 修改accessKeyId
    private static final String accessKeySecret = "YYYYYYYYYYYYY";               // 修改accessKeySecret

    /**
     * 短信发送
     *
     * @param phoneNumbers  待发送手机号,支持以逗号分隔的形式进行批量调用,批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
     * @param signName      短信签名-可在短信控制台中找到
     * @param templateCode  短信模板编码-可在短信控制台中找到
     * @param templateParam 模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为 {\"name\":\"Tom\", \"code\":\"123\"}
     * @return
     */
    public static SendSmsResponse sendSms(String phoneNumbers, String signName, String templateCode, String templateParam) {

        //可自助调整超时时间
        System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
        System.setProperty("sun.net.client.defaultReadTimeout", "10000");
        SendSmsResponse sendSmsResponse = null;
        try {
            //初始化acsClient,暂不支持region化
            IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
            DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
            IAcsClient acsClient = new DefaultAcsClient(profile);

            //组装请求对象-具体描述见控制台-文档部分内容
            SendSmsRequest request = new SendSmsRequest();
            //必填:待发送手机号
            request.setPhoneNumbers(phoneNumbers);
            //必填:短信签名-可在短信控制台中找到
            request.setSignName(signName);
            //必填:短信模板-可在短信控制台中找到
            request.setTemplateCode(templateCode);
            //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${title}"时,此处的值为
            request.setTemplateParam(templateParam);
            //选填-上行短信扩展码(无特殊需求用户请忽略此字段)
            //request.setSmsUpExtendCode("90997");
            //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
//            request.setOutId("yourOutId");
            sendSmsResponse = acsClient.getAcsResponse(request);                             // 发送短信,且返回结果
        } catch (Exception ex) {
            ex.printStackTrace();
        }
        return sendSmsResponse;
    }

    public static void main(String[] args) {
        //发短信
        SendSmsResponse response = sendSms("13000000000","测试公司","SMS_11111111","{\"name\":\"Tom\", \"title\":\"123\"}");
        System.out.println("短信接口返回的数据----------------");
        System.out.println("Code=" + response.getCode());
        System.out.println("Message=" + response.getMessage());
        System.out.println("RequestId=" + response.getRequestId());
        System.out.println("BizId=" + response.getBizId());

    }
}

编写短信登录的控制器

最后,我们需要编写一个短信登录的控制器。在你的项目中创建一个名为LoginController的Java类,并添加以下代码:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class LoginController {
    @Autowired
    private SmsService smsService;

    @PostMapping("/login")
    public String login(@RequestParam("phoneNumber") String phoneNumber,
                        @RequestParam("code") String code) {
        // 验证手机号码和验证码是否匹配
        if (validateCode(phoneNumber, code)) {
            // 登录成功
            return "登录成功";
        } else {
            // 登录失败
            return "登录失败";
        }
    }

    private boolean validateCode(String phoneNumber, String code) {
        // 这里可以调用短信服务商的API验证验证码是否正确
        // 如果正确,返回true,否则返回false
        return true;
    }
}

这个控制器接收用户输入的手机号码和验证码,并调用validateCode方法验证验证码是否正确。

2.2. 腾讯云后台实现

腾讯云官方参考文档

2.2.1. 导入相关依赖
<dependency>
    <groupId>com.tencentcloudapi</groupId>
    <artifactId>tencentcloud-sdk-java</artifactId>
    <version>4.0.11</version>
</dependency>
2.2.2. 编写后台代码

创建常量类

我们把在官方文档内看到的常量参数进行封装,定义一个constant常量类,进行存储:

/**
 * Desc 腾讯云短信服务常量
 *
 * @author Mintimate
 */
public class tencentSmsConst {
    public static final String secretId = "";
    public static final String secretKey = "";
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如1400006666 */
    public static final String sdkAppId = "";
    public static final String SignName = "";
}

静态工具包

/**
 * Tencent Cloud Sms Sendsms
 * 短信控制台: https://console.cloud.tencent.com/smsv2
 */
public class tencentSmsUtil {


    /**
     * 使用腾讯云短信发生验证码
     * @param telephoneNumber 发送对象
     * @param TemplateID 短信模版ID(使用枚举类型)
     * @param templateParamSet 短信模版参数(这里一般为验证码)
     * @return 是否成功
     */
    public static boolean sendMessage(String telephoneNumber, String TemplateID, String... templateParamSet) {
        /* 必要步骤:
         * 实例化一个认证对象,入参需要传入腾讯云账户密钥对secretId,secretKey。
         * 这里采用的是从环境变量读取的方式,需要在环境变量中先设置这两个值。
         * 你也可以直接在代码中写死密钥对,但是小心不要将代码复制、上传或者分享给他人,
         * 以免泄露密钥对危及你的财产安全。
         * CAM密匙查询: https://console.cloud.tencent.com/cam/capi*/
        Credential cred = new Credential(secretId, secretKey);
        SendSmsRequest req = new SendSmsRequest();
        SmsClient client = new SmsClient(cred, "ap-guangzhou");

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

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

        /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息,server 会原样返回 */
        String sessionContext = "xxx";
        req.setSessionContext(sessionContext);
        req.setTemplateId(TemplateID);
        req.setPhoneNumberSet(new String[]{"+86" + telephoneNumber});
        /* 模板参数: 若无模板参数,则设置为空 */
        req.setTemplateParamSet(templateParamSet);
        /* 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的
         * 返回的 res 是一个 SendSmsResponse 类的实例,与请求对象对应 */
        SendSmsResponse res = null;
        try {
            res = client.SendSms(req);
        } catch (TencentCloudSDKException ex) {
            ex.printStackTrace();
            return false;
        }
        // 输出json格式的字符串回包
        System.out.println(SendSmsResponse.toJsonString(res));
        // 也可以取出单个值,你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
        System.out.println(res.getRequestId());
        return true;
    }
}

其实就是对官方的模版进行简单封装和简化。

VerifyCodeUntil

用来生成6位存数字验证码:

public class VerifyCodeUntil {
    private final static String sources = "5678012349"; // 验证码可能出现的字符
    public static String getVerifyCodes(int longSize){
        Random rand = new Random();
        StringBuffer flag = new StringBuffer();
        for (int j = 0; j < 6; j++) {
            flag.append(sources.charAt(rand.nextInt(9)) + "");
        }
        return String.valueOf(flag);
    }
}

编写前端代码

在前端页面中,我们需要创建一个登录表单,包含手机号码输入框、验证码输入框和登录按钮。

用户在输入手机号码后,点击发送验证码按钮,前端会将手机号码发送到后台,后台生成验证码并发送到用户的手机上。

用户在手机上收到验证码后,将其输入到验证码输入框中,点击登录按钮,前端会将手机号码和验证码发送到后台进行验证。

版权声明: 闲者 发表于 2024-08-04
转载请注明: Java实现短信登录的流程 | Java实现短信登录的流程 - 无界文档,Java实现短信登录的流程

评论区

暂无评论...