Foundatio.AzureServiceBus 10.7.1

为构建松散耦合的分布式应用程序的可插拔基础块。

• 缓存
• 队列
• 锁
• 消息传递
• 工作
• 文件存储
• 度量

包括 Redis、Azure、AWS、RabbitMQ、Kafka 和内存内的实现（用于开发）。

为什么是 Foundatio？

在构建几个大型云应用程序时，我们发现缺乏伟大的解决方案（这并不意味着没有解决方案）来构建可扩展的分布式应用程序，同时保持开发体验简单。以下是为什么我们构建和使用 Foundatio 的几个示例：

• 希望使用抽象接口进行构建，以便我们可以轻松更改实现。
• 希望块具有依赖注入友好性。
• 缓存：最初我们使用开源的 Redis 缓存客户端，但后来它变成了一种具有高许可成本的商业产品。不仅如此，还没有内存实现，因此每个开发者都需要设置和配置 Redis。
• 消息总线：我们最初考虑了 NServiceBus（出色的产品），但它有较高的许可费用（他们也需要赚钱），而且不友好于开源软件。我们还调查了 MassTransit（另一个出色的产品），但当时发现Azure支持不足，本地设置很痛苦（针对内存）。我们想要一个简单的消息总线，只需要在本机或云端上运行。
• 存储：我们没有找到任何现有的项目是解耦的并支持内存、文件存储或Azure Blob存储。

总结一下，如果您想要无忧的开发和测试，同时允许您的应用程序进行扩展，请使用Foundatio！

实现

• Redis - 缓存、存储、队列、消息传递、锁、指标
• Azure Storage - 存储、队列
• Azure ServiceBus - 队列、消息传递
• AWS - 存储、队列、指标
• Kafka - 消息传递
• RabbitMQ - 消息传递
• Minio - 存储
• Aliyun - 存储
• SshNet - 存储

入门（开发）

您可以通过 NuGet包管理器 安装Foundatio。如果您需要帮助，请 提交问题 或加入我们的 Discord聊天室。如果您有任何问题，我们随时都在这里帮助您！

本节仅供开发目的使用！如果您尝试使用Foundatio库，请从NuGet获取它们。

1. 您需要安装 Visual Studio Code。
2. 打开 Foundatio.sln Visual Studio解决方案文件。

使用Foundatio

下面的部分包含Foundatio可能性的一个小子集。我们建议您查看源代码以获得更多信息。如果您有任何问题或需要帮助，请告知我们！

缓存

缓存允许您以闪电般的速度存储和访问数据，节省您创建或获取数据的昂贵操作。我们提供了四种不同的缓存实现，这些实现是从ICacheClient接口派生的

1. InMemoryCacheClient：一个内存缓存客户端实现。这个缓存实现只适用于进程的生命周期。值得注意的是，内存缓存客户端可以通过MaxItems属性缓存最后X个条目。我们在Exceptionless中使用它，以仅保留最后250个解析的geoip结果。
2. HybridCacheClient：此缓存实现使用ICacheClient和InMemoryCacheClient，并使用IMessageBus在不同进程之间同步缓存。这可以通过在本地缓存中存在项时节省序列化操作和远程缓存的调用来带来巨大的性能提升。
3. RedisCacheClient：Redis缓存客户端实现。
4. RedisHybridCacheClient：这是一个实现了 HybridCacheClient 的实现，它使用 RedisCacheClient 作为 ICacheClient，并使用 RedisMessageBus 作为 IMessageBus。
5. ScopedCacheClient：此缓存实现接受一个 ICacheClient 实例和一个字符串 scope。该作用域会被添加到每个缓存键的前面。这使得管理和轻松删除所有作用域的缓存键变得非常容易。

示例

using Foundatio.Caching;

ICacheClient cache = new InMemoryCacheClient();
await cache.SetAsync("test", 1);
var value = await cache.GetAsync<int>("test");

队列

队列提供先进先出（FIFO）的消息传递。我们提供了四个来自 IQueue 接口 的不同队列实现。

1. InMemoryQueue：一个内存队列实现。此队列实现仅对进程生命周期有效。
2. RedisQueue：一个 Redis 队列实现。
3. AzureServiceBusQueue：一个 Azure 服务总线队列实现。
4. AzureStorageQueue：一个 Azure 存储队列实现。
5. SQSQueue：一个 AWS SQS 实现。

示例

using Foundatio.Queues;

IQueue<SimpleWorkItem> queue = new InMemoryQueue<SimpleWorkItem>();

await queue.EnqueueAsync(new SimpleWorkItem {
    Data = "Hello"
});

