SpringBoot 基于阿里云短信服务实现短信发送

最新推荐文章于 2026-03-05 00:04:55 发布

原创最新推荐文章于 2026-03-05 00:04:55 发布 · 983 阅读

4 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

SpringBoot

本文详细介绍如何在Spring Boot项目中集成阿里云短信服务，实现发送短信验证码的功能。从环境搭建到代码实现，包括依赖配置、工具类编写及控制器设计，全程实战演示。

最近小编在学习登录注册模块，别人家的平台有短信验证码、邮件验证码什么的，所以这次带来了短信验证码的学习小干货。邮件验证码的话，也不算是验证码，就是邮件发送，具体业务具体实现，笔记在之前的文章中有咯。

1. 战斗前准备

说不清，直接看图操作好了
第一步
第二步
第三步
第四步
经过操作，最主要的就是拿到 短信签名signName、模板templateCode、accessKeyId、accessKeySecret。

2. 上模拟战场

pom.xml：

<dependencies>
		<!-- 打印log，可不加 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.8</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.1.7.RELEASE</version>
        </dependency>
        <!-- alibb的东东 -->
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-core</artifactId>
            <version>4.0.3</version>
        </dependency>
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-dysmsapi</artifactId>
            <version>1.1.0</version>
        </dependency>
<dependencies>

发送短信的工具类SmsUtil.class：

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;

public class SmsUtil {

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

    public static SendSmsResponse sendSms(String phone , String code) throws Exception {
        //可自助调整超时时间
        System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
        System.setProperty("sun.net.client.defaultReadTimeout", "10000");
        //初始化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(phone);
        //必填:短信签名-可在短信控制台中找到
        request.setSignName("自己的signName");
        //必填:短信模板-可在短信控制台中找到
        request.setTemplateCode("模板templateCode");
        //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
        request.setTemplateParam(code);

        //选填-上行短信扩展码(无特殊需求用户请忽略此字段)
        //request.setSmsUpExtendCode("90997");

        //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
        //request.setOutId("yourOutId");

        SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
        return sendSmsResponse;
    }

}

生成6位数字随机验证码的工具类CodeUtil.class：

import java.util.Random;

public class CodeUtil {

    static final String VERIFY_CODES = "1234567890";

    /**
     * 使用系统默认字符源生成验证码
     * @param verifySize    验证码长度
     * @return
     */
    public static String generateVerifyCode(int verifySize){
        return generateVerifyCode(verifySize, VERIFY_CODES);
    }

    /**
     * 使用指定源生成验证码
     * @param verifySize    验证码长度
     * @param sources   验证码字符源
     * @return
     */
    public static String generateVerifyCode(int verifySize, String sources){
        if(sources == null || sources.length() == 0){
            sources = VERIFY_CODES;
        }
        int codesLen = sources.length();
        Random rand = new Random(System.currentTimeMillis());
        StringBuilder verifyCode = new StringBuilder(verifySize);
        for(int i = 0; i < verifySize; i++){
            verifyCode.append(sources.charAt(rand.nextInt(codesLen-1)));
        }
        return verifyCode.toString();
    }

}

SmsController.class：

import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

@RestController
public class SmsController {

    @PostMapping(value = "/smsXxs/{phone}")
    public Map<String,Object> smsXxs(@PathVariable("phone") String phone) throws Exception {
        Map<String,Object> map = new HashMap<String,Object>(16);
        // 验证码（指定长度的随机数）
        String code = CodeUtil.generateVerifyCode(6);
        String templateParam = "{\"code\":\""+code+"\"}";
        SendSmsResponse response = SmsUtil.sendSms(phone, templateParam);
        map.put("verifyCode",code);
        map.put("phone",phone);
        if( response.getCode().equals("OK")) {
            map.put("status","success");
        } else {
            map.put("isOk","false");
        }
        return map;
    }

}