Skip to content

介绍

基于sms4j库进行配置简化,并没有对sms4j代码进行二次封装,直接采用sms4j库的使用方式即可。

依赖库

名称描述
sms4j-spring-boot-starter
sms4j-email-jakarta-core
sms4j-oa-core
jakarta.activation-api
zebra-common-util
lombok

快速开始

引入

xml
<dependency>
		<groupId>io.github.zhanghongbin</groupId>
		<artifactId>zebra-spring-boot-starter-message</artifactId>
</dependency>

具体使用方式参考sms4j使用文档,配置不采用sms4j配置,使用以下配置:

邮件配置

smtp 服务器地址
port 端口号
fromAddress 发件人地址
userName 账号
password 密码 注意的是如果你用的是QQ或者网易之类的邮箱需要的不是登录密码,而是授权码
ssl 是否开启ssl 默认开启 QQ之类的邮箱默认都需要ssl
auth 是否开启验证 默认开启
retryInterval 重试间隔(单位:秒),默认为5秒
maxRetries 重试次数,默认为1次

yml
zebra:
  message:
    mail:
	  smtp:
	  port:
	  ssl:
	  auth:
	  userName:
	  password:
	  fromAddress:
	  retryInterval:
	  maxRetries:

如果对邮件进行了配置,则可以从spring环境中使用 MailClient 对象,具体使用方法参见官网

java
@Autowired
private MailClient mailClient;

短信配置

supplier 厂商标识,标定此配置是哪个厂商,详细请看厂商标识介绍部分
access-key-id 您的accessKey
access-key-secret 您的accessKeySecret
signature 您的短信签名
template-id 模板ID 非必须配置,如果使用sendMessage的快速发送需此配置
sdk-app-id 您的sdkAppId 非必须配置

yml
zebra:
  message:
	sms:
	  supplier:
	  access-key-id:
	  access-key-secret:
	  signature:
	  template-id:
	  sdk-app-id:

如果对短信进行了配置,则可以从spring环境中使用 SmsBlend 对象,具体使用方法参见官网

java
@Autowired
private SmsBlend smsBlend;

oa配置

supplier 厂商标识,标定此配置是哪个厂商,详细请看厂商标识介绍部分
tokenId 您的accessKey webhook 中的 access_token
sign 您的sign 安全设置在验签模式下才的秘钥,非验签模式没有此值 非必须配置

yml
zebra:
  message:
	oa:
	  supplier:
	  tokenId:
	  sign:

如果对oa进行了配置,则可以从spring环境中使用 OaSender 对象,具体使用方法参见官网

java
@Autowired
private OaSender oaSender;