FreeMarker学习笔记（二）处理邮件

最新推荐文章于 2024-02-04 17:36:44 发布
最新推荐文章于 2024-02-04 17:36:44 发布
阅读量537 收藏
点赞数
分类专栏： spring 文章标签： 学习 java spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liuwff/article/details/129029366
版权

FreeMarker处理邮件

在日常开发中，我们可以使用FreeMarker来进行邮件、word、excel等文档的处理，大多数时候这些文档会制作成标准范文，然后使用FTL语言进行模板制作，在需要进行替换内容的地方使用FTL制作成FreeMarker模板，可以非常简单并且方便的实现文档标准化处理。
以下示例讲一下邮件模板的制作和生成。

1.创建项目

我们仍然创建一个springboot项目，但是这次我们的项目是后台服务，因此不使用spring-boot-starter-freemarker，而是直接引入freemarker的java包，直接使用freemarker的api来处理模板；同时我们引入spring-boot-starter-mail的邮件starter，用来发送邮件
项目：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.11.RELEASE</version>
<!--        <version>2.7.8</version>-->
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.lwf</groupId>
    <artifactId>demo-freemarker-mail</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo-freemarker-mail</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>11</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.31</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

然后进行邮件的必要配置：

spring:
  mail:
    default-encoding: utf-8
    username: #这里配置邮箱
    password: #这里配置邮箱的第三方授权码
    host: smtp.163.com
    port: 25

2.配置FreeMarker以及使用

FreeMarker的核心api是freemarker.template.Configuration,该类中包含了很多静态字段，用来保存我们对FreeMarker的配置以及缓存信息，因此我们应该在应用中尽量保证单例模式使用，我们可以从类的apidoc中获取到对应的说明信息。
单独使用FreeMarker的流程一般是：

  1. 创建freemarker.template.Configuration，并进行初始化配置，主要是TemplateLoader的相关信息。
  2. 使用Configuration.getTemplate()方法获取FreeMarker模板实例freemarker.template.Template
  3. freemarker.template.Template#process(java.lang.Object, java.io.Writer)方法接收进行FTL模板中信息输入的data，以及一个Writer来进行文档输出。

下面我们按照流程进行操作：

  1. 我们在springboot中简单配置freemarker.template.Configuration，把configuration注入为Bean
@SpringBootApplication
public class DemoFreemarkerMailApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoFreemarkerMailApplication.class, args);
    }
    @Bean
    public  Configuration fmConfiguration(){
        Configuration configuration = new Configuration(Configuration.VERSION_2_3_31);
        configuration.setClassLoaderForTemplateLoading(this.getClass().getClassLoader(),"templates");
        return configuration;
    }
}
  1. 我们在templates文件夹下创建一个html的邮件模板：
<html>
<head>
    <title>${title}</title>
</head>
<body>
dear hello:
<p>${content}</p>
</body>
</html>
  1. 编写Service 服务：
/**
 * @author liuwenfei
 * @date 2023/2/14 17:02
 */
@Service
@Slf4j
public class MailServiceImpl implements MailService {
    @Autowired
    Configuration fmConfiguration;
    @Autowired
    JavaMailSender javaMailSender;
    @Override
    public String dealMailTemplate(String mailTemplatePath, Map<String,Object> data){
        try {
            Template template = fmConfiguration.getTemplate(mailTemplatePath);
            StringWriter stringWriter = new StringWriter();
            template.process(data,stringWriter);
            return stringWriter.toString();
        } catch (IOException | TemplateException e) {
           log.error("getTemplate error",e);
           throw new RuntimeException(e.getMessage());
        }
    }

    @Override
    public boolean sendMail(String mailTemplatePath, Map<String, Object> data) {
        String content = dealMailTemplate(mailTemplatePath, data);
        MimeMessage mimeMessage = javaMailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage);
        try {
            helper.setFrom("liuwulive@163.com");
            helper.setCc("liuwulive@163.com");
            helper.setTo("liuwulive@163.com");
            helper.setSubject("测试");
            helper.setText(content,true);
           javaMailSender.send( helper.getMimeMessage());
           return true;
        } catch (MessagingException e) {
            log.error("senmail error",e);
            return false;
        }
    }
}
  1. 创建controller：
