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
package com.iailab.module.system.service.sms;
 
import com.iailab.framework.common.exception.ServiceException;
import com.iailab.module.system.api.sms.dto.code.SmsCodeSendReqDTO;
import com.iailab.module.system.api.sms.dto.code.SmsCodeUseReqDTO;
import com.iailab.module.system.api.sms.dto.code.SmsCodeValidateReqDTO;
 
import javax.validation.Valid;
 
/**
 * 短信验证码 Service 接口
 *
 * @author iailab
 */
public interface SmsCodeService {
 
    /**
     * 创建短信验证码，并进行发送
     *
     * @param reqDTO 发送请求
     */
    void sendSmsCode(@Valid SmsCodeSendReqDTO reqDTO);
 
    /**
     * 验证短信验证码，并进行使用
     * 如果正确，则将验证码标记成已使用
     * 如果错误，则抛出 {@link ServiceException} 异常
     *
     * @param reqDTO 使用请求
     */
    void useSmsCode(@Valid SmsCodeUseReqDTO reqDTO);
 
    /**
     * 检查验证码是否有效
     *
     * @param reqDTO 校验请求
     */
    void validateSmsCode(@Valid SmsCodeValidateReqDTO reqDTO);
 
}