Foundatio.AzureStorage 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 - 存储
• 阿里云 - 存储
• SshNet - 存储

入门（开发）

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

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

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

使用Foundatio

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

缓存

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

1. InMemoryCacheClient：一个内存缓存客户端实现。这种缓存实现仅对于进程的生命周期是有效的。值得注意的是，内存缓存客户端具有通过MaxItems属性缓存最后X个项的能力。我们在Exceptionless中使用了它，以保证只能保留最后250个解析的GeoIP结果。
2. HybridCacheClient：此缓存实现同时使用一个ICacheClient和InMemoryCacheClient，并使用一个IMessageBus来保持进程间缓存的同步。如果在本地缓存中找到该项，这将带来巨大的性能提升，因为您将省略序列化和调用远程缓存的步骤。
3. RedisCacheClient：一个Redis缓存客户端实现。
4. RedisHybridCacheClient：一个使用RedisCacheClient作为ICacheClient和RedisMessageBus作为IMessageBus的HybridCacheClient实现。
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 Service Bus队列实现。
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 Service Bus实现。

示例

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<T>类。然后，您可以通过在作业上调用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. 工作项工作负载：工作项工作负载将在工作项池中与其他工作项工作负载一起运行。此类作业非常适合那些不经常发生但应包含在工作负载中的事情（例如：删除具有许多子项的实体）。当您在消息总线上发布消息时，它会被触发。此作业必须继承自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实现。

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

示例

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

样本应用

我们有演示如何使用 Foundatio 的演示文稿和示例应用。

感谢所有贡献者