Java实现短信验证码服务的完整代码示例

 更新时间:2024年09月24日 10:49:01   作者:代码辅助  
这篇文章主要介绍了Java实现短信验证码服务的完整代码示例,文中使用阿里云的短信服务进行应用开发的流程,包括将属性写入application.yml配置文件,定义类并指定配置文件,注入实体类对象等等,需要的朋友可以参考下

首先这里使用的是阿里云的短信服务。

package com.wzy.util;;
import cn.hutool.captcha.generator.RandomGenerator;
import com.aliyun.dysmsapi20170525.Client;
import com.wzy.entity.Ali;
import org.springframework.stereotype.Component;

/**
 * @Author: 顾安
 * @Description:
 * @Date: Create in 17:30 2024/7/23
 */
@Component
public class SendMsgUtil {
    /**
     * 使用AK&SK初始化账号Client
     * @return Client
     * @throws Exception
     */

    private static Ali ali;

    public SendMsgUtil(Ali ali) {
        this.ali = ali;
    }
    public static Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                .setAccessKeyId(ali.getAccessKeyId())

                // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                .setAccessKeySecret(ali.getAccessKeySecret());
        // Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
        config.endpoint = "dysmsapi.aliyuncs.com";
        return new Client(config);
    }
/*    *
     * API 相关
     * @return OpenApi.Params*/

    public static com.aliyun.teaopenapi.models.Params createApiInfo() throws Exception {
        com.aliyun.teaopenapi.models.Params params = new com.aliyun.teaopenapi.models.Params()
                // 接口名称
                .setAction("SendSms")
                // 接口版本
                .setVersion("2017-05-25")
                // 接口协议
                .setProtocol("HTTPS")
                // 接口 HTTP 方法
                .setMethod("POST")
                .setAuthType("AK")
                .setStyle("RPC")
                // 接口 PATH
                .setPathname("/")
                // 接口请求体内容格式
                .setReqBodyType("json")
                // 接口响应体内容格式
                .setBodyType("json");
        return params;
    }

    public static String sendCode(String phone) throws Exception {
        com.aliyun.teaopenapi.Client client = createClient();
        com.aliyun.teaopenapi.models.Params params = createApiInfo();
        String code="123456";
        // query params
        java.util.Map<String, Object> queries = new java.util.HashMap<>();
        queries.put("PhoneNumbers", phone);
        queries.put("SignName", ali.getSignName());
        queries.put("TemplateCode", ali.getTemplateCode()); //您正在申请手机注册,验证码为:$[code],5分钟内有效!
        queries.put("TemplateParam", "{\"code\":\""+codes()+"\"}");
        // runtime options
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        com.aliyun.teaopenapi.models.OpenApiRequest request = new com.aliyun.teaopenapi.models.OpenApiRequest()
                .setQuery(com.aliyun.openapiutil.Client.query(queries));
        // 复制代码运行请自行打印 API 的返回值
        // 返回值为 Map 类型,可从 Map 中获得三类数据:响应体 body、响应头 headers、HTTP 返回的状态码 statusCode。
        client.callApi(params, request, runtime);
        return codes();
    }
    public static String codes(){
        // 自定义纯数字的验证码(随机4位数字,可重复)
        RandomGenerator randomGenerator = new RandomGenerator("0123456789", 4);
        return String.valueOf(randomGenerator);

    }
//    public static String code(){
//        return String.valueOf(ThreadLocalRandom.current().nextInt(100000,1000000));
//    }
}

上面的一些属性没有直接写到代码中,而是模拟真实的开发场景,写入application.yml配置文件中,通过定义一个类,然后指定配置文件,在阿里配置类中注入改实体类对象。如下图所示

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
@ConfigurationProperties("ali.msg")
public class Ali {
    private String accessKeyId;
    private String accessKeySecret;
    private String signName;
    private String templateCode;

}

然后需要随机生成数字,我这里也使得是hutool工具,需要加入该工具的jar包

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.16</version>
</dependency>

该工具包含各种场景的工具,满足开发需求的很多场景,大家可以学习一下,随机生成的代码如下:

public static String codes(){
    // 自定义纯数字的验证码(随机4位数字,可重复)
    RandomGenerator randomGenerator = new RandomGenerator("0123456789", 4);
    return String.valueOf(randomGenerator);

}

生成一个从0到9随机组成的4位数。

然后就可以开始编写我们的真实开发环境的发送验证码

