Snet.Log 26.166.2

<h1 align="center">Snet - 工业协议与数据采集框架</h1>

<p align="center"> <img width="120" height="120" src="https://api.shunnet.top/pic/nuget.png" alt="Snet Logo"/> </p>

<p align="center"> <b>统一 · 高效 · 灵活 · 可扩展</b> </p>

<p align="center">

<img src="https://img.shields.io/badge/.NET-8.0%20%7C%2010.0-purple.svg"/> <img src="https://img.shields.io/badge/NuGet-Available-brightgreen.svg"/> <img src="https://img.shields.io/badge/license-MIT-green"/> <img src="https://img.shields.io/badge/async-default-blue"/>

</p>

<p align="center"> 面向工业数据采集、传输、转发、消息中间件的全栈式解决方案 </p>

<p align="center">

<a href="https://shunnet.top/"><b>🚀 官网</b></a> · <a href="https://www.nuget.org/profiles/shun"><b>📚 NuGet</b></a> · <a href="https://github.com/shunnet"><b>💻 GitHub</b></a> · <a href="https://github.com/shunnet/Daq"><b>🔌 Daq 工具</b></a> <a href="https://github.com/shunnet/SKILLS"><b>📦 SKILLS</b></a>

</p>

✨ 框架特色

<table> <tr><td>⚡</td><td><b>异步优先架构</b></td><td>底层全部异步实现（<code>*Async</code> + <code>CancellationToken</code>），同步方法为 <code>.GetAwaiter().GetResult()</code> 薄封装</td></tr> <tr><td>📐</td><td><b>统一读写参数模型</b></td><td>入参出参结构统一，协议切换零改造，降低学习与迁移成本</td></tr> <tr><td>📡</td><td><b>多点转发 & 多点解析</b></td><td>单次采集可同时转发至多个 MQ 目标，支持 <code>AddressParseParam</code> 反射解析二次加工</td></tr> <tr><td>⚡</td><td><b>即插即用</b></td><td>NuGet 安装即用，最少 3 行代码启动一条采集链路</td></tr> <tr><td>🎭</td><td><b>虚拟点位 & 模拟库</b></td><td>内置 5 种虚拟地址类型与 Sim 模拟协议，无需真实设备即可开发调试</td></tr> <tr><td>🔔</td><td><b>全协议异步订阅</b></td><td>所有采集协议支持订阅式数据推送，<code>SubscribeOperate</code> 异步轮询（<code>await Task.Delay</code>）</td></tr> <tr><td>🧬</td><td><b>采集 & 转发接口统一</b></td><td><code>IDaq</code> / <code>IMq</code> / <code>ICommunication</code> 统一抽象，采集与转发共享同一套 API 范式</td></tr> <tr><td>🎯</td><td><b>双通道事件体系</b></td><td>同步（<code>OnDataEvent</code>）+ 异步（<code>OnDataEventAsync</code>）事件双通道，<code>EventingWrapperAsync<T></code> 顺序执行</td></tr> <tr><td>🌐</td><td><b>内置 WebAPI 控制</b></td><td>每个采集协议自带 HTTP API（<code>/api/on</code>、<code>/api/read</code>、<code>/api/write</code> 等 6 个端点），远程控制开关、读写、状态查询</td></tr> <tr><td>🧩</td><td><b>极简二次开发</b></td><td>继承 <code>DaqAbstract</code> / <code>MqAbstract</code> 实现 8 个抽象异步方法即可扩展新协议</td></tr> <tr><td>📝</td><td><b>高可定制日志</b></td><td>6 级日志（Verbose → Fatal），自定义路径、数据库输出、控制台开关</td></tr> <tr><td>🌍</td><td><b>中英文实时切换</b></td><td>全局多语言支持，运行时热切换，<code>OnLanguageEvent</code> 事件驱动自动刷新</td></tr> <tr><td>🔧</td><td><b>丰富内置能力</b></td><td>反射解析 · 进程缓存 · 共享内存缓存 · Channel 通道 · 字节自动转换 · 单例工厂</td></tr> <tr><td>📦</td><td><b>多格式序列化</b></td><td>JSON / XML / Protobuf 等一站式序列化与反序列化支持</td></tr> <tr><td>🏎️</td><td><b>高性能内核</b></td><td>无 GC.Collect 阻塞 · O(1) 字典查找 · Channel 背压控制 · 零分配热路径</td></tr> </table>

