com.taotao.boot.sms.common.service.VerificationCodeService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of taotao-boot-starter-sms-common Show documentation

taotao-boot-starter-sms-common

The newest version!

/*
 * Copyright (c) 2020-2030, Shuigedeng ([email protected] & https://blog.taotaocloud.top/).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.taotao.boot.sms.common.service;

import org.springframework.lang.Nullable;

/**
 * 手机验证码服务
 *
 * @author shuigedeng
 * @version 2022.04
 * @since 2022-04-27 17:49:33
 */
public interface VerificationCodeService {

    /** 味精关键代码 验证码短信中验证码对应的key */
    String MSG_KEY_CODE = "code";

    /** 味精主要识别代码 验证码短信中识别码对应的key */
    String MSG_KEY_IDENTIFICATION_CODE = "identificationCode";

    /** 味精关键过期时间秒 验证码短信中有效期(秒)对应的key */
    String MSG_KEY_EXPIRATION_TIME_OF_SECONDS = "expirationTimeOfSeconds";

    /** 味精关键过期时间分钟 验证码短信中有效期(分)对应的key */
    String MSG_KEY_EXPIRATION_TIME_OF_MINUTES = "expirationTimeOfMinutes";

    /**
     * 查询手机验证码
     *
     * @param phone 手机号
     * @param identificationCode 识别码
     * @return {@link String }
     * @since 2022-04-27 17:49:33
     */
    @Nullable
    String find(String phone, String identificationCode);

    /**
     * 发送验证码
     *
     * @param phone 手机号码
     * @since 2022-04-27 17:49:33
     */
    default void send(String phone) {
        send(phone, null);
    }

    /**
     * 发送验证码
     *
     * @param phone 手机号码
     * @param type 类型
     * @since 2022-04-27 17:49:33
     */
    void send(String phone, @Nullable String type);

    /**
     * 验证
     *
     * @param phone 手机号码
     * @param code 验证码
     * @param identificationCode 识别码
     * @return boolean
     * @since 2022-04-27 17:49:33
     */
    boolean verify(String phone, String code, @Nullable String identificationCode);
}