/**
 * @author liuwenfei
 * @date 2023/2/14 17:01
 */
@RestController
public class MailController {
    @Autowired
    MailService mailService;
    @RequestMapping("/mail/{template}")
    public String getMailContent(@PathVariable("template")String template, @RequestBody Map<String,Object> data){
        return mailService.dealMailTemplate(template,data);
    }

    @RequestMapping("/sendmail/{template}")
    public String sendMailContent(@PathVariable("template")String template, @RequestBody Map<String,Object> data){

        mailService.sendMail(template,data);
        return "ok";
    }
}

3.运行并测试

我们运行应用，并调用接口进行测试：

  1. 测试模板解析，我们可以使用curl 调用：
curl --location --request POST 'http://localhost:8080/mail/mail_hello.html' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title":"hello",
    "content":"这是一个测试邮件"
}'

获取返回的模板文字结果：

<html>
<head>
    <title>hello</title>
</head>
<body>
dear hello:
<p>这是一个测试邮件</p>
</body>
</html>
  1. 测试邮件发送：
curl --location --request POST 'http://localhost:8080/sendmail/mail_hello.html' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title":"hello",
    "content":"这是一个测试邮件"
}'

获取“ok”的结果表示发送成功，检查邮箱，收到对应的邮件信息
在这里插入图片描述

注意如果发送后一直没有收到回复，一般是因为邮件服务配置的问题，注意修改调试即可。

示例源码下载地址

