Apollo配置中心：如何启用邮件通知服务详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01187/article/details/148360244

Apollo配置中心：如何启用邮件通知服务详解

apollo 项目地址: https://gitcode.com/gh_mirrors/ap/apollo

前言

在分布式系统配置管理中，及时获取配置变更通知至关重要。Apollo配置中心提供了完善的邮件通知机制，可以在配置发布、灰度发布、全量发布和回滚等关键操作时，自动发送邮件通知相关人员。本文将详细介绍如何在Apollo中启用和配置邮件服务。

邮件通知场景

Apollo支持在以下场景触发邮件通知：

普通配置发布
灰度发布
全量发布
配置回滚

通知对象包括：

具有Namespace编辑和发布权限的人员
App负责人

邮件服务实现方案

Apollo提供了两种邮件服务实现方式，满足不同企业的需求：

方案一：使用内置SMTP邮件服务

这是最简单的实现方式，适合大多数标准SMTP邮件服务场景。

配置步骤

启用邮件服务
```
email.enabled=true
```

配置SMTP服务器

email.config.host=smtp.example.com
email.config.user=your_username
email.config.password=your_password

设置邮件发送环境
```
email.supported.envs=DEV,FAT,UAT
```
配置发件人信息
```
email.sender=apollo@company.com
```

设置Portal地址

apollo.portal.address=http://apollo.portal.company.com

配置邮件模板

email.template.framework=...
email.template.release.module.diff=...
email.template.rollback.module.diff=...
email.template.release.module.rules=...

注意事项

配置修改后约1分钟生效
建议只对重要环境启用邮件通知，避免产生垃圾邮件
密码建议使用加密存储

方案二：集成企业邮件服务

对于有特殊邮件服务需求的企业，Apollo提供了SPI接口，可以自定义实现。

实现步骤

实现EmailService接口

创建自定义邮件服务类，实现com.ctrip.framework.apollo.portal.spi.EmailService接口。
注册自定义实现

在EmailConfiguration类中注册你的实现，并使用特定profile标记。
配置必要参数

与方案一类似，需要配置：
- 支持的环境列表
- 发件人信息
- Portal地址
- 邮件模板

技术实现细节

事件监听：ConfigPublishListener监听发布事件
邮件构建：emailbuilder包负责构建邮件内容
服务注册：通过EmailConfiguration管理不同实现

邮件模板详解

Apollo提供了灵活的邮件模板系统，支持HTML格式，包含以下关键模板：

1. 基础框架模板

<html>
...
<h3>发布基本信息</h3>
<table>
  <!-- 发布元数据 -->
</table>
#{diffModule}
#{rulesModule}
...
</html>

2. 发布差异模板

<h3>变更的配置</h3>
<table>
  <tr>
    <td><b>Type</b></td>
    <td><b>Key</b></td>
    <td><b>Old Value</b></td>
    <td><b>New Value</b></td>
  </tr>
  #{diffContent}
</table>

3. 回滚差异模板

<h3>变更的配置</h3>
<table>
  <tr>
    <td><b>Type</b></td>
    <td><b>Key</b></td>
    <td><b>回滚前</b></td>
    <td><b>回滚后</b></td>
  </tr>
  #{diffContent}
</table>