SpringBoot 2.2.5 整合spring-boot-s

前言：该博客主要是记录自己学习的过程，方便以后查看，当然也希望能够帮到大家。

说明

以目前IT系统功能来看，邮件功能是非常重要的一个功能。例如：找回密码、邮箱验证，邮件动态码、忘记密码，邮件营销等，都需要用到邮件功能。spring-boot-starter-mail支持多种邮件，包括gmail，qq，163，126等等，本文用到的是网易126邮箱。

完整代码地址在结尾！！

第一步，注册126邮箱，

1. 并且在设置里面授权开通smtp服务，此时会获取到一个邮箱的授权吗，后面要用到，此处不多赘述，不懂请自行百度查询

第二步，在pom.xml加入依赖，如下

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

第三步，配置application.yml，避免端口冲突

server:
  port: 8081

spring:
  application:
    name: mail-demo-server
  mail:
    host: smtp.126.com # 不同的邮箱不一致，请自行百度查询
    port: 25 # 126邮箱默认25
    username: xxx # 发送邮箱
    password: xxx # 授权码
    protocol: smtp
    default-encoding: utf-8
#    properties: # 此处可以添加ssl端口
#      mail.smtp.auth: true
#      mail.smtp.starttls.enable: true
#      mail.smtp.starttls.required: true
#      mail.smtp.socketFactory.port: 465
#      mail.smtp.socketFactory.class: javax.net.ssl.SSLSocketFactory
#      mail.smtp.socketFactory.fallback: false

第四步，创建类服务类，MailService，MailServiceImpl，如下

MailService

public interface MailService {

    /**
     * 发送简单邮件的接口
     *
     * @param mail     接收邮箱
     * @param subject     主题
     * @param text     内容
     * @return
     */
    boolean sendSimpleMail(String mail, String subject, String text);

    /**
     * 发送带附件邮件的接口
     *
     * @param mail     接收邮箱
     * @param subject     主题
     * @param text     内容
     * @param path     附近路径
     * @return
     */
    boolean sendMimeMail(String mail, String subject, String text, String path) throws Exception ;

    /**
     * 发送带附件邮件的接口，并且正文显示附件内容
     *
     * @param mail     接收邮箱
     * @param subject     主题
     * @return
     */
    boolean sendMimeMail(String mail, String subject) throws Exception ;

}

MailServiceImpl

import com.luoyu.mail.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.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Service;

import javax.mail.internet.MimeMessage;
import java.io.File;

@Slf4j
@Service
public class MailServiceImpl implements MailService {

    @Value("${spring.mail.username}")
    private String username;

    @Autowired
    private JavaMailSender mailSender;

    /**
     * 发送简单邮件的接口
     *
     * @param mail     接收邮箱
     * @param subject     主题
     * @param text     内容
     * @return
     */
    @Override
    public boolean sendSimpleMail(String mail, String subject, String text) {
        //创建邮件内容
        SimpleMailMessage message=new SimpleMailMessage();
        //这里指的是发送者的账号
        message.setFrom(username);
        message.setTo(mail);
        message.setSubject(subject);
        message.setText(text);
        //发送邮件
        mailSender.send(message);
        return true;
    }

    @Override
    public boolean sendMimeMail(String mail, String subject, String text, String path) throws Exception {
        MimeMessage mimeMessage = mailSender.createMimeMessage();
        // 设置utf-8或GBK编码，否则邮件会有乱码
        MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage, true, "UTF-8");
        messageHelper.setFrom(username);
        messageHelper.setTo(mail);
        messageHelper.setSubject(subject);
        messageHelper.setText(text, true);
        FileSystemResource file = new FileSystemResource(new File(path));
        String fileName = path.substring(path.lastIndexOf(File.separator));
        messageHelper.addAttachment(fileName,file);
        mailSender.send(mimeMessage);
        return true;
    }

    @Override
    public boolean sendMimeMail(String mail, String subject) throws Exception {
        MimeMessage mimeMessage = mailSender.createMimeMessage();

        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
        helper.setFrom(username);
        helper.setTo(mail);
        helper.setSubject(subject);
        // 注意<img/>标签，src='cid:jpg'，'cid'是contentId的缩写，'jpg'是一个标记
        helper.setText("<html><body><img src=\"cid:jpg\"></body></html>", true);
        // 加载文件资源，作为附件
        FileSystemResource file = new FileSystemResource(new File("/Users/luoyu/Downloads/赤瞳.jpg"));
        // 调用MimeMessageHelper的addInline方法替代成文件('jpg[标记]', file[文件])
        helper.addInline("jpg", file);
        // 发送邮件
        mailSender.send(mimeMessage);
        return true;
    }

}

第五步，创建类单元测试类，MailApplicationTests，并进行测试，如下

import com.luoyu.mail.service.MailService;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@Slf4j
// 获取启动类，加载配置，确定装载 Spring 程序的装载方法，它回去寻找 主配置启动类（被 @SpringBootApplication 注解的）
@SpringBootTest
class MailApplicationTests {

    @Autowired
    private MailService mailService;

    @Test
    void sendSimpleMailTest() {
        mailService.sendSimpleMail("xxx", "jhx测试邮件主题", "jhx测试邮件内容");
    }

    @Test
    void sendMimeMailTest1() throws Exception {
        mailService.sendMimeMail("xxx", "jhx测试邮件主题", "jhx测试邮件内容", "/Users/luoyu/Downloads/赤瞳.jpg");
    }

    @Test
    void sendMimeMailTest2() throws Exception {
        mailService.sendMimeMail("xxx", "jhx测试邮件主题");
    }

    @BeforeEach
    void testBefore(){
        log.info("测试开始!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
    }

    @AfterEach
    void testAfter(){
        log.info("测试结束!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
    }

}

注意

1. 配置文件里面的密码是我们邮箱的授权码，不是登陆的密码
2. 有上传到服务器中报错无法使用的，比如阿里云，腾讯云，默认是关闭的，可以去控制台申请解封25端口

完整代码地址：https://github.com/Jinhx128/springboot-demo

注：此工程包含多个module，本文所用代码均在mail-demo模块下

后记：本次分享到此结束，本人水平有限，难免有错误或遗漏之处，望大家指正和谅解，欢迎评论留言。