liuwff
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
FreeMarker模板实现邮件发送
03-08
1.这是一个在根目录下的mail.properties文件中配好发送邮件地址和接收邮箱地址的实例，利用freeMarker模板作为展示，在测试类中提供配固定接收邮箱地址和手动输入接收邮箱地址两种方法进行发送试验，结果都能实现成功发送。 2.测试本例时要将根目录下mail.properties文件中邮箱地址和密码修改正确，最好选择自己的邮箱地址进行测试。
SpringBoot使用FreeMarker模板发送邮件
05-23
通过springboot 整合freemarker模板引擎，自动发送html格式邮件
mybatis plus生成器 - 自定义freemarker输出模板生成简单接口
无术不学的博客
08-06 848
https://www.cnblogs.com/hsuhung/p/12426985.html
freemarker
weixin_42902020的博客
08-18 84
参考：https://www.cnblogs.com/huligong1234/p/3515747.html https://www.cnblogs.com/IT-1994/p/6216428.html
springboot使用模板发送邮件
博客
04-23 1363
转载文章并说明自己遇到的问题，感谢两文作者： 参考：https://www.cnblogs.com/chancy/p/10456210.html 并结合：https://www.jianshu.com/p/207f193496a6(引入freemarker依赖，读取模板) 项目中遇到的问题： 我的springboot 引入的是jsp页面 ,如果使用template的Temp...
java 模板引擎_Spring Boot实战：模板引擎
weixin_39815943的博客
12-01 142
点击上方“Java知音”，选择“置顶公众号”技术文章第一时间送达！作者：liuxiaopeng链接：http://www.cnblogs.com/paddixSpringboot实战：集成Swagger2SpringBoot实战：拦截器与过滤器SpringBoot实战：Restful API的构建SpringBoot实战：静态资源处理虽然现在很多开发，都采用了前后端完全分离的模式，即后端...
Spring Boot基于FreeMarker发送模板邮件（带附件）
嘉禾嘉宁papa
12-13 7293
spring boot使用freemarker发送模板邮件详细说明（带附件）
Springboot整合FreeMarker+email+Quartz定时发送一封模板邮件
weixin_69895162的博客
08-25 2824
Springboot整合FreeMarker+email+Quartz定时发送一封模板邮件
Java Email 发HTML邮件工具 采用 freemarker模板引擎渲染
钟健的博客
02-13 1万+
Java发送邮件有很多的实现方式第一种：Java 原生发邮件和 原生的java可以发送普通文本和HTML邮件，同时也可以发送带附件的邮件，但是缺点也很明显，配置非常繁琐，不同的邮件需要不同的实现类去完成，不适合项目中使用。第二种：使用框架提供的去实现，在SpringBoot中有实现这个功能的组件 这种实现起来特别方便，仅仅只要在SpringBoot项目中引入组件，在配置文件中配置好各种参数，就可以实现依赖注入，调用接口完成发送邮件，同时支持普通文本、HTML邮件、以及携带附件的邮件。同时缺点就是和框架集成太
Freemarker模版详细介绍
J_fovik_R0407的博客
04-06 1465
使用 assign 指令你可以创建一个新的变量， 或者替换一个已经存在的变量。< # -- assign 自定义变量指令语法： < #assign 变量名 = 值 > < #assign 变量名 = 值 变量名 = 值 > （定义多个变量） -- > < #assign str = "hello" > $ {names?可以使用 macro 指令来自定义一些自定义指令。< -- 4. macro 自定义指令 （宏） 1. 基本使用。
Java通过FreeMarker配置邮件html模板
最新发布
weixin_42467874的博客
02-04 622
Java通过Jakarta Mail实现邮件发送时，邮件内容需要使用html展现，但是HTML 一般情况下无法直接与后端进行交互（从各种作用域中取值），使用字符串和文本块都不能很好的满足，于是使用了模板引擎FreeMarker模板。② html模板test_email.flt（test_email.flt文件存放位置为resource/templates路径下）① 工具类FreeMarkerUtil。
FreeMarker学习笔记
04-04
FreeMarker是一个模板引擎，一个基于模板生成文本输出的通用工具，使用纯Java编写。
Freemarker学习笔记
12-12
Freemarker学习笔记可以帮助初学者了解，快速掌握Freemarker
Freemarker 学习笔记一 【乱码解决】
04-21
NULL 博文链接：https://zx527291227.iteye.com/blog/1924333
springboot+freemarker+email实现异常邮件通知
热门推荐
王林冲的博客
07-08 2万+
在我们的项目中，总是有一些我们不可控制的异常，比如数据库连接不上，redis挂掉，以及一些代码上未可知的异常爆发，不能在项目上线时就可以统计出来，并且修复，所以当我们这些bug抛出异常时，或者在某些可控的严重异常需要推送邮件或者短信或者其他的通讯工具比如 钉钉或者飞书等，我们就需要这样的功能，这里提供一个邮件通知方法，当有未知异常或者被定义为严重异常的，就会给运维人员发送一个邮件进行通知，方便计时应对和问题定位。在springboot中的全局异常捕获处，对不可控异常拿到异常栈信息，进行异常msg的组装和通知
freemarker(0) : springboot-freemarker 初始化
Lxinccode的博客
05-02 610
参考 : https://blog.csdn.net/u011197448/article/details/83901306 https://www.cnblogs.com/paddix/p/8905531.html springboot版本 :2.0.2.RELEASE 1.添加maven依赖 springboot <parent> ...
java读取ftl文件_java发送邮件javamail, freemarker读取html模板内容
weixin_30824391的博客
02-17 604
https://www.cnblogs.com/xdp-gacl/p/4216311.html一、RFC882文档简单说明RFC882文档规定了如何编写一封简单的邮件(纯文本邮件)，一封简单的邮件包含邮件头和邮件体两个部分，邮件头和邮件体之间使用空行分隔。邮件头包含的内容有：from字段　　--用于指明发件人to字段　　--用于指明收件人subject字段--用于说明邮件主题cc字...
使用邮件模板(freemarker.jar)发送邮件
HuHao_CSDN的博客
12-04 452
1.把freemarker.jar架包添加到项目中 2.创建模板文件,以*.ftl(后缀名是ftl)命名,模板示例如下 1 &lt;html&gt; 2 &lt;head&gt; 3 &lt;meta http-equiv="content-type" content="text/html;charset=utf-8"&gt; 4 &lt;/head&gt; 5 &lt;bo
freeMarker 空值处理
07-27
在FreeMarker中，有几种处理空值的方法。首先，可以使用判断标签来判断变量是否存在，并根据情况输出或不输出相应的内容。例如，可以使用`${user.name?if_exists}`来判断`user.name`是否存在，如果存在则输出，反之...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值