MudFeishu 是一套现代化的企业级 .NET 飞书 API 集成 SDK,提供完整的 HTTP API 调用、WebSocket 实时事件订阅和 Webhook 事件处理能力。SDK 采用策略模式和工厂模式设计,内置自动令牌管理、智能重试、高性能缓存等企业级特性,大幅简化飞书应用的开发难度。
- 🚀 极简 API - 一行代码完成服务注册,开箱即用
- 🏗️ 类型安全 - 强类型数据模型,编译时类型检查
- 🔄 自动令牌管理 - 智能缓存和刷新,无需手动维护
- 🛡️ 企业级稳定 - 统一异常处理、智能重试、详细日志
- 🎯 事件驱动 - 策略模式事件处理,灵活扩展
- 📊 多框架支持 - .NET Standard 2.0、.NET 6.0、.NET 8.0、.NET 10.0
- 🔒 安全防护 - SSRF 防护、URL 白名单验证、签名验证、加密解密
- 📈 可观测性 - 内置 FeishuMetrics 指标收集,支持 OpenTelemetry 集成
# HTTP API 客户端 (核心模块)
dotnet add package Mud.Feishu
# 事件处理抽象层 (核心模块,Mud.Feishu/WebSocket/Webhook 依赖)
dotnet add package Mud.Feishu.Abstractions
# WebSocket 实时事件订阅 (可选)
dotnet add package Mud.Feishu.WebSocket
# Webhook HTTP 回调事件处理 (可选)
dotnet add package Mud.Feishu.Webhook
# 用户认证中间件 (可选)
dotnet add package Mud.Feishu.Authentication
# 事件回调强类型数据模型 (可选)
dotnet add package Mud.Feishu.EventCallback
# Redis 分布式去重扩展 (可选)
dotnet add package Mud.Feishu.Redis💡 提示:根据实际需求安装对应包,
Mud.Feishu是核心包,Mud.Feishu.Abstractions已作为 Mud.Feishu\WebSocket\Webhook 的依赖自动安装。
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Mud.Feishu": "Debug"
}
},
"FeishuApps": [
{
"AppKey": "default",
"AppId": "your_feishu_app_id",
"AppSecret": "your_feishu_app_secret",
"BaseUrl": "https://open.feishu.cn",
"TimeOut": 30,
"RetryCount": 3,
"RetryDelayMs": 1000,
"EnableLogging": true
}
],
"FeishuWebSocket": {
"AutoReconnect": true,
"MaxReconnectAttempts": 5,
"ReconnectDelayMs": 5000,
"HeartbeatIntervalMs": 25000,
"EnableLogging": true,
"EventDeduplication": {
"Mode": "InMemory",
"CacheExpirationMs": 86400000,
"CleanupIntervalMs": 300000
}
},
"Webhook": {
"GlobalRoutePrefix": "feishu",
"EnableRequestLogging": true,
"MaxConcurrentEvents": 10,
"Apps": {
"app1": {
"AppKey": "cli_a1b2c3d4e5f6g7h8",
"VerificationToken": "your_app1_verification_token",
"EncryptKey": "your_app1_encrypt_key_32_bytes_long"
},
"app2": {
"AppKey": "cli_h8g7f6e5d4c3b2a1",
"VerificationToken": "your_app2_verification_token",
"EncryptKey": "your_app2_encrypt_key_32_bytes_long"
}
}
}
}using Mud.Feishu;
using Mud.Feishu.WebSocket;
using Mud.Feishu.Webhook;
var builder = WebApplication.CreateBuilder(args);
// 注册多应用模式(方式一:从配置文件加载)
builder.Services.AddFeishuApp(builder.Configuration);
// 注册多应用模式(方式二:代码配置)
builder.Services.AddFeishuApp(configure =>
{
config.AddDefaultApp("default", "cli_xxx", "dsk_xxx");
config.AddApp("hr-app", "cli_yyy", "dsk_yyy", opt =>
{
opt.TimeOut = 45;
opt.RetryCount = 5;
opt.RetryDelayMs = 2000; // 自定义重试延迟
opt.TokenRefreshThreshold = 300; // Token 刷新阈值(秒)
});
});
// 注册多应用模式(方式三:使用预构建的配置列表)
var configs = new List<FeishuAppConfig>
{
new FeishuAppConfig { AppKey = "default", AppId = "cli_xxx", AppSecret = "dsk_xxx" }, // IsDefault 自动推断
new FeishuAppConfig { AppKey = "hr-app", AppId = "cli_yyy", AppSecret = "dsk_yyy" }
};
builder.Services.AddFeishuApp(configs);
// 注册 HTTP API 服务(懒人模式 - 注册所有服务)
builder.Services.CreateFeishuServicesBuilder()
.AddAllApis()
.Build();
// 注册 HTTP API 服务(构造者模式 - 按需注册)
builder.Services.CreateFeishuServicesBuilder()
.AddOrganizationApi()
.AddMessageApi()
.AddChatGroupApi()
.AddApprovalApi()
.AddTaskApi()
.AddCardApi()
.AddAttendanceApi()
.AddDriveApi()
.AddWikiApi()
.AddDocxApi()
.AddSpreadsheetsApi()
.AddBiTableApi()
.Build();
// 注册 HTTP API 服务(按模块注册)
builder.Services.AddFeishuServices(
FeishuModule.Organization,
FeishuModule.Message,
FeishuModule.ChatGroup,
FeishuModule.Spreadsheets,
FeishuModule.Bitable
);
// 注册 WebSocket 事件订阅服务
builder.Services.CreateFeishuWebSocketServiceBuilder(builder.Configuration, "default")
.AddHandler<MessageEventHandler>()
.Build();
// 注册 Webhook HTTP 回调事件服务
builder.Services.CreateFeishuWebhookServiceBuilder(builder.Configuration)
.AddHandler<MessageReceiveEventHandler>()
.AddHandler<DepartmentCreatedEventHandler>()
.Build();
var app = builder.Build();
// 添加 Webhook 中间件
app.UseFeishuWebhook();
app.Run();// 获取用户信息测试
public class TestController : ControllerBase
{
private readonly IFeishuTenantV3User _userApi;
public TestController(IFeishuTenantV3User userApi)
{
_userApi = userApi;
}
[HttpGet("test")]
public async Task<IActionResult> TestConnection()
{
var result = await _userApi.GetUserInfoByIdAsync("test_user_id");
return Ok(new { code = result.Code, message = result.Msg });
}
}Mud.Feishu 提供完整的飞书 HTTP API 覆盖,支持以下模块:
| 模块分类 | API 版本 | 主要功能 |
|---|---|---|
| 🔐 认证授权 | V3 | 应用令牌、租户令牌、用户令牌、OAuth 2.0、多应用管理 |
| 👥 组织架构 | V1/V3 | 用户、部门、员工、用户组、职级、职务、角色 |
| 💬 消息服务 | V1 | 文本/图片/卡片消息、批量发送、群聊管理 |
| 📋 审批流程 | V4 | 审批定义、审批实例、审批任务、审批消息、审批订阅 |
| 📝 任务管理 | V2 | 任务创建、更新、分组、附件、评论、自定义字段 |
| 📅 日程会议 | V4 | 日程事件、会议管理 |
| 📄 文档管理 | V1 | 飞书文档、文档块、内容转换 |
| 📚 知识库 | V2 | 知识空间、节点管理、节点复制移动 |
| ☁️ 云盘管理 | V1 | 云空间、文件夹、文件上传、版本管理、权限、评论、订阅 |
| 🎨 画板管理 | V1 | 画板主题、缩略图、节点创建、语法解析 |
| 📊 电子表格 | V2/V3 | 电子表格、区域操作、筛选、数据验证、条件格式 |
| 📋 多维表格 | V1/V2 | 数据表、记录、字段、视图、表单、仪表盘、角色、自动化 |
| ⏰ 考勤管理 | V1 | 考勤组、打卡记录、班次、请假审批、考勤统计、档案 |
| 🎴 卡片管理 | V1/V2 | 卡片管理、卡片元素、消息流卡片 |
飞书文档 API,支持文档创建、编辑、块操作等。
public interface IFeishuV1Docx
{
// 文档基础操作
}
public interface IFeishuV1DocxBlocks
{
// 文档块操作
}功能列表:
- 文档创建和获取
- 文档块读取和更新
- 批量操作文档块
- 内容转换
知识空间和节点管理 API。
public interface IFeishuV2Wiki
{
// 知识空间管理
}
public interface IFeishuV2WikiNodes
{
// 知识节点管理
}功能列表:
- 知识空间创建和查询
- 节点树结构管理
- 节点复制和移动
- 文档导入知识库
云空间文件和文件夹管理 API。
public interface IFeishuV1DriveFiles
{
// 文件操作
}
public interface IFeishuV1DriveFolder
{
// 文件夹操作
}
public interface IFeishuV1DriveFilesVersions
{
// 文件版本管理
}
public interface IFeishuV1DrivePermissions
{
// 云文档权限管理
}
public interface IFeishuV1DriveSubscribe
{
// 云文档事件订阅
}
public interface IFeishuV1Comments
{
// 云文档评论管理
}功能列表:
- 文件上传和下载
- 文件夹创建和管理
- 文件版本控制
- 媒体文件处理
- 云文档权限管理(协作者增删改查、所有者转移、权限设置)
- 云文档密码管理(启用、刷新、停用)
- 云文档评论管理(评论/回复增删改查、表情回应)
- 云文档事件订阅(文件/用户事件订阅管理)
企业考勤全流程管理 API。
public interface IFeishuV1AttendanceGroups
{
// 考勤组管理
}
public interface IFeishuV1AttendanceUserFlows
{
// 打卡流水
}
public interface IFeishuV1AttendanceStats
{
// 考勤统计
}功能列表:
- 考勤组配置管理
- 打卡记录查询
- 班次管理
- 请假审批
- 补卡申请
- 考勤统计报表
企业审批全流程管理 API。
public interface IFeishuV4Approval
{
// 审批定义和实例
}
public interface IFeishuV4ApprovalTask
{
// 审批任务管理
}功能列表:
- 审批定义创建
- 审批实例发起
- 审批任务处理
- 审批评论
- 第三方审批集成
飞书任务全功能 API。
public interface IFeishuV2Task
{
// 任务管理
}
public interface IFeishuV2TaskCustomFields
{
// 自定义字段
}功能列表:
- 任务创建和更新
- 任务列表管理
- 任务分组
- 任务评论和附件
- 自定义字段
完整的组织架构管理 API。
public interface IFeishuTenantV3User
{
// 用户管理
}
public interface IFeishuTenantV3Departments
{
// 部门管理
}功能列表:
- 用户 CRUD 操作
- 部门树管理
- 用户组管理
- 职级职务管理
- 角色权限管理
消息发送和批量消息 API。
public interface IFeishuV1Message
{
// 消息发送
}
public interface IFeishuV1BatchMessage
{
// 批量消息
}功能列表:
- 文本/图片/卡片消息
- 批量发送
- 消息撤回
- 已读状态查询
卡片和消息流卡片 API。
public interface IFeishuV1Card
{
// 卡片管理
}
public interface IFeishuV1CardElements
{
// 卡片元素
}功能列表:
- 卡片创建和更新
- 卡片元素管理
- 消息流卡片
群组和会话管理 API。
public interface IFeishuTenantV3ChatGroup
{
// 群组管理
}功能列表:
- 群组创建和管理
- 群成员管理
- 群公告
- 会话标签
飞书画板(白板)API,支持画板主题、节点管理和语法解析。
public interface IFeishuV1Board
{
// 画板管理
}功能列表:
- 获取和更新画板主题
- 获取画板缩略图片
- 解析画板语法(PlantUML/Mermaid)
- 创建和管理画板节点
飞书电子表格 API,支持完整的电子表格操作。
public interface IFeishuV3Spreadsheets
{
// 电子表格基础操作
}
public interface IFeishuV3SpreadsheetRange
{
// 区域操作
}
public interface IFeishuV3SpreadsheetData
{
// 数据操作
}
public interface IFeishuV3SpreadsheetCell
{
// 单元格操作
}
public interface IFeishuV3SpreadsheetFilter
{
// 筛选操作
}功能列表:
- 电子表格创建和获取
- 区域读写和格式化
- 数据查询和更新
- 单元格样式设置
- 筛选器和筛选视图
- 浮动图片管理
- 保护范围和数据验证
- 条件格式
飞书多维表格 API,支持完整的多维表格数据管理。
public interface IFeishuV1Bitable
{
// 多维表格应用管理
}
public interface IFeishuV1BitableAppTable
{
// 数据表管理
}
public interface IFeishuV1BitableRecord
{
// 记录管理
}
public interface IFeishuV1BitableField
{
// 字段管理
}
public interface IFeishuV1BitableView
{
// 视图管理
}功能列表:
- 多维表格应用管理
- 数据表 CRUD 操作
- 记录增删改查
- 字段类型管理
- 视图配置
- 表单管理
- 仪表盘统计
- 角色权限控制
- 自动化流程管理
统一的事件处理架构,WebSocket 和 Webhook 共享相同的处理器接口
| 功能特性 | 说明 |
|---|---|
| 策略模式 | 可扩展的事件处理器架构 |
| 工厂模式 | 动态注册和发现处理器 |
| 类型安全 | 强类型数据模型,编译时检查 |
| 自动去重 | 内置事件 ID 去重机制(内存/分布式) |
| 事件拦截器 | 支持事件处理前后的拦截逻辑 |
| 基类处理器 | 简化开发的专用基类 |
| 性能指标 | 内置 FeishuMetrics 指标收集(Token、事件、HTTP、WebSocket) |
| SSRF 防护 | URL 白名单验证和私有 IP 检测 |
| SeqID 去重 | WebSocket 二进制消息序列号去重 |
核心工具类:
FeishuMetrics/FeishuMetricsHelper- 统一性能指标收集(Token 缓存、事件处理、HTTP 请求、WebSocket 连接)FeishuEventDeduplicator- 事件去重服务(支持内存和分布式模式)FeishuSeqIDDeduplicator- WebSocket 消息序列号去重TokenUtils- 令牌工具类UrlValidator- URL 白名单验证和 SSRF 防护(来自 Mud.HttpUtils)
企业级特性:
- ✅ 自动令牌缓存和刷新
- ✅ 智能重试机制(可配置重试次数和延迟)
- ✅ 高性能缓存(解决缓存击穿)
- ✅ 统一异常处理
- ✅ 连接池管理
- ✅ 详细日志记录
- ✅ 多应用上下文切换支持
- ✅ 性能指标监控(内置 FeishuMetrics 指标收集)
- ✅ SSRF 防护(URL 白名单验证和私有 IP 检测)
- ✅ 自定义模块注册器(IFeishuModuleRegistrar 扩展)
💡 提示:查看完整 API 文档
企业级 WebSocket 客户端:
- ✅ 智能连接管理(自动重连、心跳检测、状态监控)
- ✅ 指数退避重连策略(可插拔 IReconnectStrategy,双重限制:次数和时间)
- ✅ 事件去重(InMemory/Distributed 模式,支持 Redis 分布式去重)
- ✅ 消息序号验证(重放攻击检测、消息丢失检测、序号回退检测)
- ✅ 消息队列背压策略(DropOldest/DropNewest/Block 三种策略)
- ✅ 会话管理(session_id 管理、断线恢复、24 小时有效期)
- ✅ 连接指标监控(FeishuMetrics 集成,实时统计吞吐量)
- ✅ SSL/TLS 证书验证(可配置验证策略、自定义验证回调)
- ✅ 访问令牌自动刷新(缓存和提前刷新避免过期)
💡 提示:查看完整文档
企业级 Webhook 处理:
- ✅ 安全验证(签名验证、时间戳验证、Nonce 验证、订阅验证)
- ✅ 加密解密(内置 AES-256-CBC 解密,自动处理飞书加密事件)
- ✅ 自定义验证器(ISignatureValidator、ITimestampValidator、INonceValidator、IEncryptKeyProvider)
- ✅ 请求频率限制(内置滑动窗口限流中间件)
- ✅ 多应用模式(独立路由、处理器、拦截器和配置)
- ✅ 应用级配置继承(全局配置自动继承到应用级)
- ✅ 后台处理模式(异步事件处理,不阻塞 HTTP 响应)
- ✅ 事件重试机制(可配置重试次数、延迟和策略)
- ✅ 健康检查(内置 FeishuWebhookHealthCheck)
- ✅ 性能监控(可选性能指标收集)
💡 提示:查看完整文档
- ✅ 基于 AsyncLocal 的线程安全用户上下文管理
- ✅ 从 JWT Claims 自动提取飞书用户信息
- ✅ 支持分布式追踪 (ActivitySource)
- ✅ 请求结束后自动清理用户上下文
💡 提示:查看完整文档
- ✅ 强类型数据模型(所有事件数据均有完整类型定义和 XML 文档注释)
- ✅ 源代码生成器(自动生成事件处理器基类)
- ✅ 完整事件覆盖(组织架构、即时通讯、审批、任务等主要业务场景)
💡 提示:查看完整文档
- ✅ 事件去重(Redis Hash + Lua 脚本状态机模式)
- ✅ Nonce 去重(SETNX + EXPIRE 防止重放攻击)
- ✅ SeqID 去重(Sorted Set 支持范围查询)
- ✅ 降级策略(Redis 故障时自动降级到内存去重)
- ✅ 多应用隔离(所有去重器支持 appKey 参数)
- ✅ 健康检查(内置 Redis 健康检查)
💡 提示:查看完整文档
// 创建用户
[HttpPost("users")]
public async Task<IActionResult> CreateUser([FromBody] CreateUserRequest request)
{
_userApi.UseApp("hr-app");// 多应用场景下切换应用
var result = await _userApi.CreateUserAsync(request);
_userApi.UseDefaultApp();
return result.Code == 0 ? Ok(result.Data) : BadRequest(result.Msg);
}
// 多应用场景下使用 IFeishuAppManager
var tenantJobTitleApi = _feishuAppManager.GetFeishuApi<IFeishuTenantV3JobTitle>("hr-app");
var result = await tenantJobTitleApi.GetJobTitlesListAsync(10, null);
// 使用应用上下文切换器
var contextSwitcher = _feishuAppManager.GetAppContextSwitcher();
using (contextSwitcher.UseApp("hr-app"))
{
var userApi = _feishuAppManager.GetFeishuApi<IFeishuTenantV3User>();
var userResult = await userApi.GetUserInfoByIdAsync("user_123");
}// WebSocket 实时事件订阅
builder.Services.CreateFeishuWebSocketServiceBuilder(builder.Configuration, "default")
.AddHandler<MessageEventHandler>()
.Build();
// Webhook HTTP 回调事件处理
builder.Services.CreateFeishuWebhookServiceBuilder(builder.Configuration)
.AddHandler<DepartmentCreatedEventHandler>()
.Build();
app.UseFeishuWebhook();// WebSocket 多应用事件订阅
builder.Services.CreateFeishuWebSocketServiceBuilder(builder.Configuration, "default")
.AddHandler<DefaultAppEventHandler>()
.Build();
builder.Services.CreateFeishuWebSocketServiceBuilder(builder.Configuration, "hr-app")
.AddHandler<HrAppEventHandler>()
.Build();
// Webhook 多应用事件处理(独立路由、处理器和拦截器)
builder.Services.CreateFeishuWebhookServiceBuilder(builder.Configuration)
.AddHandler<App1Handler>("app1")
.AddInterceptor<App1LoggingInterceptor>("app1")
.AddHandler<App2Handler>("app2")
.Build();以下是 FeishuWikiManager(飞书知识库管理 Demo)的实际运行界面截图,展示了 SDK 在实际项目中的应用效果:
| 飞书 OAuth 授权 | 系统登录界面 |
|---|---|
![]() |
![]() |
| 主界面 | 知识空间 |
|---|---|
![]() |
![]() |
| 搜索功能 | 云空间同步 |
|---|---|
![]() |
![]() |
| 文档管理主界面 | 文件上传 |
|---|---|
![]() |
![]() |
💡 提示:以上界面均基于 Mud.Feishu SDK 开发,完整展示了飞书 OAuth 认证、知识库管理、文档搜索、云空间同步等核心功能。查看 Demo 源码
- Mud.Feishu.Abstractions 详细文档 - 事件处理抽象层使用指南
- Mud.Feishu 详细文档 - HTTP API 完整使用指南
- Mud.Feishu.EventCallback 详细文档 - 飞书事件回调强类型数据模型使用指南
- Mud.Feishu.WebSocket 详细文档 - WebSocket 实时事件订阅指南
- Mud.Feishu.Webhook 详细文档 - Webhook HTTP 回调事件处理指南
- Mud.Feishu.Authentication 详细文档 - 飞书用户认证中间件使用指南
- Mud.Feishu.Redis 详细文档 - Redis 分布式去重扩展指南
- .NET Standard 2.0 - 兼容 .NET Framework 4.6.1+
- .NET 6.0 - LTS 长期支持版本
- .NET 8.0 - LTS 长期支持版本(推荐)
- .NET 10.0 - LTS 长期支持版本(推荐)
| 包 | 版本 | 说明 |
|---|---|---|
| Mud.HttpUtils | v1.7.0 | HTTP 客户端工具类 |
| Mud.HttpUtils.Generator | v1.7.0 | HTTP 客户端代码生成器(编译时) |
| Microsoft.Extensions.Http | v8.0.1 / v10.0.4 | HTTP 客户端工厂 |
| Microsoft.Extensions.Http.Polly | v8.0.2 / v10.0.4 | 弹性和瞬态故障处理 |
本项目遵循 MIT 许可证,允许商业和非商业用途。
- 飞书开放平台文档 - 飞书 API 官方文档和最佳实践
- NuGet 包管理器 - .NET 包管理官方平台
- Mud.Feishu.Abstractions - 事件处理抽象层
- Mud.Feishu - 核心 HTTP API 客户端库
- Mud.Feishu.WebSocket - WebSocket 实时事件订阅库
- Mud.Feishu.Webhook - Webhook HTTP 回调事件处理库
- Mud.Feishu.Authentication - 飞书用户认证中间件库
- Mud.Feishu.EventCallback - 飞书事件回调强类型数据模型
- Mud.Feishu.Redis - Redis 分布式去重扩展库
- 项目仓库 - 源代码和开发文档
- Mud.ServiceCodeGenerator - HTTP 客户端代码生成器
- 示例项目 - 完整的使用示例和演示代码
- FeishuWikiManager - 飞书知识库管理 Demo(Vue3 + .NET)
- FeishuFileServer - 飞书云文档文件服务 Demo(Vue3 + .NET)
- FeishuOAuthDemo - 飞书 OAuth 认证 Demo(Vue3 + .NET)
- TaskManageDemo - 飞书任务管理 Demo(Vue3 + .NET)
- WebSocket Demo - WebSocket 实时事件演示
- 测试项目 - 完整的单元测试和集成测试
如果觉得 MudFeishu 对你有帮助,请给个 ⭐Star 支持一下!
Made with ❤️ by MudTools