var workItem = await queue.DequeueAsync();

锁

锁确保资源在任何给定时间只被一个消费者访问。我们提供了两个来自 ILockProvider 接口 的不同锁实现。

1. CacheLockProvider：一个使用缓存进行进程间通信的锁实现。
2. ThrottlingLockProvider：一个仅允许一定数量的锁通过的锁实现。您可以使用它来限制对某些外部服务的 API 调用，并将它们在所有请求该锁的进程中限制。
3. ScopedLockProvider：此锁实现接受一个 ILockProvider 实例和一个字符串 scope。该作用域会被添加到每个锁键的前面。这使得管理和轻松释放所有作用域的锁变得非常容易。

值得注意的是，所有锁提供者都接受一个 ICacheClient。这允许您确保您的代码可以在多台机器上正确锁。

示例

using Foundatio.Lock;

ILockProvider locker = new CacheLockProvider(new InMemoryCacheClient(), new InMemoryMessageBus());
var testLock = await locker.AcquireAsync("test");
// ...
await testLock.ReleaseAsync();

ILockProvider throttledLocker = new ThrottlingLockProvider(new InMemoryCacheClient(), 1, TimeSpan.FromMinutes(1));
var throttledLock = await throttledLocker.AcquireAsync("test");
// ...
await throttledLock.ReleaseAsync();

消息传递

允许您发布和订阅应用程序中流动的消息。我们提供了四个来自 IMessageBus 接口 的不同消息总线实现。

1. InMemoryMessageBus：一个内存消息总线实现。此消息总线实现仅对进程生命周期有效。
2. RedisMessageBus：一个 Redis 消息总线实现。
3. RabbitMQMessageBus：一个 RabbitMQ 实现。
4. KafkaMessageBus：一个 Kafka 实现。
5. AzureServiceBusMessageBus：一个 Azure 服务总线实现。

示例

using Foundatio.Messaging;

IMessageBus messageBus = new InMemoryMessageBus();
await messageBus.SubscribeAsync<SimpleMessageA>(msg => {
  // Got message
});

await messageBus.PublishAsync(new SimpleMessageA { Data = "Hello" });

工作

允许您运行长期运行的过程（进程内或进程外）而不用担心它会被提前终止。我们根据您的使用场景提供三种定义作业的不同方式

1. 作业：所有作业都必须继承自IJob接口。我们还有一个您可以从之继承的基本类JobBase，它提供作业上下文和日志记录。您可以通过在作业上调用RunAsync()或者创建一个JobRunner类的实例并调用其Run方法来运行作业。JobRunner可用于轻松地将作业作为Azure Web Jobs运行。

示例

using Foundatio.Jobs;

public class HelloWorldJob : JobBase {
  public int RunCount { get; set; }

  protected override Task<JobResult> RunInternalAsync(JobContext context) {
     RunCount++;
     return Task.FromResult(JobResult.Success);
  }
}

var job = new HelloWorldJob();
await job.RunAsync(); // job.RunCount = 1;
await job.RunContinuousAsync(iterationLimit: 2); // job.RunCount = 3;
await job.RunContinuousAsync(cancellationToken: new CancellationTokenSource(10).Token); // job.RunCount > 10;

2. 队列处理作业：队列处理器作业非常适合与来自队列数据驱动的作业一起工作。队列处理器作业必须继承自QueueJobBase类。然后您可以通过在作业上调用RunAsync()或者将其传递给JobRunner类来运行作业。JobRunner可用于轻松地将作业作为Azure Web Jobs运行。

示例

using Foundatio.Jobs;

public class HelloWorldQueueJob : QueueJobBase<HelloWorldQueueItem> {
  public int RunCount { get; set; }

  public HelloWorldQueueJob(IQueue<HelloWorldQueueItem> queue) : base(queue) {}

  protected override Task<JobResult> ProcessQueueEntryAsync(QueueEntryContext<HelloWorldQueueItem> context) {
     RunCount++;

     return Task.FromResult(JobResult.Success);
  }
}

public class HelloWorldQueueItem {
  public string Message { get; set; }
}

 // Register the queue for HelloWorldQueueItem.
container.AddSingleton<IQueue<HelloWorldQueueItem>>(s => new InMemoryQueue<HelloWorldQueueItem>());

// To trigger the job we need to queue the HelloWorldWorkItem message.
// This assumes that we injected an instance of IQueue<HelloWorldWorkItem> queue

IJob job = new HelloWorldQueueJob();
await job.RunAsync(); // job.RunCount = 0; The RunCount wasn't incremented because we didn't enqueue any data.