🧩 核心组件

📡 采集协议（30+ NuGet 包）

NuGet 包（独立项目，可单独安装）

接口定义

/// <summary>
/// 数采接口（聚合 14 个基础接口，含同步 + 异步方法）
/// </summary>
public interface IDaq : IOn, IOff, IRead, IWrite, ISubscribe, IGetStatus, IEvent,
    IGetParam, ICreateInstance, ILog, IWA, IGetObject, ILanguage,
    IDisposable, IAsyncDisposable { }

异步方法： OnAsync / OffAsync / ReadAsync / WriteAsync / SubscribeAsync / UnSubscribeAsync / GetStatusAsync / GetBaseObjectAsync — 所有方法均接受 CancellationToken token = default

📬 消息中间件协议

支持 5 种高性能消息中间件：

接口定义

/// <summary>
/// 消息中间件接口（异步优先）
/// </summary>
public interface IMq : IOn, IOff, IProducer, IConsumer, IGetStatus, IEvent,
    IGetParam, ICreateInstance, ILog, ILanguage, IDisposable, IAsyncDisposable { }

异步方法： OnAsync / OffAsync / ProduceAsync / ConsumeAsync / UnConsumeAsync

🖥️ 协议服务端 (数据模拟)

⚡ 实例创建方式

支持 无参、有参、单例、接口化实例 等多种方式，快速上手：

// 实例创建的几种方式（以 OPC UA 采集协议为例）
using Snet.Model.@interface;
using Snet.Opc.ua.client;

OpcUaClientOperate? operate = null;
IDaq? daq = null;

// 无参实例
operate = new OpcUaClientOperate();
// 无参实例调函数创建实例
operate = new OpcUaClientOperate()
    .CreateInstance(new OpcUaClientData.Basics())
    .GetSource<OpcUaClientOperate>();
// 有参实例
operate = new OpcUaClientOperate(new OpcUaClientData.Basics());
// 有参单例
operate = OpcUaClientOperate.Instance(new OpcUaClientData.Basics());
// 接口 - 有参实例
daq = new OpcUaClientOperate(new OpcUaClientData.Basics());
// 接口 - 有参单例
daq = OpcUaClientOperate.Instance(new OpcUaClientData.Basics());

// 使用 async/await（推荐）
await using (operate)
{
    await operate.OnAsync();
    // ... 采集操作 ...
    await operate.OffAsync();
}

📥 采集应用示例（异步）

// 采集协议 — OPC UA（异步）
using System.Collections.Concurrent;
using Snet.Log;
using Snet.Model.data;
using Snet.Model.@enum;
using Snet.Opc.ua.client;
using Snet.Utility;

// .NET 顶级语句直接支持 await
var basics = new OpcUaClientData.Basics
{
    ServerUrl = "opc.tcp://127.0.0.1:6688",
    UserName = "user",
    Password = "password",
};

await using var operate = new OpcUaClientOperate(basics);

// 点位地址
Address address = new Address
{
    SN = Guid.NewGuid().ToString(),
    CreationTime = DateTime.Now,
    AddressArray = new List<AddressDetails>
    {
        new AddressDetails
        {
            SN = "机台1",                                     // 唯一标识符（机台号/组名/车间/厂）
            AddressName = "ns=2;s=MyVariable",                // 实际地址 [ 不能为空 ]
            AddressDataType = DataType.Float,                 // 数据类型
            AddressAnotherName = "温度",                      // 地址别名
            AddressDescribe = "产线1温度传感器",              // 地址描述
            AddressType = AddressType.Reality,                // 地址类型
            IsEnable = true,                                  // 是否启用
            AddressMqParam = new AddressMq                    // 消息队列自动转发
            {
                ISns = new List<string> { "Snet.Mqtt.client.MqttClientOperate.my-mqtt" },
                Topic = "factory/temperature",
                ContentFormat = "温度 = {0}"
            },
            AddressParseParam = new AddressParse               // 反射解析（二次加工）
            {
                ReflectionParam = new object[]
                {
                    new ReflectionData.Basics { /* 反射解析配置 */ },
                    "MyParseMethodSN"
                }
            },
        }
    }
};

#region 打开
OperateResult result = await operate.OnAsync();
LogHelper.Info(result.ToJson(true));
#endregion

