开源项目最佳实践教程：基于 go-notify

1. 项目介绍

go-notify 是一个用 Golang 编写的电子邮件自动化解决方案。该项目允许用户注册、发送和为他们的客户调度自定义 HTML 邮件。它采用了一系列丰富的技术栈，包括：

• 使用 Go-fiber 构建的 API 服务器。
• Apache Kafka 作为消息代理。
• Postgres 作为数据库。
• Redis 作为缓存。
• 使用 Cobra 构建的客户端 CLI。
• Mailgun 作为电子邮件服务。
• K6 用于负载测试。
• Prometheus 和 Grafana 用于 API 服务器监控。

项目支持特性包括：

• 使用 JWT 进行身份验证和授权。
• Swagger 文档。
• 完善的认证功能，如注册、登录、更新密码、忘记密码、登出。
• 安全中间件，如 CORS、Helmet、API 速率限制。
• 用户可以注册客户和自定义 HTML 模板。
• 使用 cron 作业进行邮件调度（每日、每周、每月）。
• 订阅和支付（当前已桩化为示例，可替换为任何合适的支付网关）。

2. 项目快速启动

在开始之前，请确保您的系统中已安装 Go、Docker、Docker Compose 和 Make。

克隆项目

git clone https://github.com/Harry-027/go-notify.git

安装依赖

make download

配置环境变量

在项目根目录下创建一个 .env 文件，并将 .sample-env 文件中的环境变量复制到其中。请注意替换 Mailgun 的环境变量为您的凭证。

启动服务

make setup

这将启动所需的 Docker 容器：Postgres、Redis、Apache Kafka 和 ZooKeeper。

确认所有容器都已启动：

docker ps

启动 API 服务器

在新的终端中运行：

make server

启动 Kafka 消费者

在新的终端中运行：

make consumer

启动 cron 作业

在新的终端中运行：

make cronjob

安装 CLI

make cli-go

现在，CLI 已经准备好使用了。运行以下命令来查看可用命令：

go-notify --help

3. 应用案例和最佳实践

以下是一些应用案例和最佳实践：

• 用户认证：确保所有敏感操作都通过 JWT 进行保护，以维护用户数据的安全。
• 邮件模板管理：使用自定义 HTML 模板，以便为不同的用户场景创建个性化的邮件。
• 邮件调度：利用 cron 作业进行邮件发送，以自动化定期通知。
• 监控和性能测试：使用 Prometheus 和 Grafana 设置监控，以及使用 K6 进行负载测试，以确保系统的稳定性和性能。

4. 典型生态项目

• 前端集成：创建一个前端应用程序，用于与 API 服务器交互，提供更丰富的用户体验。
• 移动应用支持：开发移动应用客户端，以便用户可以随时随地管理邮件通知。
• 插件扩展：开发插件，以支持更多的邮件发送服务或集成其他第三方服务。

通过上述步骤和最佳实践，您可以有效地使用 go-notify 项目，并根据需要扩展其功能。