SpringBoot集成阿里云短信验证码服务

news2024/9/23 17:28:07

一：前言

最近在项目开发过程中，需要去写一个发送手机短信验证码的功能。在网上查了一下，有很多服务器可供选择，本文的话是基于阿里云服务的短信验证码功能实现。

关于注册和开通服务这些需要操作的，请各位小伙伴参考官方文档：

使用OpenAPI调试短信服务_短信服务(SMS)-阿里云帮助中心使用OpenAPI自动化集成短信服务，可以提升您使用短信服务的开发效率。本文介绍使用OpenAPI调试短信服务的基本信息及注意事项。https://help.aliyun.com/zh/sms/developer-reference/using-openapi?spm=a2c4g.11186623.0.i1 开通完成后，我们至少需要下图中的四个字段，这里我罗列出来，缺少这些东西的小伙伴请根据文档来补全。

二：代码

1、导入依赖

在 SpringBoot项目中的 pom.xml 文件中导入依赖

        <!-- 集成阿里云短信服务 -->
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>dysmsapi20170525</artifactId>
            <version>2.0.24</version>
        </dependency>

2、创建变量

为了数据的安全，防止攻击，我们可以进入 application.yml 文件配置全局变量，我这里的缩进如下：

3、实现代码

1）在 Controller 中获取到这些变量

    @Value("${sofast.password.smsCode.accessKeyId}")
    private String accessKeyId;
    @Value("${sofast.password.smsCode.accessKeySecret}")
    private String accessKeySecret;
    @Value("${sofast.password.smsCode.signName}")
    private String signName;
    @Value("${sofast.password.smsCode.templateCode}")
    private String templateCode;

2）这里我们来写两个前置方法

生成四位随机数的方法，非常简单，可以根据自己的需求和短信模板进行修改。

    public static String generateCode() {
        Random random = new Random();
        int code = random.nextInt(9000) + 1000;
        return String.valueOf(code);
    }

初始化账号的方法，这个是直接从官网上拿过来的

    public com.aliyun.dysmsapi20170525.Client createClient() throws Exception {
        // 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        // 建议使用更安全的 STS 方式，更多鉴权访问方式请参见：https://help.aliyun.com/document_detail/378657.html。
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
            // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
            .setAccessKeyId(accessKeyId)
            // 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
            .setAccessKeySecret(accessKeySecret);
        // Endpoint 请参考 https://api.aliyun.com/product/Dysmsapi
        config.endpoint = "dysmsapi.aliyuncs.com";
        return new com.aliyun.dysmsapi20170525.Client(config);
    }

3）接口主方法

这个是方法的主要执行体，我们定义了一个接口，后续直接往这个接口传一个手机号的字符串就行了，要注意的是，我们可以不在这里进行手机号格式的判断，因为在阿里云服务器端，会进行判断，图省事的小伙伴可以直接将返回的提示传给前端就可以啦！

@GetMapping("/verification/sendSmsCode/{phone}")
    @DynamicDS(value = DataSourceType.SLAVE)
    @ApiOperation("发送短信验证码")
    public R  sendSmsCode(@PathVariable("phone") @NotNull String phone) throws Exception {
        String code = generateCode();
        SendSmsResponse sendSmsResponse = new SendSmsResponse();
        com.aliyun.dysmsapi20170525.Client client = createClient();
        com.aliyun.dysmsapi20170525.models.SendSmsRequest sendSmsRequest = new com.aliyun.dysmsapi20170525.models.SendSmsRequest()
            .setPhoneNumbers(phone)
            .setSignName(signName)
            .setTemplateCode(templateCode)
            .setTemplateParam("{\"code\":\""+code+"\"}");
        try {
            // 复制代码运行请自行打印 API 的返回值
            sendSmsResponse = client.sendSmsWithOptions(sendSmsRequest, new RuntimeOptions());
        } catch (TeaException error) {
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        } catch (Exception _error) {
            TeaException error = new TeaException(_error.getMessage(), _error);
            // 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            // 错误 message
            System.out.println(error.getMessage());
            // 诊断地址
            System.out.println(error.getData().get("Recommend"));
            com.aliyun.teautil.Common.assertAsString(error.message);
        }
        return R.data(sendSmsResponse.body.message);
    }