SpringBoot-22-邮件任务

最新推荐文章于 2024-05-10 20:33:51 发布

paiidds

最新推荐文章于 2024-05-10 20:33:51 发布

阅读量968

点赞数

文章标签： spring boot spring

本文链接：https://blog.csdn.net/paiidds/article/details/124159198

版权

邮件任务

介绍

邮件是在社交、学习或者工作中使用非常广泛的工具，在日常开发中我们需要去学习它，对于邮件分为简单邮件和复杂邮件，在实际开发中，SpringBoot会去整合邮件任务，对于简单的邮件使用MailSender来实现，复杂的邮件通过MailSender的实现类JavaMailSender来实现。

邮件的类型

发送邮件实现方式有多种，可以根据需求进行发送相应的邮件，主要分为以下几种:

发送简单的邮件
发送复杂的邮件
发送带有HTML的复杂邮件

实现

准备工作

1. 引入pom依赖

需要引入spring-boot-starter的jar包和jakarta.mail的jar包

<!--        Spring整合test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
            <version>2.6.6</version>
        </dependency>

<!--        邮件时所需要的协议标准-->
<!--         https://mvnrepository.com/artifact/com.sun.mail/jakarta.mail-->
        <dependency>
            <groupId>com.sun.mail</groupId>
            <artifactId>jakarta.mail</artifactId>
            <version>1.6.5</version>
        </dependency>

2.MailSenderAutoConfiguration原理解析

在这里插入图片描述
只有导入了上面提到的两个依赖，这个MailSenderAutoConfiguration才会生效，在这里我们没有看到交给Spring容器的对象，可以看到MailSenderJndiConfiguration.class和MailSenderPropertiesConfiguration.class两个类

MailSenderJndiConfiguration
在这里插入图片描述
可以发现它有两个@Bean对象，我们点开研究研究

JavaMailSenderImpl

@Bean	//添加到Spring容器管理，这个JavaMailSenderImpl对象主要实现发送邮件
    JavaMailSenderImpl mailSender(Session session) {
        JavaMailSenderImpl sender = new JavaMailSenderImpl();
        sender.setDefaultEncoding(this.properties.getDefaultEncoding().name());
        sender.setSession(session);
        return sender;
    }

Session

 @Bean		//将会话对象交给容器管理，若有自定义的则生效
    @ConditionalOnMissingBean
    Session session() {
    	//JNDI是Java命名与接口
        String jndiName = this.properties.getJndiName();
		
        try {
        //JndiLocatorDelegate是JNDL定位委托器去创建一个默认Session对象
            return (Session)JndiLocatorDelegate.createDefaultResourceRefLocator().lookup(jndiName, Session.class);
        } catch (NamingException var3) {
            throw new IllegalStateException(String.format("Unable to find Session in JNDI location %s", jndiName), var3);
        }
    }

关于JNDL的介绍:

JNDI（Java Naming and Directory Interface ），类似于在一个中心注册一个东西，以后要用的时候，只需要根据名字去注册中心查找，注册中心返回你要的东西。web程序，我们可以将一些东西（比如数据库相关的）交给服务器软件去配置和管理（有全局配置和单个web程序的配置），在程序代码中只要通过名称查找就能得到我们注册的东西，而且如果注册的东西有变，比如更换了数据库，我们只需要修改注册信息，名称不改，因此代码也不需要修改。

MailSenderPropertiesConfiguration

在这里插入图片描述
可以看到有一个JavaMailSenderImpl的@Bean对象

 @Bean	//交给Spring容器管理
    @ConditionalOnMissingBean({JavaMailSender.class})
    //只有容器中没有JavaMailSender对象时生效
    JavaMailSenderImpl mailSender(MailProperties properties) {
    	//通过MailProperties的对象创建JavaMailSenderImpl对象
        JavaMailSenderImpl sender = new JavaMailSenderImpl();
        this.applyProperties(properties, sender);
        return sender;
    }

查看一下MailProperites(邮件配置对象)
在这里插入图片描述
MailProperties对象的所有属性和全局配置文件下以spring.mail开头的所有键值对一一绑定

结论: 发送邮件需要使用JavaMailSenderImpl对象来实现，创建JavaMailSenderImpl对象有两种方式，一种是使用MailProperties，一种是使用Session来创建，我们可以根据自己的需求去创建JavaMailSenderImpl

