消息模板

前言

接口管理、接口日志、消息模板、消息管理、我的消息的表结构关系如下：

E-R图

消息发送接口调用逻辑：

UML图

菜单介绍

接口管理

用于定义消息通过什么接口发送，消息包括但不限于：站内信、邮件、短信。接口管理的每条数据，对应UML图中的一个实现类。

「灯灯」已封装的接口：

1. 邮件接口
   • 邮件（任意厂商的邮件）
2. 短信接口
   • 腾讯云短信
   • 阿里云短信
   • 百度云短信
   • 创蓝短信
3. 站内信接口
   • 站内消息

若上述接口不能满足贵司的开发需求，可以先在接口管理页面新增一条接口数据，并在代码中编写接口代码。

接口日志

记录接口的发送情况。如：成功执行次数、失败执行次数、消息发送明细。

消息模板

全局消息模板，调用消息发送接口发送消息时，需要提前在此配置消息模板，方可发送消息。

消息模板依赖于接口管理，意思是在定义消息模板时，就必须确定该模板需要通过什么接口进行发送，若一个业务需要同时发送短信、邮件、站内信通知，则需要配置3个模板，并绑定3个接口

个性消息模板

租户自己的消息模板，当全局消息模板的内容不满足住户的需求时，可以在此修改个性消息模板。租户修改个性消息模板后，并不会影响其他租户的消息模板。

字段介绍

1. 模板标识

   模板的唯一标识。在调用消息发送接口时，需要传递次参数。

2. 消息类型

   短信、邮件、站内信。

3. 模板名称

4. 关联接口

   指定该模板需要通过那个接口进行发送。

5. 标题

   模板标题。消息类型为邮件、站内信时发送的消息标题，消息类型为短信时，无需此字段。

   可以使用${}占位符，执行发送前自动解析占位符内容。

6. 模板内容

   消息的正文，可以使用${}占位符，执行发送前自动解析占位符内容，消息类型为邮件、站内信时可支持富文本。

7. 脚本

   标题和模板内容的占位符中包含较多的参数，但在调用消息发送接口时，已经传递了较少的参数，则可以通过脚本中配置的动态代码，动态返回参数。

   例如

   用户密码每3个月必须修改一次，即将到期时需要通知用户修改密码的短信模板为：

   尊敬的${name}，您的密码将于${expirationTime}过期，为了避免影响您正常使用，请及时登录${systemName}(${url})修改密码。
   

   但由于各种原因在调用发送消息接口时，只传递了一个参数：用户ID。模板中的name、expirationTime、systemName、url等参数就可以使用脚本通过编码实现。脚本内容大致为：

   UserMapper userMapper = SpringUtils.getBean(UserMapper.class);
   // id 是外部传递进来的
   User user = userMapper.getById(id);
   
   [
     name: user.getName(),
     expirationTime: user.getExpirationTime(),
     systemName: '灯灯平台',
     url: 'https://tangyh.top'
   ]
   

8. 签名

   消息类型为短信时使用此字段。在第三方短信平台配置的短信签名。

9. 短信模板

   消息类型为短信时使用此字段。在第三方短信平台配置的短信模板ID。