竹简文档
通知服务

通知服务

bamboo-notify 模块提供邮件、Webhook、短信等多渠道通知能力

通知服务

bamboo-notify 是筱工具(Java) 的通知层模块,提供统一的多渠道消息通知能力。通过 NotifyService 接口抽象,实现邮件、Webhook 等通知渠道的标准化接入。

核心架构

NotifyService (统一通知接口)
├── EmailNotify    (邮件通知实现)
└── WebhookNotify  (Webhook 通知实现)

TemplateEngine (模板引擎接口)
└── 自定义实现

NotifyMessage ──→ NotifyService ──→ NotifyResult
(消息构建)        (发送处理)        (结果反馈)

所有通知渠道均实现 NotifyService 接口,业务层通过统一的 send()sendAsync() 方法发送通知,无需关注底层渠道差异。

Maven 依赖

pom.xml
<dependency>
    <groupId>com.x-lf.utility</groupId>
    <artifactId>bamboo-notify</artifactId>
    <version>2.0.0</version>
</dependency>

通知类型

NotifyType 枚举定义了当前支持的通知渠道:

枚举值说明
EMAIL邮件通知,基于 SMTP 协议发送
WEBHOOKWebhook 通知,通过 HTTP 回调推送
SMS短信通知,对接第三方短信服务

基本用法

NotifyExample.java
import com.xlf.utility.notify.NotifyMessage;
import com.xlf.utility.notify.NotifyResult;
import com.xlf.utility.notify.NotifyService;
import com.xlf.utility.notify.NotifyType;

// 构建通知消息
NotifyMessage message = NotifyMessage.builder()
        .to("admin@example.com")
        .subject("系统告警")
        .content("服务器 CPU 使用率超过 90%")
        .type(NotifyType.EMAIL)
        .priority(1)
        .build();

// 同步发送
NotifyResult result = notifyService.send(message);

// 异步发送(无返回值)
notifyService.sendAsync(message);

模块结构

类 / 接口说明
NotifyService通知服务接口,定义 send()sendAsync() 方法
NotifyMessage通知消息模型,采用 Builder 模式构建
NotifyResult通知结果模型,包含成功状态与错误信息
NotifyType通知类型枚举
TemplateEngine模板引擎接口,支持变量替换渲染
EmailNotify邮件通知实现
WebhookNotifyWebhook 通知实现

下一步

On this page