3.配置全局配置文件

# mail配置
spring.mail.username=1457902738@qq.com
# 授权码
spring.mail.password=
spring.mail.host=smtp.qq.com
spring.mail.default-encoding=UTF-8
# 需要开启SSL协议
spring.mail.properties.mail.smtp.ssl.enable=true

授权码获取

在这里插入图片描述

发送简单的邮件

@Slf4j
@SpringBootTest
class Springboot14MailApplicationTests {
//自动装配组合邮件发送实现类
    //MailSender的子类实现类
    @Autowired
    private JavaMailSenderImpl mailSender;

	   @Test
    void contextLoads() {
        //简单邮件发送
        SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
        //设置标题
        simpleMailMessage.setSubject("要慢慢变强");
        //设置发送内容
        simpleMailMessage.setText("你行的");
        //设置发件人
        simpleMailMessage.setTo("1457902738@qq.com");
        //设置收件人
        simpleMailMessage.setFrom("1457902738@qq.com");
        //发送信息
        mailSender.send(simpleMailMessage);
        log.warn("发送邮件成功");
    }
}

Text、To、From、Subject需要设置，不然会报错

发送复杂的邮件

1. 发送图片

@Slf4j
@SpringBootTest
class Springboot14MailApplicationTests {
//自动装配组合邮件发送实现类
    //MailSender的子类实现类
    @Autowired
    private JavaMailSenderImpl mailSender;
	
	    @Test
    void image() throws MessagingException {
        //复杂邮件发送
        MimeMessage message = mailSender.createMimeMessage();
        //创建复杂文件
        MimeMessageHelper helper = new MimeMessageHelper(message,true,"utf-8");
        //给复杂邮件添加一个helper组件
        helper.setSubject("你是不是你喜欢的");
        helper.setText("<body><h1>小猫咪呀</h1><br>" +
                "<img src='cid:cat'></body>",true);
        //发送图片
        FileSystemResource file = new FileSystemResource(new File("D:\\贪吃蛇图片素材\\3.jpg"));
        //内嵌html资源，在文本内容中使用cid进行标识
        helper.addInline("cat",file);
        helper.setTo("1457902738@qq.com");
        helper.setFrom("1457902738@qq.com");
        mailSender.send(message);
        log.warn("发送邮件成功");
    }
	
}

2. 发送附件

@Slf4j
@SpringBootTest
class Springboot14MailApplicationTests {
//自动装配组合邮件发送实现类
    //MailSender的子类实现类
    @Autowired
    private JavaMailSenderImpl mailSender;

	    //发送附件
    @Test
    void attachment() throws MessagingException {
        MimeMessage message = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message,true);
        helper.setSubject("软工1904");
        helper.setText("hello");
        helper.setTo("1457902738@qq.com");
        helper.setFrom("1457902738@qq.com");
        //文本内容和图片都需要转化为FileSystemResource资源类，内嵌html使用addInline方法，非内嵌使用addAttachment
//        FileSystemResource file = new FileSystemResource("D:\\贪吃蛇图片素材\\3.jpg");
//        helper.addAttachment("3.jpg",file);
        FileSystemResource file = new FileSystemResource("C:\\Users\\梁宣泽\\Documents\\求和\\例4.17.txt");
        helper.addAttachment("求和.txt",file);
        mailSender.send(message);
    }
}

发送带有HTML的邮件

为什么要使用基于HTML模板?
之前所有的邮件内容都是显示定义的，只能展示基础的API。

使用模板创建邮件内容:

使用Java代码创建基于HTML的邮件内容容易犯错，且过程繁琐无味
业务逻辑和显示逻辑很难分清楚
一旦需要修改邮件,需要修改Java，消耗时间

解决以上问题的方案是使用FreeMarker或Velocity这样的模板语言去定义文本内容的显示结构

在Spring中我们需要去使用FreeMarker或Velocity的支持类来创建我们的邮件,Spring最新版已经不支持Velocity了

1.基于FreeMarker

在templates目录下创建一个hello.html
使用HTML文件:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>

姓名:<span>${name}</span>
年龄:<span>${age}</span>
</body>
</html>