@GetMapping("/send")
public R sentMsg(String phone){
   //判断前端传过来的手机号是否正确
    if (phone.equals("166x786xxxxx")){
    //判断验证码是否已发送,防止恶意发送
        if (redisTemplate.hasKey("code::"+phone)){
            return new R(200,"请不要频繁点击",null);
        }
        try {
        //调用阿里云的接口并拿到前端传来的手机号
            String code = SendMsgUtil.sendCode(phone);
           //把验证码存入到redis缓存中并设置过期时间
            redisTemplate.opsForValue().set("code::"+phone,code,5, TimeUnit.MINUTES);
            return new R(200,"发送成功",null);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
    return new R(200,"发送失败",null);
}
@PostMapping("/login")
public R login(@RequestBody LoginVo loginVo){
    //拿到缓存中的验证码
    String code = redisTemplate.opsForValue().get("code::" + loginVo.getPhone());
     //拿到缓存中的手机号
    String phone = loginVo.getPhone();
   //判断手机号是否正确
    if (phone.equals("16627865460")){
     //判断验证码是否为空是否正确
        if (StringUtils.hasText(loginVo.getCode())&&loginVo.getCode().equals(code)){
           //删除缓存中的验证码,防止恶意登入
            redisTemplate.delete("code::" + phone);
            return new R(200,"登入成功",null);
        }else {
            return new R(500,"登入失败",null);
        }
    }
    return new R(500,"登入失败",null);
}

总结

到此这篇关于Java实现短信验证码服务的文章就介绍到这了,更多相关Java实现短信验证码服务内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot动态生成接口实现流程示例讲解

    SpringBoot动态生成接口实现流程示例讲解

    最近遇到一个需求,需要在程序运行过程中,可以动态新增接口,自定义接口参数名称,基本类型,以及请求方法,请求头等等。通过几天的研究,找到了我需要的解决方案
    2023-01-01
  • 详解mybatis流式查询与分页插件

    详解mybatis流式查询与分页插件

    这篇文章主要介绍了mybatis流式查询与分页插件,本文通过实例代码给大家讲解的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-11-11
  • java 页面url传值中文乱码的解决方法

    java 页面url传值中文乱码的解决方法

    本节讲的是ajax 的URL参数中有中文值,传到服务端,在用request.getParameter()方法,得到的常常会是乱码。
    2013-03-03
  • Java HttpURLConnection使用方法详解

    Java HttpURLConnection使用方法详解

    这篇文章主要为大家详细介绍了Java HttpURLConnection使用方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • Java的反射机制一起来看看

    Java的反射机制一起来看看

    这篇文章主要为大家详细介绍了Java反射机制,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Spring中的FactoryBean与BeanFactory详细解析

    Spring中的FactoryBean与BeanFactory详细解析

    这篇文章主要介绍了Spring中的FactoryBean与BeanFactory详细解析,在Spring框架中,FactoryBean和BeanFactory是两个关键的接口,用于创建和管理对象实例,它们在Spring的IoC(Inversion of Control,控制反转)容器中发挥着重要的作用,需要的朋友可以参考下
    2023-11-11
  • Java中synchronized锁的深入理解

    Java中synchronized锁的深入理解

    这篇本文主要对Java中synchronized锁进行深入理解,文中通过synchronized的优化,synchronized的实现原理及synchronized的升级过程来介绍Java中synchronized锁,感兴趣的同学可以跟着小编一起来学习
    2023-05-05
  • SpringBoot多数据源读写分离的自定义配置问题及解决方法

    SpringBoot多数据源读写分离的自定义配置问题及解决方法

    这篇文章主要介绍了SpringBoot多数据源读写分离的自定义配置,我们可以通过自定义配置数据库配置类来解决这个问题,方式有很多,不同的业务采用的方式也不同,下面我简单的介绍我们项目的使用的方法
    2022-06-06
  • 微服务Springcloud之Feign的基本使用

    微服务Springcloud之Feign的基本使用

    这篇文章主要介绍了微服务Springcloud之Feign的基本使用,Spring Cloud集成Feign并对其进行了增强,使Feign支持了Spring MVC注解,需要的朋友可以参考下
    2023-03-03
  • Java内存模型中的虚拟机栈原理分析

    Java内存模型中的虚拟机栈原理分析

    这篇文章主要介绍了Java内存模型中的虚拟机栈原理分析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11

最新评论