Java整合容联云短信验证码

步骤比较清晰:

  • 前端调发送验证码的接口
  • 后端service层写对应的send方法,给用户发验证码短信
  • 用户再输入验证码,再让后端从redis中读验证码做比对

在用之前得先去容联云官网注册账号,注册完了就可以免费测试(免费测试是不能编辑短信模板的),后续可以开通付费

https://doc.yuntongxun.com/p/5a531a353b8496dd00dcdfe2

一、Maven依赖

        <!--容联云短信sdk-->
        <dependency>
            <groupId>com.cloopen</groupId>
            <artifactId>java-sms-sdk</artifactId>
            <version>1.0.3</version>
        </dependency>
        <!-- 还要加谷歌gson包,版本号就用最新的,否则要报错 -->
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
        </dependency>

application.yml

# 容联云(这里是自定义的配置项,到时候可以用@ConfigurationProperties注解读取)
rckj:
  accountSID: 8aaf0708809721d00999999999999
  accountToken: f930071f78ae42ceeeeeeeeeeeeee
  appId: 8aaf0708809721d00180000000000000
  serverIp: app.cloopen.com
  serverPort: 8883

工具类(读取yml文件里的相关配置值)

// 这个类不写也可以,那就在发送短信的方法里直接填容联云的配置值
@ConfigurationProperties(prefix = "rckj") //会从yml中找到对应的配置项,直接赋值给当前类的属性
@Component
@Data
public class SmsProperties implements InitializingBean {
    private String accountSID;
    private String accountToken;
    private String appId;
    private String serverIp;
    private String serverPort;

    public static String ACCOUNT_SID;
    public static String ACCOUNT_Token;
    public static String APP_ID;
    public static String SERVER_IP;
    public static String SERVER_PORT;

    //继承的InitializingBean类,重写这个方法就是当私有属性被赋值之后(from app.yml),才执行的
    @Override
    public void afterPropertiesSet() throws Exception {
        ACCOUNT_SID=accountSID;
        ACCOUNT_Token=accountToken;
        APP_ID=appId;
        SERVER_IP=serverIp;
        SERVER_PORT=serverPort;
    }
}

二、controller层

@RestController
@RequestMapping("/api/sms")
@CrossOrigin
public class ApiSmsController {
    @Autowired
    private SmsService smsService;
    @Autowired
    private RedisTemplate redisTemplate;

    @GetMapping("/send/{mobile}")
    public Result send(@PathVariable String mobile){
        // 实际上还要校验一下手机号是否合法,当然这步前端也可以校验
        Map<String,Object> map=new HashMap<>();
        String fourBitRandom = RandomUtils.getFourBitRandom();// 工具类生成4位随机数
        map.put("code", fourBitRandom);
        smsService.send(mobile,map);
        //将验证码存入redis
        redisTemplate.opsForValue().set("test:sms:code"+mobile, fourBitRandom, 5, TimeUnit.MINUTES);

        return Result.ok().customMsg("短信发送成功");
    }
}

三、service层(官网有各种语言的demo)

@Service
public class SmsServiceImpl implements SmsService {
    //短信发送
    @Override
    public void send(String mobile, Map<String, Object> param) {
        CCPRestSmsSDK sdk = new CCPRestSmsSDK();
        // 配置账号信息
        sdk.init(SmsProperties.SERVER_IP, SmsProperties.SERVER_PORT);
        sdk.setAccount(SmsProperties.ACCOUNT_SID, SmsProperties.ACCOUNT_Token);
        sdk.setAppId(SmsProperties.APP_ID);
        sdk.setBodyType(BodyType.Type_JSON);

        //String templateId= "xxxx";   免费测试直接写"1",付费开通后可以自定义短信模板
        String[] datas = {(String) param.get("code"), "5"}; //短信里的变量,验证码、几分钟内有效
        HashMap<String, Object> result = sdk.sendTemplateSMS(mobile,"1",datas);
        System.out.println("SMS--Result: "+result);
        if("000000".equals(result.get("statusCode"))){
            //正常返回输出data包体信息(map)
            HashMap<String,Object> data = (HashMap<String, Object>) result.get("data");
            Set<String> keySet = data.keySet();
            for(String key:keySet){
                Object object = data.get(key);
                System.out.println(key +" = "+object);
            }
        }else {
            //异常返回输出错误码和错误信息(或log.error 打印到日志)
            System.out.println("错误码=" + result.get("statusCode") + " 错误信息= " + result.get("statusMsg"));
            // 自定义的统一异常处理,如果出错了会发给前端
            throw new BusinessException(ResponseEnum.ALIYUN_SMS_ERROR);
        }
    }
}

最后看一下控制台输出和短信效果


©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,335评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,895评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,766评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,918评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,042评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,169评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,219评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,976评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,393评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,711评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,876评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,562评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,193评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,903评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,699评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,764评论 2 351

推荐阅读更多精彩内容