# MQTTnet.Samples

**Repository Path**: tzm22270969436/mqttnet-samples

## Basic Information

- **Project Name**: MQTTnet.Samples
- **Description**: MQTTNet示例程序
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://mqtt.org
- **GVP Project**: No

## Statistics

- **Stars**: 9
- **Forks**: 0
- **Created**: 2022-10-09
- **Last Updated**: 2025-09-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: mqtt, Csharp

## README



# MQTTnet 示例项目

MQTTnet 是一个用于 .NET 平台的 MQTT 客户端和服务器库，旨在简化 MQTT 协议的使用，便于开发者快速构建基于 MQTT 的通信应用。该项目提供了一系列示例代码，帮助开发者快速上手。

## 功能概览

以下是本项目的主要功能示例分类：

### 客户端功能
- 连接与断开连接（支持 Clean 和 Non-Clean 模式）
- 使用 TLS 加密连接（包括 TLS 1.2 和 CA 证书）
- 使用 MQTTv5 协议连接
- 支持 Kerberos 认证方式的连接
- 发布与订阅 MQTT 主题
- 多主题订阅与消息处理
- 设置消息服务质量（QoS）

### 服务器功能
- 启动简单的 MQTT 服务器
- 支持 WebSocket 和 TLS 的服务器配置
- 拦截和处理客户端消息
- 连接验证与客户端断开管理
- 保留消息处理与持久化存储
- 集成 ASP.NET Core 的控制器支持
- 服务器端日志记录与诊断

### 日志与诊断
- 自定义日志记录实现
- 使用事件日志记录
- 消息包检查与诊断

### RPC 客户端
- 实现基于 MQTT 的 RPC 请求发送

## 快速开始

### 前提条件
- 安装 [.NET SDK](https://dotnet.microsoft.com/download)
- 克隆本项目到本地环境

### 运行示例
1. 打开终端，导航到项目目录。
2. 运行 `dotnet build` 编译项目。
3. 使用 `dotnet run` 启动示例程序。

## 使用示例

- **连接到 MQTT 服务器**：请参考 `Client_Connection_Samples.cs` 了解如何建立连接。
- **发布消息**：查看 `Client_Publish_Samples.cs` 以了解如何发布消息。
- **订阅消息**：查看 `Client_Subscribe_Samples.cs` 以了解如何接收消息。
- **启动服务器**：请参考 `Server_Simple_Samples.cs` 了解如何运行一个最小化服务器。
- **自定义日志**：`Logger_Samples.cs` 展示了如何创建一个自定义日志记录器。

## 贡献指南

欢迎贡献代码和示例！请确保遵循 [代码行为准则](CODE-OF-CONDUCT.md)，并提交符合规范的 Pull Request。

## 许可证

本项目遵循 MIT 许可证，请查看 [LICENSE](LICENSE) 文件了解更多细节。

## 资源链接
- [MQTTnet 官方文档](https://github.com/dotnet/MQTTnet)
- [.NET Foundation](https://dotnetfoundation.org)

如需进一步了解 MQTT 协议和其在 .NET 平台上的使用，请查阅官方文档和相关资源。