com.moon.spring.annotation.verify.VerifySmsCaptcha Maven / Gradle / Ivy

Go to download
package com.moon.spring.annotation.verify;

import com.moon.spring.interceptor.InterceptorUtil;
import com.moon.spring.interceptor.verify.VerifySmsCaptchaInterceptor;

import javax.servlet.http.HttpServletRequest;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.function.BiPredicate;

/**
 * 短信验证码校验
 *
 * @author moonsky
 * @see InterceptorUtil#verifySmsCaptcha(BiPredicate)
 * @see VerifySmsCaptchaInterceptor
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface VerifySmsCaptcha {

    /**
     * 从{@code request}中获取短信验证码的{@code key}
     *
     * @return
     *
     * @see HttpServletRequest#getParameter(String)
     */
    String value() default "smsCaptcha";

    /**
     * 获取方式
     *
     * @return 获取短信验证码的方式
     */
    FromType fromType() default FromType.PARAMETER;
}