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

本文链接：https://blog.youkuaiyun.com/gitblog_00310/article/details/148360239

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

apollo apolloconfig/apollo: 是一个分布式配置管理平台，可以方便地实现配置的统一管理和发布。该项目提供了一个简单易用的配置管理平台，可以方便地实现配置的统一管理和发布，同时支持多种配置格式和部署方式。项目地址: https://gitcode.com/gh_mirrors/apoll/apollo

前言

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

邮件通知功能概述

Apollo的邮件通知功能具有以下特点：

支持多种操作类型：普通发布、灰度发布、全量发布和回滚操作
灵活的接收对象：可通知命名空间编辑和发布权限的人员，以及应用负责人
可配置的通知环境：可指定哪些环境的操作需要发送邮件通知
模板化内容：邮件内容采用模板化设计，便于自定义和管理

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

配置步骤

启用邮件服务：在ApolloPortalDB.ServerConfig表中或通过管理员工具->系统参数页面配置以下参数：
```
email.enabled=true
email.config.host=smtp.163.com
email.config.user=your_username
email.config.password=your_password
```

基础配置：

# 支持发送邮件的环境列表，用逗号分隔
email.supported.envs=DEV,FAT,UAT,PRO

# 发件人地址（可选，默认为email.config.user）
email.sender=apollo@yourcompany.com

# Apollo Portal地址，用于邮件中的跳转链接
apollo.portal.address=http://apollo.yourcompany.com

邮件模板配置：

# 邮件内容框架模板
email.template.framework=...

# 发布邮件的差异模块
email.template.release.module.diff=...

# 回滚邮件的差异模块
email.template.rollback.module.diff=...

# 灰度发布规则模块
email.template.release.module.rules=...

注意事项

修改配置后通常1分钟内生效
确保SMTP服务地址、账号和密码正确
建议仅在生产环境启用邮件通知，避免测试环境产生过多邮件

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

对于有自建邮件服务的企业，Apollo提供了SPI接口，可以方便地集成企业内部的邮件系统。

实现步骤

实现EmailService接口：创建一个实现EmailService接口的类，提供企业邮件服务的具体实现。
注册自定义实现：在EmailConfiguration类中注册你的实现，并通过Profile机制控制使用哪个实现。
配置参数：配置与方案一相同的系统参数，但不需要配置SMTP相关参数。

关键代码说明

ConfigPublishListener：监听发布事件，负责触发邮件发送流程
emailbuilder包：构建邮件内容的各个模块
EmailService：邮件发送的核心接口
EmailConfiguration：邮件服务注册类

邮件模板详解

Apollo的邮件模板采用HTML格式，支持丰富的样式和内容展示。以下是核心模板的介绍：

1. 基础框架模板

包含发布基本信息表格、差异内容模块、规则模块和底部链接。模板使用内联CSS确保在各种邮件客户端中显示一致。

<html>
<head>
<style>
/* 表格样式定义 */
</style>
</head>
<body>
<!-- 发布基本信息表格 -->
<!-- 差异内容模块占位符 -->
<!-- 规则模块占位符 -->
<!-- 底部链接 -->
</body>
</html>

2. 发布差异模块

展示配置项变更前后的对比，包括变更类型、键名、旧值和新值。

<h3>Changed Configuration Items</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>