cn.zhxu.toys.msg

类 RateLimitMsgSender

java.lang.Object

cn.zhxu.toys.msg.RateLimitMsgSender

所有已实现的接口:

MsgSender

public class RateLimitMsgSender
extends Object
implements MsgSender

带限速功能的短信发送器

作者:

Troy.Zhou @ 2022/8/17

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	RateLimitMsgSender.CacheItem

构造器概要

构造器

构造器和说明
RateLimitMsgSender(String name)

方法概要

限定符和类型	方法和说明
protected SendResult	doSend(String key, String phone, String tmplName, String... tmplArgs)
String	getCachePrefix()
int	getCacheSeconds()
CacheService	getCacheService()
KeyResolver	getKeyResolver()
int	getMaxAllowPerUnit()
int	getMinIntervalSeconds()
MsgSender	getMsgSender()
long	getUnitSeconds()
List<String>	getWhiteList()
boolean	isErrorIfReject()
boolean	isRejectIfKeyBlank()
protected RateLimitRejection	reject(String phone, String tmplName, String key, String tip)
SendResult	send(String phone, String tmplName, String... tmplArgs) 发送信息
void	setCachePrefix(String cachePrefix)
void	setCacheSeconds(int cacheSeconds)
void	setCacheService(CacheService cacheService)
void	setErrorIfReject(boolean errorIfReject)
void	setKeyResolver(KeyResolver keyResolver)
void	setMaxAllowPerUnit(int maxAllowPerUnit)
void	setMinIntervalSeconds(int minIntervalSeconds)
void	setMsgSender(MsgSender msgSender)
void	setRejectIfKeyBlank(boolean rejectIfKeyBlank)
void	setUnitSeconds(long unitSeconds)
void	setWhiteList(List<String> whiteList)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

RateLimitMsgSender

public RateLimitMsgSender(String name)

方法详细资料

send

public SendResult send(String phone,
                       String tmplName,
                       String... tmplArgs)

从接口复制的说明: MsgSender

发送信息

指定者:

send 在接口中 MsgSender

参数:

phone - 手机号

tmplName - 模板名称

tmplArgs - 模板参数值

返回:

是否发送成功

doSend

protected SendResult doSend(String key,
                            String phone,
                            String tmplName,
                            String... tmplArgs)

reject

protected RateLimitRejection reject(String phone,
                                    String tmplName,
                                    String key,
                                    String tip)

getMsgSender

public MsgSender getMsgSender()

setMsgSender

public void setMsgSender(MsgSender msgSender)

getKeyResolver

public KeyResolver getKeyResolver()

setKeyResolver

public void setKeyResolver(KeyResolver keyResolver)

getCacheService

public CacheService getCacheService()

setCacheService

public void setCacheService(CacheService cacheService)

getCachePrefix

public String getCachePrefix()

setCachePrefix

public void setCachePrefix(String cachePrefix)

getMaxAllowPerUnit

public int getMaxAllowPerUnit()

setMaxAllowPerUnit

public void setMaxAllowPerUnit(int maxAllowPerUnit)

getUnitSeconds

public long getUnitSeconds()

setUnitSeconds

public void setUnitSeconds(long unitSeconds)

getCacheSeconds

public int getCacheSeconds()

setCacheSeconds

public void setCacheSeconds(int cacheSeconds)

getMinIntervalSeconds

public int getMinIntervalSeconds()

setMinIntervalSeconds

public void setMinIntervalSeconds(int minIntervalSeconds)

getWhiteList

public List<String> getWhiteList()

setWhiteList

public void setWhiteList(List<String> whiteList)

isRejectIfKeyBlank

public boolean isRejectIfKeyBlank()

setRejectIfKeyBlank

public void setRejectIfKeyBlank(boolean rejectIfKeyBlank)

isErrorIfReject

public boolean isErrorIfReject()

setErrorIfReject

public void setErrorIfReject(boolean errorIfReject)