Smart.Channel 3.0.1

Smart.Channel

基于 System.Threading.Channels 封装的轻量级生产者-消费者模式实现库，提供同步/异步 API 和依赖注入支持。

功能特性

• 无界通道：默认创建无容量限制的通道
• DI 集成：AddSmartChannel 扩展方法一键注册
• 双模式操作：同步(TryWrite/TryRead) + 异步(WriteAsync/ReadAsync)
• 单例服务：默认注册为 Singleton 生命周期
• 跨平台： 支持.NET 6/8/9

安装

bash
dotnet add package Smart.Channel

基础使用

csharp
// 初始化通道
var channel = new SmartChannelService<string>();
// 生产者写入
await channel.WriteAsync("Hello", CancellationToken.None); // 异步写入
channel.TryWrite("World"); // 同步写入
// 消费者读取
while (await channel.WaitToReadAsync(CancellationToken.None))
{
	if (channel.TryRead(out var msg)) // 同步读取
	{
		Console.WriteLine($"收到：{msg}");
	}
	var asyncMsg = await channel.ReadAsync(CancellationToken.None); // 异步读取
}

依赖注入集成

csharp
// 注册服务
services.AddSmartChannel();

// 注入使用
public class DataProcessor(SmartChannelService<EventData> channel)
{
	public async Task ProduceEvent()
	{
		await channel.WriteAsync(new EventData(), CancellationToken.None);
	}

	[HostedService]
	public async Task ConsumeEvents()
	{
		while (await channel.WaitToReadAsync())
		{
			// 消费逻辑
		}
	}
}

方法说明

最佳实践

1. Web 应用场景

csharp
public class BackgroundConsumer : IHostedService
{
	private readonly SmartChannelService<LogData> _channel;

	public BackgroundConsumer(SmartChannelService<LogData> channel) => _channel = channel;

	public async Task StartAsync()
	{
		while (await _channel.WaitToReadAsync())
		{
		  // 持久化到数据库
		}
	}
}

2. 性能优化

csharp
var channel = Channel.CreateUnbounded<T>(new UnboundedChannelOptions
{
	SingleWriter = true, // 单一写入者模式
	SingleReader = true // 单一读取者模式
});

注意事项

• 内存管理：无界通道需监控内存增长，建议生产端控制写入频率
• 同步方法：需处理 TryWrite/TryRead 的返回值（可能返回 false）
• 任务泄露：Web 请求中应传播 CancellationToken
• 阻塞操作：单例服务中建议全链路异步操作

Developed by zenglei