标签：ve 发送 文档 new Velocity 电子邮件 order 页面
文章目录
使用Velocity发送电子邮件
简介
Velocity能用来干什么？
我认为大家熟知的什么用Velocity页面当做MVC的页面来呈现这种方式，但在当今前后端分离的时代，我觉得很大一部分公司前端页面都是使用的React,Vue等纯前端框架。使用各大模板引擎当做页面应该很少
除了这个，官方文档提到了一个很重要的一个应用场景，就是发送电子邮件。当应用需要给用户发送电子邮件时，并且有统一的邮件模板，只需要针对不同用户展现不同的内容。这个时候，页面需要同Java代码分离，并且页面的模板是不需要经常改变的，这就用到了Velocity
入门
Velocity工作原理简单概括为，在页面中使用Velocity的语法设置变量，取值。而Java代码负责设值、同时渲染模板
页面
页面主要分为以下两大类
引用
看引用相关文档即可知道，这里只做简单记录
-
命名规则
引用由$+变量名/方法名组成。必须以字母开头，后面的部分可以是字母、数字、下划线_
-
访问属性和方法
通过命名+ 点的方式
## 访问order的customerName $order.customerName关于是访问属性还是访问方法，参考查找规则
-
引用的正式写法
当变量后面跟着其他单词时，Velocity可能会把后面的单词也当做变量去查找，为了防止这种情况发生，需要使用正式写法
Jack is a ${vice}maniac这里只会去查找vice
指令
指令以#开头，常用的主要有以下几个
-
set,设值
#set($temList = $order.items)将items设值给定义的变量temList
-
If / ElseIf / Else,判断
#if( $foo < 10 ) Go North #elseif( $foo == 10 ) Go East #elseif( $bar == 6 ) Go South #else Go West #endfoo可以是对象、集合、数组等，判断条件为
-
foreah,循环
#set($temList = $order.items) #foreach($item in $temList) $item #end -
include和parse，重用其他页面
<html> ## 这里要写resources下的全路径 #parse("templates/emails/header.vm") <body> </body> </html>
关于其他使用，如转义、数学计算等，移步相关文档
Java代码
页面写完之后，我们需要给页面中的变量设值，开发文档
新建一个springboot应用
可以使用Velocity和VelocityEngine,看个人喜好，主要使用Context进行变量的设置
示例页面
<html>
#parse("templates/emails/header.vm")
<body>
Hi, $order.customerName<br>
## 使用正式语法
您在${order.paymentTime}时完成的订单详情如下
<table border="1">
<tr>
<th>宝贝</th>
</tr>
#set($temList = $order.items)
#foreach($item in $temList)
<tr>
<td>$item</td>
</tr>
#end
</table>
<br>
合计金额为：$order.paymentAmount<br>
配送方式为：$order.deliveryMethod
</body>
</html>
给上述页面设值
@Service
@Log
public class SendEmailService {
private static final VelocityEngine ve = new VelocityEngine();
@PostConstruct
public void initVelocity() {
ve.setProperty(RuntimeConstants.RESOURCE_LOADERS, "classpath");
ve.setProperty("resource.loader.classpath.class", ClasspathResourceLoader.class.getName());
ve.init();
}
public boolean sendOrderDetailEmail() {
Order order = new Order();
order.setCustomerName("jack");
List<String> items = Arrays.asList("猪肉", "牛肉", "鱼肉");
order.setItems(items);
order.setPaymentAmount(BigDecimal.valueOf(78.365));
order.setPaymentTime(LocalDateTime.now());
order.setDeliveryMethod("顺丰");
// 设值
VelocityContext context = new VelocityContext();
context.put("order", order);
context.put("header", "OrderDetail");
// 获取模板
Template template = ve.getTemplate(SendEmailUtil.obtainTemplateRealPath("orderDetail"));
StringWriter writer = new StringWriter();
// 将模板和变量值进行渲染
template.merge(context, writer);
return true;
}
}
注意 ：这里主要注意Velocity时读取模板位置的设置，ResourceLoader文档
集成发送电子邮件
这里使用163邮箱发送电子邮件
关于收发邮件所用的协议，基本是两个
- SMTP协议用来发邮件
- IMAP协议用来收邮件
使用springboot封装好的mail工具-JavaMailSender,相关文档1和相关文档2
前提
在163邮箱上将POP3/SMTP/IMAP开启，并拿到授权码
编码
配置文件
server:
port: 18080
servlet:
context-path: /v
spring:
mail:
host: smtp.163.com
username: 自己的邮箱
# 163邮箱授权码
password: 填写你自己的
properties:
mail:
smtp:
auth: true
starttls:
enable: true
required: true
发送邮件
@Service
@Log
public class SendEmailService {
private static final VelocityEngine ve = new VelocityEngine();
@Autowired
private JavaMailSender javaMailSender;
@PostConstruct
public void initVelocity() {
ve.setProperty(RuntimeConstants.RESOURCE_LOADERS, "classpath");
ve.setProperty("resource.loader.classpath.class", ClasspathResourceLoader.class.getName());
ve.init();
}
public boolean sendOrderDetailEmail() {
VelocityContext context = new VelocityContext();
Order order = new Order();
order.setCustomerName("jack");
List<String> items = Arrays.asList("猪肉", "牛肉", "鱼肉");
order.setItems(items);
order.setPaymentAmount(BigDecimal.valueOf(78.365));
order.setPaymentTime(LocalDateTime.now());
order.setDeliveryMethod("顺丰");
context.put("order", order);
context.put("header", "OrderDetail");
Template template = ve.getTemplate(SendEmailUtil.obtainTemplateRealPath("orderDetail"));
StringWriter writer = new StringWriter();
template.merge(context, writer);
javaMailSender.send(buildMessage("OrderDetail Email", writer.toString()));
return true;
}
@SneakyThrows
private MimeMessage buildMessage(String subject, String emailContent) {
MimeMessage message = javaMailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(message);
helper.setFrom("jacksparrow414@163.com");
helper.setTo("jacksparrow414@163.com");
helper.setSubject(subject);
message.setText(emailContent, Charset.defaultCharset().name(), "html");
return message;
}
}
发送结果
官方文档
官方文档的阅读主要分为两大部分
- 如果需要写页面，则参考User’s Guide
- 如果需要写Java代码，则参考Developer’s Guide
示例代码
完整的示例代码仓库
标签：ve,发送,文档,new,Velocity,电子邮件,order,页面 来源： https://blog.csdn.net/dghkgjlh/article/details/123253121
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。