await queue.EnqueueAsync(new HelloWorldWorkItem { Message = "Hello World" });
await job.RunAsync(); // job.RunCount = 1;

await queue.EnqueueAsync(new HelloWorldWorkItem { Message = "Hello World" });
await queue.EnqueueAsync(new HelloWorldWorkItem { Message = "Hello World" });
await job.RunUntilEmptyAsync(); // job.RunCount = 3;

3. 工作项作业：工作项作业将在与其他工作项作业一起的工作池中运行。此类型作业非常适合那些不经常发生但应在作业中处理的事情（例如：删除具有许多子实体的实体）。它将在您在message bus上发布消息时触发。作业必须继承自WorkItemHandlerBase类。然后您可以通过JobRunner类运行所有共享作业。JobRunner可用于轻松地将作业作为Azure Web Jobs运行。

示例

using System.Threading.Tasks;
using Foundatio.Jobs;

public class HelloWorldWorkItemHandler : WorkItemHandlerBase {
  public override async Task HandleItemAsync(WorkItemContext ctx) {
    var workItem = ctx.GetData<HelloWorldWorkItem>();

    // We can report the progress over the message bus easily.
    // To receive these messages just inject IMessageSubscriber
    // and Subscribe to messages of type WorkItemStatus
    await ctx.ReportProgressAsync(0, "Starting Hello World Job");
    await Task.Delay(TimeSpan.FromSeconds(2.5));
    await ctx.ReportProgressAsync(50, "Reading value");
    await Task.Delay(TimeSpan.FromSeconds(.5));
    await ctx.ReportProgressAsync(70, "Reading value");
    await Task.Delay(TimeSpan.FromSeconds(.5));
    await ctx.ReportProgressAsync(90, "Reading value.");
    await Task.Delay(TimeSpan.FromSeconds(.5));

    await ctx.ReportProgressAsync(100, workItem.Message);
  }
}

public class HelloWorldWorkItem {
  public string Message { get; set; }
}

// Register the shared job.
var handlers = new WorkItemHandlers();
handlers.Register<HelloWorldWorkItem, HelloWorldWorkItemHandler>();

// Register the handlers with dependency injection.
container.AddSingleton(handlers);

// Register the queue for WorkItemData.
container.AddSingleton<IQueue<WorkItemData>>(s => new InMemoryQueue<WorkItemData>());

// The job runner will automatically look for and run all registered WorkItemHandlers.
new JobRunner(container.GetRequiredService<WorkItemJob>(), instanceCount: 2).RunInBackground();

 // To trigger the job we need to queue the HelloWorldWorkItem message.
 // This assumes that we injected an instance of IQueue<WorkItemData> queue

 // NOTE: You may have noticed that HelloWorldWorkItem doesn't derive from WorkItemData.
 // Foundatio has an extension method that takes the model you post and serializes it to the
 // WorkItemData.Data property.
 await queue.EnqueueAsync(new HelloWorldWorkItem { Message = "Hello World" });

文件存储

我们提供了多种来自IFileStorage接口的文件存储实现

1. InMemoryFileStorage：一个内存文件实现。此文件存储实现仅在进程的生命周期内有效。
2. FolderFileStorage：一个使用硬盘存储的文件存储实现。
3. AzureFileStorage：一个Azure Blob存储实现。
4. S3FileStorage：一个AWS S3文件存储实现。
5. RedisFileStorage：一个Redis文件存储实现。
6. MinioFileStorage：一个Minio文件存储实现。
7. AliyunFileStorage：一个阿里云文件存储实现。
8. SshNetFileStorage：一个SFTP文件存储实现。

我们推荐使用所有IFileStorage实现为单例。

示例

using Foundatio.Storage;

IFileStorage storage = new InMemoryFileStorage();
await storage.SaveFileAsync("test.txt", "test");
string content = await storage.GetFileContentsAsync("test.txt")

度量

我们提供了五个来自IMetricsClient接口的实现

1. InMemoryMetricsClient：一个内存指标实现。
2. RedisMetricsClient：Redis度量实现。
3. StatsDMetricsClient：statsd度量实现。
4. MetricsNETClient：Metrics.NET实现。
5. AppMetricsClient：AppMetrics实现。
6. CloudWatchMetricsClient：AWS CloudWatch实现（AWS云监控）。

我们建议使用所有IMetricsClient实现作为单例。

示例

IMetricsClient metrics = new InMemoryMetricsClient();
metrics.Counter("c1");
metrics.Gauge("g1", 2.534);
metrics.Timer("t1", 50788);

示例应用

我们提供了演示文稿和示例应用，展示如何使用Foundatio。

感谢所有贡献者