#region 读取
result = await operate.ReadAsync(address);
if (result.GetDetails<ConcurrentDictionary<string, AddressValue>>(out var data))
{
    foreach (var kv in data)
    {
        if (kv.Value.Quality == QualityType.Normal)
            LogHelper.Info($"{kv.Key} = {kv.Value.ResultValue}");
    }
}
#endregion

#region 订阅
// 异步信息事件
operate.OnInfoEventAsync += async (sender, e) =>
{
    if (!e.Status)
        LogHelper.Warning($"告警: {e.Message}");
    await Task.CompletedTask;
};

// 异步数据事件
operate.OnDataEventAsync += async (sender, e) =>
{
    if (!e.Status) return;
    var d = e.GetSource<ConcurrentDictionary<string, AddressValue>>();
    if (d == null) return;

    // 精简版数据（轻量传输，Protobuf 兼容）
    var simplifies = d.GetSimplifyArray();

    // 异步处理（写数据库/HTTP 转发等）
    await ProcessDataAsync(simplifies);
};

result = await operate.SubscribeAsync(address);
LogHelper.Info($"订阅已启动: {(result.Status ? "成功" : result.Message)}");
#endregion

#region 写入
var values = new ConcurrentDictionary<string, object>
{
    ["ns=2;s=TargetValue"] = (float)25.6,
    ["ns=2;s=Enable"] = true
};
result = await operate.WriteAsync(values);
LogHelper.Info(result.ToJson(true));
#endregion

#region 获取状态
result = await operate.GetStatusAsync();
LogHelper.Info($"连接状态: {(result.Status ? "已连接" : "未连接")}");
#endregion

#region 获取参数
result = operate.GetParam();
LogHelper.Info(result.GetSource<ParamModel>().ToJson(true));
#endregion

#region 关闭
await operate.OffAsync();
#endregion

🔄 MQ 应用示例（异步）

// MQ 协议 — MQTT（异步）
using Snet.Log;
using Snet.Model.data;
using Snet.Model.@enum;
using Snet.Mqtt.client;
using Snet.Utility;

var basics = new MqttClientData.Basics
{
    SN = "my-mqtt",                     // 重要：用于 ISns 匹配
    IpAddress = "127.0.0.1",           // ← 属性名是 IpAddress，不是 Ip！
    Port = 1883,                        // 库默认 6688，需显式指定标准端口
    UserName = "user",
    Password = "password",
    ClientID = null,                    // null 则自动生成随机 ID
    QualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce,
    ResponseType = ResponseType.Content,
};

await using var operate = new MqttClientOperate(basics);

#region 打开
OperateResult result = await operate.OnAsync();
LogHelper.Info($"连接 MQTT: {(result.Status ? "成功" : result.Message)}");
#endregion

#region 生产
result = await operate.ProduceAsync("topic/hello", "hello world");
LogHelper.Info(result.ToJson(true));
#endregion

#region 消费
// 异步信息事件
operate.OnInfoEventAsync += async (sender, e) =>
{
    if (!e.Status)
        LogHelper.Warning($"MQTT 异常: {e.Message}");
    await Task.CompletedTask;
};

// 异步数据事件
operate.OnDataEventAsync += async (sender, e) =>
{
    if (!e.Status) return;

    // 根据 ResponseType 判断数据类型
    switch (basics.ResponseType)
    {
        case ResponseType.Bytes:
            byte[] bytes = e.GetSource<byte[]>();
            break;
        case ResponseType.Content:
            string str = e.GetSource<string>();
            break;
        case ResponseType.ContentWithTopic:
            ResponseModel rm = e.GetSource<ResponseModel>();
            // rm.Topic = 主题, rm.Content = 内容
            break;
    }
};

result = await operate.ConsumeAsync("topic/hello");
LogHelper.Info($"订阅: {(result.Status ? "成功" : result.Message)}");
#endregion

#region 关闭 & 状态
result = await operate.GetStatusAsync();
LogHelper.Info($"状态: {(result.Status ? "已连接" : "未连接")}");

await operate.OffAsync();
#endregion

⚙️ 常用操作类名

🤖 AI 辅助开发

本项目提供 Claude Code 技能集，支持自然语言生成采集代码和插件：

📂 技能文件位于 SKILLS

🌍 相关链接

📜 许可证

本项目基于 MIT 开源。请阅读 LICENSE 获取完整条款。 ⚠️ 软件按 "原样" 提供，作者不对使用后果承担责任。

🌍 查阅

👉 点击跳转