溫馨提示×

溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×

忘記密碼？

登錄注冊×

獲取短信驗證碼

其他方式登錄

點擊登錄注冊即表示同意《億速云用戶服務條款》

用戶登錄×

賬戶密碼登錄

請使用微信掃描上方二維碼

使用幫助

請求超時！

請點擊重新獲取二維碼

SpringBoot集成短信和郵件的配置方法

發布時間：2022-04-22 10:04:56 來源：億速云閱讀：266 作者：iii 欄目：開發技術

本文小編為大家詳細介紹“SpringBoot集成短信和郵件的配置方法”，內容詳細，步驟清晰，細節處理妥當，希望這篇“SpringBoot集成短信和郵件的配置方法”文章能幫助大家解決疑惑，下面跟著小編的思路慢慢深入，一起來學習新知識吧。

準備工作

1、集成郵件

以QQ郵箱為例

在發送郵件之前，要開啟POP3和SMTP協議，需要獲得郵件服務器的授權碼，獲取授權碼：

1、設置>賬戶

在賬戶的下面有一個開啟SMTP協議的開關并進行密碼驗證：

SpringBoot集成短信和郵件的配置方法

2、獲取成功的授權碼

SpringBoot集成短信和郵件的配置方法

2、集成短信

以阿里云短信服務為例

1、登陸阿里云—>進入控制臺—>開通短信服務

進入后根據提示開通短信服務即可。

2、充值

后期發短信測試需要，暫時可以跳過此步驟。

3、獲取AccessKey和AccessSercet

4、API

依賴

1、郵件

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

2、短信

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>dysmsapi20170525</artifactId>
    <version>2.0.4</version>
</dependency>

配置

1、配置郵箱基本信息

spring:
  mail:
    # 配置 SMTP 服務器地址
    host: smtp.qq.com
    # 發送者郵箱
    username: 742354529@qq.com
    # 配置密碼，注意不是真正的密碼，而是申請的授權碼
    password: vjstfghblprwbdbd
    # 端口號465或587
    port: 587 
    # 默認的郵件編碼為UTF-8
    default-encoding: UTF-8
    # 配置SSL 加密工廠
    properties:
      mail:
        smtp:
          socketFactoryClass: javax.net.ssl.SSLSocketFactory
        # 表示開啟DEBUG模式，郵件發送過程的日志會在控制臺打印出來
        debug: true

SMTP 服務器地址

126郵箱SMTP服務器地址:smtp.126.com,端口號:465或者994
2163郵箱SMTP服務器地址:smtp.163.com,端口號:465或者994
yeah郵箱SMTP服務器地址:smtp.yeah.net,端口號:465或者994
qq郵箱SMTP服務器地址：smtp.qq.com,端口號465或587*

2、短信配置

# 阿里云短信配置
sms:
  access-id: LTAI5tDP3SDQC9yvCguiiFDr
  access-key: EGSDQsLxCVS5dwjS8DCxmYQ124XySV
  sign-name: 
  endpoint: dysmsapi.aliyuncs.com

編碼

1、郵件

1.1、MailService.java

package com.tanersci.service;

import com.tanersci.dto.MailMessageDto;
import com.tanersci.vo.MessageVo;
/**
 * @ClassName： MailService.java
 * @ClassPath： com.tanersci.service.MailService.java
 * @Description： 郵件
 * @Author： tanyp
 * @Date： 2021/6/7 9:18
 **/
public interface MailService {
	/**
	 * @MonthName： sendSimple
	 * @Description： 普通郵件發送
	 * @Author： tanyp
	 * @Date： 2021/6/7 9:30
	 * @Param： [dto]
	 * @return： void
	 **/
	MessageVo sendSimple(MailMessageDto dto);
	 * @MonthName： sendAttachFile
	 * @Description： 帶附件的郵件
	MessageVo sendAttachFile(MailMessageDto dto);
	 * @MonthName： sendImgRes
	 * @Description： 帶圖片資源的郵件
	MessageVo sendImgRes(MailMessageDto dto);
}

1.2、MailServiceImpl.java

package com.tanersci.service.impl;

import com.alibaba.fastjson.JSON;
import com.tanersci.dto.MailMessageDto;
import com.tanersci.vo.MessageVo;
import com.tanersci.constant.Constants;
import com.tanersci.service.MailService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.FileSystemResource;
import org.springframework.mail.MailException;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Service;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import java.time.LocalDateTime;
import java.util.Date;
import java.util.Objects;
/**
 * @ClassName： MailServiceImpl.java
 * @ClassPath： com.tanersci.service.impl.MailServiceImpl.java
 * @Description： 郵件
 * @Author： tanyp
 * @Date： 2021/6/7 9:18
 **/