编写邮件发送代码

    @Autowired
    private JavaMailSenderImpl mailSender;

    @Autowired   //使用FreeMarkerConfigurer加入到容器汇总需要先配置WebMvcAutoConfiguration模块
    private FreeMarkerConfigurer freeMarkerConfigurer;
    @Test
    public void freeMarker() throws MessagingException, IOException, TemplateException {
        MimeMessage message = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message,true);
        helper.setSubject("hello");
        helper.setTo("1457902738@qq.com");
        helper.setFrom("1457902738@qq.com");
        Map<String,Object> map = new HashMap<>();
        map.put("name","liang");
        map.put("age","21");
        Template template = freeMarkerConfigurer.getConfiguration().getTemplate("hello.html");
        String context = FreeMarkerTemplateUtils.processTemplateIntoString(template, map);
        helper.setText(context,true);
        mailSender.send(message);
    }

测试结果
在这里插入图片描述
得到了我们传参的数据

使用VM文件：

在resources文件下创建list.vm文件

<html>

<body>

    <p>hello,welcome to you !${name}</p>

    <div>
        <p>你是否成年</p>
        #if(${age}>18)
            成年人
        #else
            未成年人
        #end
    </div>
    <div>
        <p>你将要学习以下知识</p>
        #foreach($element in $list)
            $velocityCount $element
        #end
    </div>
</body>
</html>

发送邮件的代码

      @Autowired
    private JavaMailSenderImpl mailSender;

    @Autowired   //使用FreeMarkerConfigurer加入到容器汇总需要先配置WebMvcAutoConfiguration模块
    private FreeMarkerConfigurer freeMarkerConfigurer;
  @Test
    public void freeMarker() throws MessagingException, IOException, TemplateException {
        MimeMessage message = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message,true);
        helper.setSubject("你好啊");
        helper.setTo("1457902738@qq.com");
        helper.setFrom("1457902738@qq.com");
        Map<String,Object> map = new HashMap<>();
        map.put("name","liang");
        map.put("age","21");
        List<String> list = new ArrayList<>();
        list.add("c语言");
        list.add("c++");
        list.add("Java");
        //从freeMarker的配置信息中获得Templates信息,需要WebMvc模块才能使用Java
        map.put("list",list);
        Template template = freeMarkerConfigurer.getConfiguration().getTemplate("list.vm");
        String context = FreeMarkerTemplateUtils.processTemplateIntoString(template, map);
        helper.setText(context,true);
        mailSender.send(message);
    }

测试结果
在这里插入图片描述
可以发现我们的vm写的html并没有生效，因为在这里无法使用Velocity模板

2.基于Thymeleaf

创建一个main.html文件
使用template模板

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>

<p>
    姓名:<h4 th:text="${name}"></h4>
</p>

<p>
    年龄:<h4 th:text="${age}"></h4>
</p>


</body>
</html>

编写邮件发送的代码

  //基于thymeleaf
    @Test
    public void thymeleaf() throws MessagingException {
        MimeMessage message = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(message,true);
        helper.setSubject("Thymeleaf");
        helper.setTo("1457902738@qq.com");
        helper.setFrom("1457902738@qq.com");
        Context context  = new Context();
        context.setVariable("name","张三");
        context.setVariable("age",21);
        String text = templateEngine.process("main", context);
        helper.setText(text,true);
        mailSender.send(message);
        log.info("邮件发送成功");

    }

测试结果

在这里插入图片描述
完成了邮件的发送，这里我们使用Template引擎和FreeMarker模板引擎，来简化了开发，业务逻辑和显示数据实现了分开。

paiidds

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot-22-邮件任务

邮件任务介绍邮件是在社交、学习或者工作中使用非常广泛的工具，在日常开发中我们需要去学习它，对于邮件分为简单邮件和复杂邮件，在实际开发中，SpringBoot会去整合邮件任务，对于简单的邮件使用MailSender来实现，复杂的邮件通过MailSender的实现类JavaMailSender来实现。邮件的类型发送邮件实现方式有多种，可以根据需求进行发送相应的邮件，主要分为以下几种:发送简单的邮件发送复杂的邮件发送带有HTML的复杂邮件实现准备工作1. 引入pom依赖
复制链接

扫一扫