net.sohelp.boot.admin.core.service.notice

类 PhoneNoticeService

java.lang.Object

net.sohelp.boot.admin.core.service.notice.PhoneNoticeService

@Service
public class PhoneNoticeService
extends Object

手机短信通知服务类，提供发送短信、验证码等功能。

从以下版本开始:

2023/4/18

作者:

AaronFung

构造器概要

构造器

构造器和说明
PhoneNoticeService()

方法概要

限定符和类型	方法和说明
String	getCode(String key) 获取指定手机号对应的验证码
void	removeCode(String key) 移除指定手机号在缓存中的验证码
String	send(long userId, String title, String content) 向指定用户发送短信内容（需用户已绑定手机号）
void	send(String phone, String templateCode, Map<String,Object> dataMap) 发送短信通知 从系统配置中获取阿里云短信服务参数，构造并发送短信请求 若短信发送失败则抛出业务异常
void	sendCode(String phone, String code) 向指定手机号发送验证码短信
void	sendMsg(String phone, String msg) 直接向指定手机号发送短信消息

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

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

构造器详细资料

PhoneNoticeService

public PhoneNoticeService()

方法详细资料

send

public void send(String phone,
                 String templateCode,
                 Map<String,Object> dataMap)
          throws Exception

发送短信通知 从系统配置中获取阿里云短信服务参数，构造并发送短信请求 若短信发送失败则抛出业务异常

参数:

phone - 接收短信的手机号码

dataMap - 短信模板变量参数映射表，键为变量名，值为变量值

抛出:

Exception - 当短信发送失败时抛出业务异常，包含阿里云返回的错误信息

send

@Comment(value="\u53d1\u9001\u624b\u673a\u77ed\u606f\u5185\u5bb9")
public String send(long userId,
                                                                                       String title,
                                                                                       String content)
                                                                                throws Exception

向指定用户发送短信内容（需用户已绑定手机号）

参数:

userId - 用户ID

title - 短信标题

content - 短信内容

返回:

发送结果描述信息

抛出:

Exception - 若用户未绑定手机号或发送失败时抛出异常

sendMsg

@Comment(value="\u53d1\u9001\u624b\u673a\u77ed\u6d88\u606f")
public void sendMsg(String phone,
                                                                                  String msg)
                                                                           throws Exception

直接向指定手机号发送短信消息

参数:

phone - 手机号码

msg - 要发送的消息内容

抛出:

Exception - 发送过程中出现错误则抛出异常

sendCode

@Comment(value="\u53d1\u9001\u624b\u673a\u9a8c\u8bc1\u7801")
public void sendCode(String phone,
                                                                                   String code)
                                                                            throws Exception

向指定手机号发送验证码短信

参数:

phone - 手机号码

code - 待发送的验证码

抛出:

Exception - 参数缺失或发送失败时抛出异常

getCode

public String getCode(String key)

获取指定手机号对应的验证码

参数:

key - 手机号作为键值

返回:

对应的验证码字符串，不存在或过期返回null

removeCode

public void removeCode(String key)

移除指定手机号在缓存中的验证码

参数:

key - 手机号