Foundatio.MetricsNET 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 Service Bus Queue实现。
4. AzureStorageQueue：Azure Storage Queue实现。
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作业运行。

示例

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作业运行。

示例

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作业运行。

示例

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的幻灯片和示例应用，展示了如何使用Foundatio。

感谢所有贡献者