您好,登錄后才能下訂單哦!
本文小編為大家詳細(xì)介紹“SpringBoot集成短信和郵件的配置方法”,內(nèi)容詳細(xì),步驟清晰,細(xì)節(jié)處理妥當(dāng),希望這篇“SpringBoot集成短信和郵件的配置方法”文章能幫助大家解決疑惑,下面跟著小編的思路慢慢深入,一起來(lái)學(xué)習(xí)新知識(shí)吧。
以QQ郵箱為例
在發(fā)送郵件之前,要開(kāi)啟POP3和SMTP協(xié)議,需要獲得郵件服務(wù)器的授權(quán)碼,獲取授權(quán)碼:
1、設(shè)置>賬戶(hù)
在賬戶(hù)的下面有一個(gè)開(kāi)啟SMTP協(xié)議的開(kāi)關(guān)并進(jìn)行密碼驗(yàn)證:
2、獲取成功的授權(quán)碼
以阿里云短信服務(wù)為例
1、登陸阿里云—>進(jìn)入控制臺(tái)—>開(kāi)通短信服務(wù)
進(jìn)入后根據(jù)提示開(kāi)通短信服務(wù)即可。
2、充值
后期發(fā)短信測(cè)試需要,暫時(shí)可以跳過(guò)此步驟。
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 服務(wù)器地址 host: smtp.qq.com # 發(fā)送者郵箱 username: 742354529@qq.com # 配置密碼,注意不是真正的密碼,而是申請(qǐng)的授權(quán)碼 password: vjstfghblprwbdbd # 端口號(hào)465或587 port: 587 # 默認(rèn)的郵件編碼為UTF-8 default-encoding: UTF-8 # 配置SSL 加密工廠 properties: mail: smtp: socketFactoryClass: javax.net.ssl.SSLSocketFactory # 表示開(kāi)啟DEBUG模式,郵件發(fā)送過(guò)程的日志會(huì)在控制臺(tái)打印出來(lái) debug: true
SMTP 服務(wù)器地址
126郵箱SMTP服務(wù)器地址:smtp.126.com,端口號(hào):465或者994
2163郵箱SMTP服務(wù)器地址:smtp.163.com,端口號(hào):465或者994
yeah郵箱SMTP服務(wù)器地址:smtp.yeah.net,端口號(hào):465或者994
qq郵箱SMTP服務(wù)器地址:smtp.qq.com,端口號(hào)465或587*
2、短信配置
# 阿里云短信配置 sms: access-id: LTAI5tDP3SDQC9yvCguiiFDr access-key: EGSDQsLxCVS5dwjS8DCxmYQ124XySV sign-name: endpoint: dysmsapi.aliyuncs.com
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: 普通郵件發(fā)送 * @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: 普通郵件發(fā)送 * @Author: tanyp * @Date: 2021/6/7 9:30 * @Param: [dto] * @return: void **/ @Override public MessageVo sendSimple(MailMessageDto dto) { try { log.info("=======普通郵件發(fā)送開(kāi)始,請(qǐng)求參數(shù):{}", JSON.toJSON(dto)); // 構(gòu)建一個(gè)郵件對(duì)象 SimpleMailMessage message = new SimpleMailMessage(); // 設(shè)置郵件主題 message.setSubject(dto.getSubject()); // 設(shè)置郵件發(fā)送者,這個(gè)跟application.yml中設(shè)置的要一致 message.setFrom(sender); // 設(shè)置郵件接收者,可以有多個(gè)接收者,中間用逗號(hào)隔開(kāi),以下類(lèi)似 // message.setTo("10*****16@qq.com","12****32*qq.com"); message.setTo(dto.getRecipient()); // 設(shè)置郵件抄送人,可以有多個(gè)抄送人 if (Objects.nonNull(dto.getCc())) { message.setCc(dto.getCc()); } // 設(shè)置隱秘抄送人,可以有多個(gè) if (Objects.nonNull(dto.getBcc())) { message.setBcc(dto.getBcc()); // 設(shè)置郵件發(fā)送日期 message.setSentDate(new Date()); // 設(shè)置郵件的正文 message.setText(dto.getText()); // 發(fā)送郵件 javaMailSender.send(message); log.info("=======普通郵件發(fā)送結(jié)束"); 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("=======帶附件的郵件開(kāi)始,請(qǐng)求參數(shù):{}", JSON.toJSON(dto)); MimeMessage mimeMessage = javaMailSender.createMimeMessage(); // true表示構(gòu)建一個(gè)可以帶附件的郵件對(duì)象 MimeMessageHelper message = new MimeMessageHelper(mimeMessage, true); // 第一個(gè)參數(shù)是自定義的名稱(chēng),后綴需要加上,第二個(gè)參數(shù)是文件的位置 dto.getAttachments().forEach(file -> { try { message.addAttachment(file.getName(), file); } catch (MessagingException e) { log.error("=========郵件附件解析異常:{}", e); } }); javaMailSender.send(mimeMessage); log.info("=======帶附件的郵件結(jié)束"); } catch (MessagingException e) { log.error("==========郵件====sendAttachFile=====異常:{}", e); * @MonthName: sendImgRes * @Description: 帶圖片資源的郵件 public MessageVo sendImgRes(MailMessageDto dto) { log.info("=======帶圖片資源的郵件開(kāi)始,請(qǐng)求參數(shù):{}", JSON.toJSON(dto)); // 第一個(gè)參數(shù)指的是html中占位符的名字,第二個(gè)參數(shù)就是文件的位置 message.addInline(file.getName(), new FileSystemResource(file)); log.error("=========郵件圖片解析異常:{}", e); log.info("=======帶圖片資源的郵件結(jié)束"); log.error("====郵件====sendImgRes=====異常:{}", e); }
1.3、VO、DTO及常量類(lèi)
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 = "接收者:可以有多個(gè)接收者,中間用逗號(hào)隔開(kāi)") private String recipient; @ApiModelProperty(value = "抄送人:可以有多個(gè)抄送人,中間用逗號(hào)隔開(kāi)") private String cc; @ApiModelProperty(value = "隱秘抄送人:可以有多個(gè)抄送人,中間用逗號(hào)隔開(kāi)") 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 = "狀態(tài)碼") private String code; @ApiModelProperty(value = "狀態(tài)碼的描述") private String message; @ApiModelProperty(value = "請(qǐng)求ID") private String requestId; @ApiModelProperty(value = "發(fā)送回執(zhí)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 { /** * 消息發(fā)送狀態(tài)碼 */ public final static String NEWS_SUCCESS_CODE = "OK"; public final static String NEWS_SUCCESS_MESSAGE = "發(fā)送成功"; public final static String NEWS_FAIL_CODE = "FAIL"; public final static String NEWS_FAIL_MESSAGE = "發(fā)送失敗"; }
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: 發(fā)短信 * @Author: tanyp * @Date: 2021/6/7 14:50 * @Param: [dto] * @return: com.tanersci.vo.MessageVo **/ MessageVo send(SmsMessageDto dto); * @MonthName: addSmsTemplate * @Description: 申請(qǐng)短信模板 * @Param: [template] MessageVo addSmsTemplate(SmsTemplateDto template); * @MonthName: deleteSmsTemplate * @Description: 刪除短信模板 MessageVo deleteSmsTemplate(SmsTemplateDto template); * @MonthName: modifySmsTemplate * @Description: 修改未通過(guò)審核的短信模板 MessageVo modifySmsTemplate(SmsTemplateDto template); * @MonthName: querySmsTemplate * @Description: 查詢(xún)短信模板的審核狀態(tài) 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初始化賬號(hào)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: 發(fā)短信 * @Date: 2021/6/7 14:50 * @Param: [dto] * @return: com.tanersci.vo.MessageVo @Override public MessageVo send(SmsMessageDto dto) { try { log.info("======發(fā)送短信開(kāi)始,請(qǐng)求參數(shù):{}", JSON.toJSON(dto)); Client client = createClient(); // 組裝請(qǐng)求對(duì)象 SendSmsRequest request = new SendSmsRequest(); // 外部流水?dāng)U展字段 String outId = UUID.randomUUID().toString(); request.setOutId(outId); // 支持對(duì)多個(gè)手機(jī)號(hào)碼發(fā)送短信,手機(jī)號(hào)碼之間以英文逗號(hào)(,)分隔。上限為1000個(gè)手機(jī)號(hào)碼。批量調(diào)用相對(duì)于單條調(diào)用及時(shí)性稍有延遲。 request.setPhoneNumbers(dto.getPhone()); // 短信簽名名稱(chēng) request.setSignName(smsConfig.getSignName()); // 短信模板ID request.setTemplateCode(dto.getTemplateCode()); // 短信模板變量對(duì)應(yīng)的實(shí)際值,JSON格式。如果JSON中需要帶換行符,請(qǐng)參照標(biāo)準(zhǔn)的JSON協(xié)議處理。 request.setTemplateParam(JSON.toJSONString(dto.getParam())); // 發(fā)送短信 SendSmsResponse res = client.sendSms(request); MessageVo message = MessageVo.builder().build(); if (Objects.equals(Constants.NEWS_SUCCESS_CODE, res.body.getCode())) { log.info("======發(fā)送短信成功,返回值:{}", JSON.toJSON(res.body)); message.setCode(Constants.NEWS_SUCCESS_CODE); message.setMessage(Constants.NEWS_SUCCESS_MESSAGE); } else { log.info("======發(fā)送短信失敗,返回值:{}", JSON.toJSON(res.body)); message.setCode(Constants.NEWS_FAIL_CODE); message.setMessage(Constants.NEWS_FAIL_MESSAGE); } return message; } catch (Exception e) { log.error("======發(fā)送短信異常:{}", e.getMessage()); e.printStackTrace(); return MessageVo.builder().code(Constants.NEWS_FAIL_CODE).message(Constants.NEWS_FAIL_MESSAGE).build(); } * @MonthName: addSmsTemplate * @Description: 申請(qǐng)短信模板 * @Param: [template] public MessageVo addSmsTemplate(SmsTemplateDto template) { log.info("======申請(qǐng)短信模板,請(qǐng)求參數(shù):{}", 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("======申請(qǐng)短信模板,返回值:{}", 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("======申請(qǐng)短信模板,異常:{}", e.getMessage()); * @MonthName: deleteSmsTemplate * @Description: 刪除短信模板 public MessageVo deleteSmsTemplate(SmsTemplateDto template) { log.info("======刪除短信模板,請(qǐng)求參數(shù):{}", 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: 修改未通過(guò)審核的短信模板 public MessageVo modifySmsTemplate(SmsTemplateDto template) { log.info("======修改未通過(guò)審核的短信模板,請(qǐng)求參數(shù):{}", JSON.toJSON(template)); ModifySmsTemplateRequest request = new ModifySmsTemplateRequest(); ModifySmsTemplateResponse res = client.modifySmsTemplate(request); log.info("======修改未通過(guò)審核的短信模板,返回值:{}", JSON.toJSON(res.body)); log.error("======修改未通過(guò)審核的短信模板,異常:{}", e.getMessage()); * @MonthName: querySmsTemplate * @Description: 查詢(xún)短信模板的審核狀態(tài) public MessageVo querySmsTemplate(SmsTemplateDto template) { log.info("======查詢(xún)短信模板的審核狀態(tài),請(qǐng)求參數(shù):{}", JSON.toJSON(template)); QuerySmsTemplateRequest request = new QuerySmsTemplateRequest(); QuerySmsTemplateResponse res = client.querySmsTemplate(request); log.info("======查詢(xún)短信模板的審核狀態(tài),返回值:{}", JSON.toJSON(res.body)); log.error("======查詢(xún)短信模板的審核狀態(tài),異常:{}", 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類(lèi)
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 = "手機(jī)號(hào),多個(gè)以逗號(hào)隔開(kāi)") private String phone; @ApiModelProperty(value = "模板編碼") private String templateCode; @ApiModelProperty(value = "模板參數(shù)") 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; /** * 模板類(lèi)型:0:驗(yàn)證碼,1:短信通知,2:推廣短信,3:國(guó)際/港澳臺(tái)消息。 */ private Integer templateType; * 模板名稱(chēng),長(zhǎng)度為1~30個(gè)字符 private String templateName; * 模板內(nèi)容,長(zhǎng)度為1~500個(gè)字符 private String templateContent; * 短信模板CODE private String templateCode; * 短信模板申請(qǐng)說(shuō)明。請(qǐng)?jiān)谏暾?qǐng)說(shuō)明中描述您的業(yè)務(wù)使用場(chǎng)景,長(zhǎng)度為1~100個(gè)字符 private String remark; }
注意
項(xiàng)目中使用lombok插件和swagger依賴(lài),無(wú)相關(guān)依賴(lài)的請(qǐng)自行修改。
讀到這里,這篇“SpringBoot集成短信和郵件的配置方法”文章已經(jīng)介紹完畢,想要掌握這篇文章的知識(shí)點(diǎn)還需要大家自己動(dòng)手實(shí)踐使用過(guò)才能領(lǐng)會(huì),如果想了解更多相關(guān)內(nèi)容的文章,歡迎關(guān)注億速云行業(yè)資訊頻道。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。