SpringBoot集成阿里云短信的实战指南

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>dysmsapi20180501</artifactId>
    <version>2.0.24</version> <!-- 请使用Maven仓库中的最新版本 -->
</dependency>

# application.yml 配置示例
aliyun:
  sms:
    # 从控制台获取的AccessKey信息
    access-key-id: your-access-key-id
    access-key-secret: your-access-key-secret
    # 短信服务接入点（Endpoint），国内一般为 dysmsapi.aliyuncs.com
    endpoint: dysmsapi.aliyuncs.com
    # 控制台申请并通过审核的签名名称（无需加【】）
    sign-name: 你的签名
    # 控制台申请并通过审核的模板CODE
    template-code: SMS_123456789

import com.aliyun.dysmsapi20180501.Client;
import com.aliyun.teaopenapi.models.Config;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Service;

@Configuration
public class AliyunSmsConfig {

    @Value("${aliyun.sms.access-key-id}")
    private String accessKeyId;

    @Value("${aliyun.sms.access-key-secret}")
    private String accessKeySecret;

    @Value("${aliyun.sms.endpoint}")
    private String endpoint;

    /**
     * 创建并返回阿里云短信服务的Client实例。
     * 该Bean可用于整个Spring容器。
     */
    @Bean
    public Client createClient() throws Exception {
        Config config = new Config()
                .setAccessKeyId(accessKeyId)
                .setAccessKeySecret(accessKeySecret);
        config.endpoint = endpoint;
        return new Client(config);
    }
}

import com.aliyun.dysmsapi20180501.Client;
import com.aliyun.dysmsapi20180501.models.SendMessageWithTemplateRequest;
import com.aliyun.dysmsapi20180501.models.SendMessageWithTemplateResponse;
import com.aliyun.teautil.models.RuntimeOptions;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

@Service
public class SmsService {

    @Autowired
    private Client smsClient;

    @Value("${aliyun.sms.sign-name}")
    private String signName;

    @Value("${aliyun.sms.template-code}")
    private String templateCode;

    /**
     * 发送短信验证码
     * @param phoneNumber 目标手机号（国内号码需带国际区号86）
     * @param templateParam 模板变量对应的JSON字符串，如：{"code":"123456"}
     * @return 是否发送成功
     */
    public boolean sendSms(String phoneNumber, String templateParam) {
        try {
            SendMessageWithTemplateRequest request = new SendMessageWithTemplateRequest()
                    .setTo(phoneNumber) // 接收方手机号
                    .setSignName(signName) // 短信签名
                    .setTemplateCode(templateCode) // 短信模板CODE
                    .setTemplateParam(templateParam); // 模板变量JSON

            RuntimeOptions runtime = new RuntimeOptions();
            SendMessageWithTemplateResponse response = smsClient.sendMessageWithTemplateWithOptions(request, runtime);

            // 根据响应判断是否成功，"OK"表示成功[citation:4]
            return "OK".equals(response.getBody().getResponseCode());
        } catch (Exception e) {
            // 此处应记录日志，并根据业务需要进行异常处理
            e.printStackTrace();
            return false;
        }
    }
}

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

@RestController
public class SmsController {

    @Autowired
    private SmsService smsService;

    @GetMapping("/sendCode")
    public String sendVerificationCode(@RequestParam String phone) {
        // 生成随机验证码（示例）
        String code = String.valueOf((int)((Math.random() * 9 + 1) * 100000));
        // 构造模板参数（必须与申请模板时的变量名一致）
        String templateParam = "{\"code\":\"" + code + "\"}";

        boolean isSuccess = smsService.sendSms(phone, templateParam);
        if (isSuccess) {
            // 在实际业务中，此处应将验证码与手机号关联并存入缓存（如Redis），设置有效期
            return "验证码发送成功！";
        } else {
            return "验证码发送失败，请稍后重试。";
        }
    }
}