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

2026-02-06 04:52:38作者：傅爽业Veleda

项目介绍

企业微信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);