1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*
 *      Copyright (c) 2018-2028, Chill Zhuang All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  Redistributions in binary form must reproduce the above copyright
 *  notice, this list of conditions and the following disclaimer in the
 *  documentation and/or other materials provided with the distribution.
 *  Neither the name of the dreamlu.net developer nor the names of its
 *  contributors may be used to endorse or promote products derived from
 *  this software without specific prior written permission.
 *  Author: Chill 庄骞 (smallchill@163.com)
 */
package org.springblade.core.sms;
 
import org.springblade.core.sms.model.SmsCode;
import org.springblade.core.sms.model.SmsData;
import org.springblade.core.sms.model.SmsInfo;
import org.springblade.core.sms.model.SmsResponse;
import org.springblade.core.tool.utils.StringPool;
import org.springframework.util.StringUtils;
 
import java.util.Collection;
import java.util.Collections;
 
import static org.springblade.core.sms.constant.SmsConstant.CAPTCHA_KEY;
 
/**
 * 短信通用封装
 *
 * @author Chill
 */
public interface SmsTemplate {
 
    /**
     * 缓存键值
     *
     * @param phone 手机号
     * @param id    键值
     * @return 缓存键值返回
     */
    default String cacheKey(String phone, String id) {
        return CAPTCHA_KEY + phone + StringPool.COLON + id;
    }
 
    /**
     * 发送短信
     *
     * @param smsInfo 短信信息
     * @return 发送返回
     */
    default boolean send(SmsInfo smsInfo) {
        return sendMulti(smsInfo.getSmsData(), smsInfo.getPhones());
    }
 
    /**
     * 发送短信
     *
     * @param smsData 短信内容
     * @param phone   手机号
     * @return 发送返回
     */
    default boolean sendSingle(SmsData smsData, String phone) {
        if (StringUtils.isEmpty(phone)) {
            return Boolean.FALSE;
        }
        return sendMulti(smsData, Collections.singletonList(phone));
    }
 
    /**
     * 发送短信
     *
     * @param smsData 短信内容
     * @param phones  手机号列表
     * @return 发送返回
     */
    default boolean sendMulti(SmsData smsData, Collection<String> phones) {
        SmsResponse response = sendMessage(smsData, phones);
        return response.isSuccess();
    }
 
    /**
     * 发送短信
     *
     * @param smsData 短信内容
     * @param phones  手机号列表
     * @return 发送返回
     */
    SmsResponse sendMessage(SmsData smsData, Collection<String> phones);
 
    /**
     * 发送验证码
     *
     * @param smsData 短信内容
     * @param phone   手机号
     * @return 发送返回
     */
    SmsCode sendValidate(SmsData smsData, String phone);
 
    /**
     * 校验验证码
     *
     * @param smsCode 验证码内容
     * @return 是否校验成功
     */
    boolean validateMessage(SmsCode smsCode);
 
}