Foundatio 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：一个使用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类的实例并调用其中的一个运行方法来运行作业。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. 工作项目工作：工作项目工作将在作业池中与其他工作项目作业一起运行。此类工作非常适合那些不经常发生但应包含在作业中的事情（例如：删除有多个子实体的实体）。当你在消息总线上发布消息时，它将触发生成。该作业必须从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 实现参考Metrics.NET。
5. AppMetricsClient：AppMetrics 实现参考AppMetrics。
6. CloudWatchMetricsClient：AWS CloudWatch 实现参考AWS CloudWatch。

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

示例

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

示例应用

我们提供幻灯片以及展示如何使用 Foundatio 的示例应用。

感谢所有这些做出贡献的人们