使用这个jar包,不到10分钟便可接入短信及邮件发送功能!

createh53周前 (12-15)技术教程16

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

该方式不仅需要耗费大量时间去开发对接,而且写出来的代码也不优雅,今天要和大家分享一款jar包,聚合了当前主流短信服务厂商,以及邮件发送功能,只需不到10分钟,便可快速完成短信及邮件发送功能,写出的代码也优雅高端!

快速对接短信及邮件详细步骤

短信接入

1、引入jar包依赖

pom.xml加入以下依赖,这里我们使用最新版本3.3.3,该版本支持邮件发送

<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

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配置

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、发送短信测试

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包依赖

<!-- 邮件发送 -->
<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端口,代码里授权码直接改成自己的即可直接使用

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进行邮件发送!

@GetMapping("/sendMail")
public R<Object> sendMail(String receiver) {
MailClient mailBlend = MailFactory.createMailClient("163mail");

String code = SmsUtils.getRandomInt(6);

MailMessage message = MailMessage.Builder()
// 收件人地址,此处可以为字符串的单个地址也可以为一个List<String>的群发地址
// 例如 .mailAddress (new ArrayList<String>().add("XXXXXXXXX@qq.com"))
.mailAddress("a173959@gmail.com")
// 邮件的标题
.title("测试标题")
// 邮件的文字正文,但是如果发送html邮件时候,大多数的邮件服务商会隐藏掉body的信息
.body("测试邮件发送")
// html模板来源,此处与mailAddress相似可以为一个字符串形式的html文件名,此时默认读取resources/template目录下的文件
// 也可以为一个 InputStream 输入流
// 例如 .html(Files.newInputStream(new File("D:\\index.html").toPath()))
.htmlContent("你的最新验证码是: " + code)
/*
                 * html模板变量,如果你的html不需要变量,则可以为空,这里有多种的用法
                 * Map map的key为变量名称,map的value为变量的值
                 * 例如 Map<String,String> map = new HashMap<String,String>().put("变量名称","变量值");
                 * .htmlValues(map)
                 * 还可以直接写入变量名称和变量值 如.htmlValues("变量名称",“变量值”)
                 * 此处也可以使用接口进行,接口形式在下方详细介绍
                 */
// .htmlValues(variables)
// 抄送人,可以添加一个或多个,使用方式与.mailAddress一致
.cc("173959@163.com")
// 密送人,可以添加一个或多个,使用方式与.mailAddress一致
.bcc("a173959@163.com")
// 附件,此处与.htmlValues使用方法相似,如果你只有一个附件,可以直接填写key value 如果你有多个附件,这里可以接受一个map
// .files(“文件名”,"文件路径")
// //3.0版本支持发送文件自动压缩,你可以选择指定这里的压缩文件名称,框架将会自动将 .files中的所有文件打为一个压缩包并发送
// .zipName("压缩文件名称")
.build();

log.info("开始发送邮件");

mailBlend.send(message);

return R.ok("发送成功");
}

验证码可以使用SmsUtils实现,该工具类提供了一些常用方法

5、测试邮件发送

使用postman调用本地接口

查看邮件接收情况

sms4j使用官方文档

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

相关文章

100个Java工具类之15:免费发送邮件

该系列为java工具类系列,主要展示100个常用的java工具类。本系列工具类的核心目的主要有三点:1,以便他用:提供可用的Java工具类,方便大家使用,避免重复造轮子2,个人记录:作为个人记录,同时...

Java之数组数据操作之电子邮件地址判断

java源代码:/***<p>Title:数组数据操作之电子邮件地址判断</p>*<p>Description:演示一维数组和多维数组的初始化和基本操作</p...

Spring Boot集成Spring Email发送邮件

引言在当今数字化时代,电子邮件仍然是重要的沟通工具之一。在使用Spring Boot框架开发应用程序时,有时需要集成邮件发送功能,以便在用户注册、找回密码、接收通知等场景中向用户发送邮件。本文将介绍如...

Linux中用postfix搭建邮件服务器实战详解

写在前面:自建邮件服务器发出的邮件有很大概率会被各大邮件服务商列入垃圾邮件箱中,我在搭建过程中发现在设置了dkim spf 等操作后,国内邮件基本可以正常发到收件箱,但 google 邮箱貌似还是会进...

阿里二面:说下如何基于SpringBoot发送邮件?

在我们实际业务开发中邮件发送其实是一个非常常见的需求,用户注册,找回密码等地方都会用到,使用JavaSE代码发送邮件步骤还是挺繁琐的。SpringBoot中对于邮件发送,提供了相关的自动化配置类,使得...