ABP Caching Playground with .NET Aspire

This repository demonstrates various caching strategies using ABP Framework with .NET Aspire integration. It includes examples of both Redis and Fusion caching implementations in a distributed environment.

Todo

• Setup basics
• Data seeding
• Can we get caching metrics in aspire?
• Add grafana, influxdb and k6 hosting
• Make sure we're doing sensible caching of products
• Get fusion cache example working

Prerequisites

• .NET 9.0 SDK or later
• Node.js v18 or v20
• Redis (for distributed caching)
• Docker (optional, for containerized development)

Solution Structure

The solution is organized into several projects:

Aspire Projects

• AbpCachingPlayground.FusionCacheAppHost - Aspire host for Fusion Cache implementation
• AbpCachingPlayground.RedisCacheAppHost - Aspire host for Redis Cache implementation
• AbpCachingPlayground.ServiceDefaults - Shared service configurations

Core Projects

• AbpCachingPlayground.Domain - Domain layer
• AbpCachingPlayground.Domain.Shared - Shared domain layer
• AbpCachingPlayground.Application.Contracts - Application contracts
• AbpCachingPlayground.Application - Application layer
• AbpCachingPlayground.EntityFrameworkCore - EF Core integration
• AbpCachingPlayground.HttpApi - HTTP API layer
• AbpCachingPlayground.HttpApi.Client - HTTP API client

Web Applications

• AbpCachingPlayground.AuthServer - Authentication server
• AbpCachingPlayground.HttpApi.Host - API host
• AbpCachingPlayground.Web - Web application

Utility Projects

• AbpCachingPlayground.DbMigrator - Database migration tool
• AbpCachingPlayground.TestBase - Testing infrastructure

Getting Started

1. Clone the repository

git clone [your-repository-url]
cd AbpCachingPlayground

2. Install ABP CLI if you haven't already

dotnet tool install -g Volo.Abp.Cli

3. Install client-side dependencies

abp install-libs

5. Start the application using Aspire

cd aspire/AbpCachingPlayground.RedisCacheAppHost # or FusionCacheAppHost
dotnet run

Caching Implementations

Redis Cache

The Redis implementation demonstrates distributed caching using Redis as the backing store. Key features include:

• Distributed cache implementation
• Cache invalidation strategies
• Cache-aside pattern examples

Fusion Cache

The Fusion implementation showcases memory caching with additional features:

• In-memory caching
• Double-checked locking pattern
• Cache eviction policies

Development Notes

• The solution uses .NET Aspire for orchestrating the microservices architecture
• Both Redis and Fusion cache implementations are available for comparison
• The ServiceDefaults project contains shared configuration that's applied across all services
• Test projects are available under the test directory for each implementation

Configuration

Redis Configuration

Update the Redis connection string in appsettings.json:

{
  "Redis": {
    "Configuration": "localhost:6379"
  }
}

Cache Settings

Cache settings can be modified in the respective host projects:

{
  "Cache": {
    "DefaultExpirationTime": "00:30:00"
  }
}

Testing

Run the tests using:

dotnet test

The test projects include:

• Unit tests
• Integration tests
• Cache implementation tests

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

Additional Resources

• ABP Framework Documentation
• .NET Aspire Documentation
• Redis Documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.