企业微信Webhook推送助手使用指南

项目介绍

企业微信Webhook推送助手是一个基于Java开发的SDK库，专门用于简化企业微信Webhook机器人的消息推送功能。通过配置Webhook地址，开发者可以快速方便地发送各种类型的消息通知，无需手动拼接复杂的参数，采用面向对象的方式优雅地发送提醒。

当前版本支持的消息类型包括：

• 文本消息
• 图片消息
• 文本卡片消息
• 图文消息（支持批量）
• Markdown消息

快速开始

添加Maven依赖

在你的Maven项目中添加以下依赖：

<dependency>
    <groupId>io.github.swalikh</groupId>
    <artifactId>wework-wehook-starter</artifactId>
    <version>1.0.0</version>
</dependency>

配置Webhook地址

在Spring Boot应用的配置文件中配置Webhook API地址，支持配置一个或多个地址：

spring:
  message:
    wechat-webhooks: 
      - https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxxx
      - https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=yyyyyyyy

注入MessageService发送消息

在代码中注入MessageService并发送各种类型的消息：

@Autowired
private MessageService messageService;

消息发送示例

发送文本消息

WeWorkWebhookMessage textMessage = WeWorkWebhookMessage.buildText("你好，世界！");
messageService.send(textMessage);

发送图片消息

支持网络图片和本地图片，格式支持JPG和PNG：

// 网络图片示例
String networkImageUrl = "http://www.image.com/dog.jpg";
WeWorkWebhookMessage imageMessage = WeWorkWebhookMessage.buildImageMessage(networkImageUrl);
messageService.send(imageMessage);

// 本地图片示例
String localImageFilePath = "/home/image/cat.png";
WeWorkWebhookMessage localImageMessage = WeWorkWebhookMessage.buildImageMessage(localImageFilePath);
messageService.send(localImageMessage);

发送图文卡片消息

Article article = new Article()
    .setTitle("这是卡片的标题")
    .setUrl("http://www.example.com/这是点击的链接地址")
    .setPicurl("http://www.image.com/dog.jpg")
    .setDescription("这是描述文字");

WeWorkWebhookMessage articleMessage = WeWorkWebhookMessage.buildNewsMessage(article);
messageService.send(articleMessage);

发送Markdown消息

使用MarkdownBuffer构建复杂的Markdown格式消息：

MarkdownBuffer markdownBuffer = new MarkdownBuffer();
markdownBuffer
    .h2("H2标题").nextLine()
    .h3("H3标题").nextLine()
    .quote("引用文本").quoteEnd()
    .green("绿色文字").nextLine()
    .orange("橙色文字").nextLine()
    .gray("灰色文字").nextLine()
    .code("单行代码").nextLine()
    .link("链接标题", "链接URL").nextLine();

WeWorkWebhookMessage markDownMessage = WeWorkWebhookMessage.buildMarkDownMessage(markdownBuffer);
messageService.send(markDownMessage);

项目技术架构

该项目基于Spring Boot框架构建，核心依赖包括：

• Spring Boot AutoConfigure：自动配置支持
• Lombok：简化Java代码编写
• Fastjson：JSON处理库
• Apache HttpClient：HTTP客户端
• SLF4J：日志框架

应用场景

自动化日报推送

集成到CI/CD流程中，每日构建成功后自动向团队发送构建报告和状态更新。

系统监控告警

当系统监测到异常或性能问题时，立即通过Webhook发送告警通知到指定的工作群组。

任务完成通知

自动化任务（如代码审查、部署、测试等）完成后，发送完成状态通知给相关人员。

数据报表推送

定期将业务数据报表通过图文消息的形式推送到企业微信群，方便团队查看和分析。

最佳实践建议

1. 消息模板化：定义清晰的消息模板，保持消息格式统一和专业化
2. 分组策略：根据消息重要程度设置不同的接收群组，减少不必要的打扰
3. 错误处理：合理处理网络异常和API调用失败的情况，确保消息可靠性
4. 性能优化：对于高频消息发送场景，考虑使用异步发送和批量发送机制

项目结构说明

核心代码位于src/main/java/com/sayalala/wework/wehook/目录下：

• config/：配置相关类，包含消息发送属性配置
• entity/：实体类，包括消息和文章数据结构
• service/：服务接口和实现，提供消息发送功能
• utils/：工具类集合，包含Base64处理、HTTP客户端、Markdown构建器等

该项目采用Apache 2.0许可证开源，开发者可以自由使用和修改代码以满足特定业务需求。