Foundatio.Extensions.Hosting 10.7.1

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

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

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

为何选择Foundatio?

在构建几个大型云应用时，我们发现缺乏优秀的解决方案（这并不是说没有），而对于构建可扩展的分布式应用中的许多关键部件同时保持开发体验简单，我们感到一种缺失。以下是我们构建并使用Foundatio的几个原因的例子

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

总结来说，如果您想要无痛苦的开发和测试，同时使您的应用程序可扩展，请使用Foundatio！

实现

• Redis - 缓存、存储、队列、消息、锁、指标
• Azure存储 - 存储、队列
• Azure ServiceBus - 队列、消息
• AWS - 存储、队列、指标
• Kafka - 消息
• RabbitMQ - 消息
• Minio - 存储
• 阿里云 - 存储
• SshNet - 存储

入门（开发）

Foundatio可以通过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服务总线实现。

示例

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类中创建实例并调用其中的一种运行方法来运行任务。JobRunner可用于轻松地将任务作为Azure Web Job运行。

示例

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 Job运行。

示例

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 Job运行。

示例

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的幻灯片和一个示例应用程序。

感谢所有做出贡献的人