最近在给我的AI工具(https://ai.quanyouhulian.com/)新增个**短信及邮箱登录功能,按传统方式,一般是在后端引入各短信服务商SDK-jar包,以及短信邮件的maven包(javax.mail**)

该方式不仅需要耗费大量时间去开发对接,而且写出来的代码也不优雅,今天要和大家分享一款jar包,聚合了当前主流短信服务厂商,以及邮件发送功能,**只需不到10分钟,便可快速完成短信及邮件发送功能**,写出的代码也优雅高端!
快速对接短信及邮件详细步骤
短信接入
1、引入jar包依赖
pom.xml加入以下依赖,这里我们使用最新版本3.3.3,**该版本支持邮件发送**!
1 2 3 4 5
| <dependency> <groupId>org.dromara.sms4j</groupId> <artifactId>sms4j-spring-boot-starter</artifactId> <version>3.3.3</version> </dependency>
|
**该包已经被收纳进阿里云公共仓库**了,只要你maven的setting.xml镜像配置了阿里云的公共仓库:http://maven.aliyun.com/nexus/content/groups/public/,便能自动获取到该类

2、获取阿里云AccessKey
进入阿里云:https://ecs.console.aliyun.com/,登录主账号点击右上角进入AccessKey界面

创建Accesskey,把这一串Accesskey ID和Accesskey Secret保存好,配置会用到

添加短信签名,该签名就是国内短信开头【】那一部分,下面配置会用到

3、配置阿里云密钥
这里有两种方式,一种是用yml文件配置,一种直接写在初始化bean内,sms4j3.0之后版本推荐使用bean配置!
新增2个类,AliReadConfig和Demo
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
| import java.util.List;
import org.dromara.sms4j.aliyun.config.AlibabaConfig; import org.dromara.sms4j.core.datainterface.SmsReadConfig; import org.dromara.sms4j.provider.config.BaseConfig; import org.springframework.stereotype.Component;
import lombok.extern.slf4j.Slf4j;
@Slf4j @Component public class AliReadConfig implements SmsReadConfig {
@Override public BaseConfig getSupplierConfig(String configId) { // 这里需要注意,UniConfig只是代表合一短信的配置类,仅做示例使用,根据不同厂商选择实例化不同的配置类 AlibabaConfig alibabaConfig = new AlibabaConfig(); // 此处仅为示例,实际环境中,数据可以来自任意位置, log.info("开始配置阿里云短信"); alibabaConfig.setAccessKeyId("LTAIxxxxxxxxxxx"); alibabaConfig.setAccessKeySecret("1Nyxxxxxxxxxxxxxxxxxxxxxx"); alibabaConfig.setSignature("圈友互联"); return alibabaConfig; }
@Override public List<BaseConfig> getSupplierConfigList() { // 初始化一个配置列表 // 返回配置列表 return null; } }
|
这里初始化只需要加3个参数:AccessKeyId、AccessKeySecret、Signature

另外新增个Demo类,主要作用加载AliReadConfig配置
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
| import org.dromara.sms4j.comm.constant.SupplierConstant; import org.dromara.sms4j.core.factory.SmsFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.event.ContextRefreshedEvent; import org.springframework.context.event.EventListener; import org.springframework.stereotype.Component;
import lombok.extern.slf4j.Slf4j;
@Slf4j @Component public class Demo {
@Autowired AliReadConfig aliReadConfig;
@EventListener public void init(ContextRefreshedEvent event) { log.info("开始创建SmsBlend 短信实例"); // 创建SmsBlend 短信实例 SmsFactory.createSmsBlend(aliReadConfig, SupplierConstant.ALIBABA); } }
|
4、发送短信测试
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
| import java.util.LinkedHashMap;
import org.dromara.sms4j.api.SmsBlend; import org.dromara.sms4j.api.entity.SmsResponse; import org.dromara.sms4j.comm.constant.SupplierConstant; import org.dromara.sms4j.core.factory.SmsFactory; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController;
import com.baomidou.mybatisplus.extension.api.R;
import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j;
@Slf4j @Validated @RequiredArgsConstructor @RestController @RequestMapping("/demo/sms") public class SMSController { /** * 发送短信Aliyun * * @param phones 电话号 * @param templateId 模板ID */ @GetMapping("/sendAliyun") public R<Object> sendAliyun(String phones, String templateId) { SmsBlend smsBlend = SmsFactory.getSmsBlend(SupplierConstant.ALIBABA); log.info("开始发送短信"); LinkedHashMap<String, String> messages = new LinkedHashMap<>(); messages.put("code", "123321"); SmsResponse smsResponse = smsBlend.sendMessage("18588443913", "SMS_280655083", messages); return R.ok(smsResponse); } }
|
这里SmsFactory.getSmsBlend(SupplierConstant.ALIBABA);获取的configId便是前面Demo配置的那个id

这里模板id对应的是云厂商的模版CODE,以阿里云(https://dysms.console.aliyun.com/domestic/text/template)为例:

使用postman调用本地controller方法

查看短信接收情况,成功!

5、其他类型短信场景发送
SmsBlend还支持异步,延时短信发送,直接调用即可,框架已经封装了实现逻辑!

邮件接入
1、引入jar包依赖
pom.xml新增以下jar包依赖
1 2 3 4 5 6
| <!-- 邮件发送 --> <dependency> <groupId>org.dromara.sms4j</groupId> <artifactId>sms4j-Email-core</artifactId> <version>3.3.3</version> </dependency>
|
2、获取邮件授权码
进到163邮箱,点击设置,开启IMAP、POP3服务

把这一串授权码拷贝下来,代码MailSmtpConfig设置时候会用到

3、代码配置MailSmtpConfig参数
继续在之前的短信初始配置里加上邮件SMTP配置,这里把Demo名字改成SmsConfig,该描述准确些

具体实现代码如下,这里端口使用465端口,默认用ssl协议会使用465端口,代码里授权码直接改成自己的即可直接使用
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
| import org.dromara.email.comm.config.MailSmtpConfig; import org.dromara.email.core.factory.MailFactory; import org.dromara.sms4j.comm.constant.SupplierConstant; import org.dromara.sms4j.core.factory.SmsFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.event.ContextRefreshedEvent; import org.springframework.context.event.EventListener; import org.springframework.stereotype.Component;
import lombok.extern.slf4j.Slf4j;
@Slf4j @Component public class SmsConfig {
@Autowired AliReadConfig aliReadConfig;
@EventListener public void init(ContextRefreshedEvent event) { log.info("开始创建SmsBlend 短信实例"); // 创建SmsBlend 短信实例 SmsFactory.createSmsBlend(aliReadConfig, SupplierConstant.ALIBABA);
// 以下仅做演示,实际使用需要填入数据 MailSmtpConfig mailconfig = MailSmtpConfig.builder().port("465").fromAddress("f1732459@163.com") .smtpServer("smtp.163.com").username("f1732459@163.com").nickName("圈友互联AI") .password("你自己邮箱授权码").build();
MailFactory.put("163mail", mailconfig); } }
|
4、编写邮件发送类
这里填写MailMessage相关参数,使用mailBlend进行邮件发送!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
| @GetMapping("/sendMail") public R<Object> sendMail(String receiver) { MailClient mailBlend = MailFactory.createMailClient("163mail");
String code = SmsUtils.getRandomInt(6);
MailMessage message = MailMessage.Builder()
.mailAddress("a173959@gmail.com")
.title("测试标题")
.body("测试邮件发送")
.htmlContent("你的最新验证码是: " + code)
.cc("173959@163.com")
.bcc("a173959@163.com")
.build();
log.info("开始发送邮件");
mailBlend.send(message);
return R.ok("发送成功"); }
|
验证码可以使用SmsUtils实现,该工具类提供了一些常用方法

5、测试邮件发送
使用postman调用本地接口

查看邮件接收情况

sms4j使用官方文档
官方文档也有部分参数解释,可以参考:https://sms4j.com/doc3/