消息通知
# 一、消息通知
概述:消息通知是单独的一个模块,包含通知渠道、通知模板、通知日志三个菜单,模板通过关联业务编码,可灵活的对接其他模块业务;
技术实现:短信、邮箱发送使用第三方技术首页 | SMS4J文档 (opens new window),其他渠道发送使用官方api文档。
申请流程:
阿里云短信、语音
微信小程序订阅模板申请,参考三方登录先申请微信小程序,然后登录微信公众平台微信小程序申请订阅消息
# 二、通知渠道
概述:通知渠道配置主要用于对接第三方渠道服务商的连接参数,一个渠道可配多个通知模版。
定义:渠道、服务商来源于字典数据,服务商需严格按照已有字典类型格式配置,可自行修改:
差异:不同渠道服务商配置参数可能有差异,配置参数来自以下类,可根据业务自行调整配置参数类:
注意:短信配置参数字段名称必须和sms4j文档里定义的参数名称保持一致
# 三、通知模版
概述:通知模版主要配置模版参数,模板归属于通知渠道(配置模板时需选择对应已配好的通知渠道账号),同时也要选择相应的业务编码,配好后在列表里启用;
差异:不同渠道模版参数有差异,配置参数来自以下类,可自行调整:
注意:短信配置参数字段名称必须和sms4j文档里定义的参数名称保持一致
注意:模版参数里的content字段对应模版内容,需要把第三方申请的模版内容原样复制过来(方便记录完整的日志内容),其中微信小程序订阅模版里的变量使用符号{{}}表示,其余模版变量使用符号${}表示。
微信小程序订阅模板内容复制
短信语音模板内容复制
# 四、通知日志
概述:记录所有通知模版发送的日志,在对接新业务的发送通知时需自行记录日志;
# 五、业务对接
概述:业务编码唯一,一个业务编码可配置多个通知模版,但只能启用一个模版。
对接:已对接告警短信、邮箱、语音、微信小程序(订阅消息),短信验证码业务。如需添加业务,可同时在字典数据通知业务编码和通知业务枚举类NotifyServiceCodeEnum里自行添加。
测试:在配置好模版后,可点击测试按钮,检测是否能发送成功。
发送服务类:主要对接不同渠道服务商的发送
业务服务类:主要对接业务发送,有新业务可写在这。一般只需要替换一下模版变量参数,保存一下通知日志,发送时直接调用发送服务类里的方法。
注意:
在对接其他业务时,务必保证模版是启用的状态,否则会发送失败。
模版内容存在变量的,需要把变量替换为真实的参数。目前已对接的业务,模版变量是按顺序替换的,因此在申请模版内容时,变量的顺序务必和我们演示站点模版变量顺序一致。如果需要修改发送变量,可自行参考以下代码调整:
# 六、后续更新
1、优化通知渠道参数配置、通知模版参数配置,展示中文名和不同的文本框形式;
2、新增其他还未实现的渠道服务商通知配置;
3、新增其他通知业务;