@Slf4j
@Service
public class MailServiceImpl implements MailService {
	@Value("${spring.mail.username}")
	private String sender;
	@Autowired
	private JavaMailSender javaMailSender;
	/**
	 * @MonthName： sendSimple
	 * @Description： 普通郵件發送
	 * @Author： tanyp
	 * @Date： 2021/6/7 9:30
	 * @Param： [dto]
	 * @return： void
	 **/
	@Override
	public MessageVo sendSimple(MailMessageDto dto) {
		try {
			log.info("=======普通郵件發送開始，請求參數：{}", JSON.toJSON(dto));
			// 構建一個郵件對象
			SimpleMailMessage message = new SimpleMailMessage();
			// 設置郵件主題
			message.setSubject(dto.getSubject());
			// 設置郵件發送者，這個跟application.yml中設置的要一致
			message.setFrom(sender);
			// 設置郵件接收者，可以有多個接收者，中間用逗號隔開，以下類似
			// message.setTo("10*****16@qq.com","12****32*qq.com");
			message.setTo(dto.getRecipient());
			// 設置郵件抄送人，可以有多個抄送人
			if (Objects.nonNull(dto.getCc())) {
				message.setCc(dto.getCc());
			}
			// 設置隱秘抄送人，可以有多個
			if (Objects.nonNull(dto.getBcc())) {
				message.setBcc(dto.getBcc());
			// 設置郵件發送日期
			message.setSentDate(new Date());
			// 設置郵件的正文
			message.setText(dto.getText());
			// 發送郵件
			javaMailSender.send(message);
			log.info("=======普通郵件發送結束");
			return MessageVo.builder().code(Constants.NEWS_SUCCESS_CODE).message(Constants.NEWS_SUCCESS_MESSAGE).build();
		} catch (MailException e) {
			log.error("====郵件====sendSimple=====異常：{}", e);
			return MessageVo.builder().code(Constants.NEWS_FAIL_CODE).message(Constants.NEWS_FAIL_MESSAGE).build();
		}
	}
	 * @MonthName： sendAttachFile
	 * @Description： 帶附件的郵件
	public MessageVo sendAttachFile(MailMessageDto dto) {
			log.info("=======帶附件的郵件開始，請求參數：{}", JSON.toJSON(dto));
			MimeMessage mimeMessage = javaMailSender.createMimeMessage();
			// true表示構建一個可以帶附件的郵件對象
			MimeMessageHelper message = new MimeMessageHelper(mimeMessage, true);
			// 第一個參數是自定義的名稱，后綴需要加上，第二個參數是文件的位置
			dto.getAttachments().forEach(file -> {
				try {
					message.addAttachment(file.getName(), file);
				} catch (MessagingException e) {
					log.error("=========郵件附件解析異常：{}", e);
				}
			});
			javaMailSender.send(mimeMessage);
			log.info("=======帶附件的郵件結束");
		} catch (MessagingException e) {
			log.error("==========郵件====sendAttachFile=====異常：{}", e);
	 * @MonthName： sendImgRes
	 * @Description： 帶圖片資源的郵件
	public MessageVo sendImgRes(MailMessageDto dto) {
			log.info("=======帶圖片資源的郵件開始，請求參數：{}", JSON.toJSON(dto));
			// 第一個參數指的是html中占位符的名字，第二個參數就是文件的位置
					message.addInline(file.getName(), new FileSystemResource(file));
					log.error("=========郵件圖片解析異常：{}", e);
			log.info("=======帶圖片資源的郵件結束");
			log.error("====郵件====sendImgRes=====異常：{}", e);
}

1.3、VO、DTO及常量類

MailMessageDto.java

package com.tanersci.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.File;
import java.io.Serializable;
import java.util.List;
/**
 * @ClassName： MailMessageDto.java
 * @ClassPath： com.tanersci.dto.MailMessageDto.java
 * @Description： 郵件消息
 * @Author： tanyp
 * @Date： 2021/6/7 9:20
 **/
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
@ApiModel(value = "郵件消息")
public class MailMessageDto implements Serializable {
	private static final long serialVersionUID = 5483400172436286831L;
	@ApiModelProperty(value = "郵件主題")
	private String subject;
	@ApiModelProperty(value = "接收者：可以有多個接收者，中間用逗號隔開")
	private String recipient;
	@ApiModelProperty(value = "抄送人：可以有多個抄送人，中間用逗號隔開")
	private String cc;
	@ApiModelProperty(value = "隱秘抄送人：可以有多個抄送人，中間用逗號隔開")
	private String bcc;
	@ApiModelProperty(value = "正文")
	private String text;
	@ApiModelProperty(value = "模板編碼")
	private String code;
	@ApiModelProperty(value = "附件、圖片")
	private List<File> attachments;
}

MessageVo.java

package com.tanersci.vo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
/**
 * @ClassName： MessageVo.java
 * @ClassPath： com.tanersci.vo.MessageVo.java
 * @Description： 短信、郵件消息返回值
 * @Author： tanyp
 * @Date： 2021/6/7 11:35
 **/
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
@ApiModel(value = "短信、郵件消息返回值")
public class MessageVo implements Serializable {
	private static final long serialVersionUID = 5287525465339500144L;
	@ApiModelProperty(value = "狀態碼")
	private String code;
	@ApiModelProperty(value = "狀態碼的描述")
	private String message;
	@ApiModelProperty(value = "請求ID")
	private String requestId;
	@ApiModelProperty(value = "發送回執ID")
	private String bizId;
	@ApiModelProperty(value = "模板編碼")
	private String templateCode;
}

Constants.java

package com.tanersci.constant;

/**
 * @ClassName： Constants.java
 * @ClassPath： com.tanersci.constant.Constants.java
 * @Description： 常量
 * @Author： tanyp
 * @Date： 2021/5/22 15:54
 **/
public class Constants {
	/**
	 * 消息發送狀態碼
	 */
	public final static String NEWS_SUCCESS_CODE = "OK";
	public final static String NEWS_SUCCESS_MESSAGE = "發送成功";
	public final static String NEWS_FAIL_CODE = "FAIL";
	public final static String NEWS_FAIL_MESSAGE = "發送失敗";
}

2、短信

2.1、SmsService.java

package com.tanersci.service;

import com.tanersci.dto.SmsMessageDto;
import com.tanersci.dto.SmsTemplateDto;
import com.tanersci.vo.MessageVo;
/**
 * @ClassName： SmsService.java
 * @ClassPath： com.tanersci.service.SmsService.java
 * @Description： 短信
 * @Author： tanyp
 * @Date： 2021/6/7 10:56
 **/
public interface SmsService {
	/**
	 * @MonthName： send
	 * @Description： 發短信
	 * @Author： tanyp
	 * @Date： 2021/6/7 14:50
	 * @Param： [dto]
	 * @return： com.tanersci.vo.MessageVo
	 **/
	MessageVo send(SmsMessageDto dto);
	 * @MonthName： addSmsTemplate
	 * @Description： 申請短信模板
	 * @Param： [template]
	MessageVo addSmsTemplate(SmsTemplateDto template);
	 * @MonthName： deleteSmsTemplate
	 * @Description： 刪除短信模板
	MessageVo deleteSmsTemplate(SmsTemplateDto template);
	 * @MonthName： modifySmsTemplate
	 * @Description： 修改未通過審核的短信模板
	MessageVo modifySmsTemplate(SmsTemplateDto template);
	 * @MonthName： querySmsTemplate
	 * @Description： 查詢短信模板的審核狀態
	MessageVo querySmsTemplate(SmsTemplateDto template);
}

2.2、SmsServiceImpl.java

package com.tanersci.service.impl;

import com.alibaba.fastjson.JSON;
import com.aliyun.dysmsapi20170525.Client;
import com.aliyun.dysmsapi20170525.models.*;
import com.aliyun.teaopenapi.models.Config;
import com.tanersci.dto.SmsMessageDto;
import com.tanersci.dto.SmsTemplateDto;
import com.tanersci.vo.MessageVo;
import com.tanersci.config.SmsConfig;
import com.tanersci.constant.Constants;
import com.tanersci.service.SmsService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.time.LocalDateTime;
import java.util.Objects;
import java.util.UUID;
/**
 * @ClassName： SmsServiceImpl.java
 * @ClassPath： com.tanersci.service.impl.SmsServiceImpl.java
 * @Description： 短信
 * @Author： tanyp
 * @Date： 2021/6/7 10:57
 **/
@Slf4j
@Service
public class SmsServiceImpl implements SmsService {
	@Autowired
	private SmsConfig smsConfig;
	/**
	 * @MonthName： createClient
	 * @Description： SK初始化賬號Client
	 * @Author： tanyp
	 * @Date： 2021/6/7 15:44
	 * @Param： [accessId, accessKey, endpoint]
	 * @return： com.aliyun.teaopenapi.Client
	 **/
	public Client createClient() throws Exception {
		Config config = new Config();
		config.accessKeyId = smsConfig.getAccessId();
		config.accessKeySecret = smsConfig.getAccessKey();
		config.endpoint = smsConfig.getEndpoint();
		return new Client(config);
	}
	 * @MonthName： send
	 * @Description： 發短信
	 * @Date： 2021/6/7 14:50
	 * @Param： [dto]
	 * @return： com.tanersci.vo.MessageVo
	@Override
	public MessageVo send(SmsMessageDto dto) {
		try {
			log.info("======發送短信開始，請求參數：{}", JSON.toJSON(dto));
			Client client = createClient();
			// 組裝請求對象
			SendSmsRequest request = new SendSmsRequest();
			// 外部流水擴展字段
			String outId = UUID.randomUUID().toString();
			request.setOutId(outId);
			// 支持對多個手機號碼發送短信，手機號碼之間以英文逗號（,）分隔。上限為1000個手機號碼。批量調用相對于單條調用及時性稍有延遲。
			request.setPhoneNumbers(dto.getPhone());
			// 短信簽名名稱
			request.setSignName(smsConfig.getSignName());
			// 短信模板ID
			request.setTemplateCode(dto.getTemplateCode());
			// 短信模板變量對應的實際值，JSON格式。如果JSON中需要帶換行符，請參照標準的JSON協議處理。
			request.setTemplateParam(JSON.toJSONString(dto.getParam()));
			// 發送短信
			SendSmsResponse res = client.sendSms(request);
			
			MessageVo message = MessageVo.builder().build();
			if (Objects.equals(Constants.NEWS_SUCCESS_CODE, res.body.getCode())) {
				log.info("======發送短信成功，返回值：{}", JSON.toJSON(res.body));
				message.setCode(Constants.NEWS_SUCCESS_CODE);
				message.setMessage(Constants.NEWS_SUCCESS_MESSAGE);
			} else {
				log.info("======發送短信失敗，返回值：{}", JSON.toJSON(res.body));
				message.setCode(Constants.NEWS_FAIL_CODE);
				message.setMessage(Constants.NEWS_FAIL_MESSAGE);
			}
			return message;
		} catch (Exception e) {
			log.error("======發送短信異常：{}", e.getMessage());
			e.printStackTrace();
			return MessageVo.builder().code(Constants.NEWS_FAIL_CODE).message(Constants.NEWS_FAIL_MESSAGE).build();
		}
	 * @MonthName： addSmsTemplate
	 * @Description： 申請短信模板
	 * @Param： [template]
	public MessageVo addSmsTemplate(SmsTemplateDto template) {
			log.info("======申請短信模板，請求參數：{}", JSON.toJSON(template));
			AddSmsTemplateRequest request = new AddSmsTemplateRequest();
			request.setTemplateType(template.getTemplateType());
			request.setTemplateName(template.getTemplateName());
			request.setTemplateContent(template.getTemplateContent());
			request.setRemark(template.getRemark());
			AddSmsTemplateResponse res = client.addSmsTemplate(request);
			if (Objects.equals(TeamConstants.NEWS_SUCCESS_CODE, res.body.getCode())) {
				log.info("======申請短信模板，返回值：{}", JSON.toJSON(res.body));
				return MessageVo.builder()
						.code(Constants.NEWS_SUCCESS_CODE)
						.message(Constants.NEWS_SUCCESS_MESSAGE)
						.templateCode(res.getBody().templateCode)
						.build();
				return MessageVo.builder().code(Constants.NEWS_FAIL_CODE).message(Constants.NEWS_FAIL_MESSAGE).build();
			log.error("======申請短信模板，異常：{}", e.getMessage());
	 * @MonthName： deleteSmsTemplate
	 * @Description： 刪除短信模板
	public MessageVo deleteSmsTemplate(SmsTemplateDto template) {
			log.info("======刪除短信模板，請求參數：{}", JSON.toJSON(template));
			DeleteSmsTemplateRequest request = new DeleteSmsTemplateRequest();
			request.setTemplateCode(template.getTemplateCode());
			DeleteSmsTemplateResponse res = client.deleteSmsTemplate(request);
				log.info("======刪除短信模板，返回值：{}", JSON.toJSON(res.body));
				return MessageVo.builder().code(Constants.NEWS_SUCCESS_CODE).message(Constants.NEWS_SUCCESS_MESSAGE).build();
			log.error("======刪除短信模板，異常：{}", e);
	 * @MonthName： modifySmsTemplate
	 * @Description： 修改未通過審核的短信模板
	public MessageVo modifySmsTemplate(SmsTemplateDto template) {
			log.info("======修改未通過審核的短信模板，請求參數：{}", JSON.toJSON(template));
			ModifySmsTemplateRequest request = new ModifySmsTemplateRequest();
			ModifySmsTemplateResponse res = client.modifySmsTemplate(request);
				log.info("======修改未通過審核的短信模板，返回值：{}", JSON.toJSON(res.body));
			log.error("======修改未通過審核的短信模板，異常：{}", e.getMessage());
	 * @MonthName： querySmsTemplate
	 * @Description： 查詢短信模板的審核狀態
	public MessageVo querySmsTemplate(SmsTemplateDto template) {
			log.info("======查詢短信模板的審核狀態，請求參數：{}", JSON.toJSON(template));
			QuerySmsTemplateRequest request = new QuerySmsTemplateRequest();
			QuerySmsTemplateResponse res = client.querySmsTemplate(request);
				log.info("======查詢短信模板的審核狀態，返回值：{}", JSON.toJSON(res.body));
			log.error("======查詢短信模板的審核狀態，異常：{}", e.getMessage());
}

2.3、SmsConfig.java

package com.tanersci.config;

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
/**
 * @ClassName： SmsConfig.java
 * @ClassPath： com.tanersci.config.SmsConfig.java
 * @Description： 短信配置
 * @Author： tanyp
 * @Date： 2021/6/7 16:41
 **/
@Data
@Component
public class SmsConfig {
	@Value("${sms.access-id}")
	private String accessId;
	@Value("${sms.access-key}")
	private String accessKey;
	@Value("${sms.sign-name}")
	private String signName;
	@Value("${sms.endpoint}")
	private String endpoint;
}

2.4、VO、DTO類

MessageVo 同用郵件的

MailMessageDto.java

package com.tanersci.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
/**
 * @ClassName： MailMessageDto.java
 * @ClassPath： com.tanersci.dto.SmsMessageDto.java
 * @Description： 短信
 * @Author： tanyp
 * @Date： 2021/6/7 9:20
 **/
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
@ApiModel(value = "短信消息")
public class SmsMessageDto implements Serializable {
	private static final long serialVersionUID = 3427970548460798908L;
	@ApiModelProperty(value = "手機號，多個以逗號隔開")
	private String phone;
	@ApiModelProperty(value = "模板編碼")
	private String templateCode;
	@ApiModelProperty(value = "模板參數")
	private TemplateParamDto param;
	private String code;
}

SmsTemplate.java

package com.tanersci.dto;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
/**
 * @ClassName： SmsTemplate.java
 * @ClassPath： com.tanersci.dto.SmsTemplateDto.java
 * @Description： 短信模板
 * @Author： tanyp
 * @Date： 2021/6/7 15:02
 **/
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class SmsTemplateDto implements Serializable {
	private static final long serialVersionUID = -8909531614461840038L;
	/**
	 * 模板類型：0：驗證碼，1：短信通知，2：推廣短信，3：國際/港澳臺消息。
	 */
	private Integer templateType;
	 * 模板名稱，長度為1~30個字符
	private String templateName;
	 * 模板內容，長度為1~500個字符
	private String templateContent;
	 * 短信模板CODE
	private String templateCode;
	 * 短信模板申請說明。請在申請說明中描述您的業務使用場景，長度為1~100個字符
	private String remark;
}

注意

項目中使用lombok插件和swagger依賴，無相關依賴的請自行修改。

讀到這里，這篇“SpringBoot集成短信和郵件的配置方法”文章已經介紹完畢，想要掌握這篇文章的知識點還需要大家自己動手實踐使用過才能領會，如果想了解更多相關內容的文章，歡迎關注億速云行業資訊頻道。

向AI問一下細節

推薦閱讀：

免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。

上一篇新聞：
Java設計模式的代理模式怎么實現
下一篇新聞：
vue中的.capture和.self怎么區分

猜你喜歡

AI
助
手

產品服務

地區劃分

專題活動

幫助支持

關于我們

售后咨詢

7*24小時在線電話：400-100-2938

7*24小時在線 QQ：800811969

關注億速云

億速云公眾號

手機網站二維碼

亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女