Skip to main content

C# : Cached Repository Pattern implementation

 


In modern software development, efficient data access is crucial for maintaining application performance. One way to improve data access performance is by implementing caching mechanisms. In this blog post, we'll explore how to implement the Cached Repository Pattern in C#, a design pattern that combines the benefits of a repository pattern with caching to optimize data access.

What is the Cached Repository Pattern? The Cached Repository Pattern is an architectural pattern that combines the Repository Pattern with caching mechanisms to improve data access performance. It provides a layer of abstraction over data access operations while transparently caching data retrieved from the underlying data source.

Step-by-Step Implementation:

Step 1: Define Repository Interface First, we define an interface that serves as the contract for interacting with the data source. This interface includes methods for common data access operations such as fetching all entities, fetching an entity by ID, adding, updating, and deleting entities.

public interface IDataRepository<T>
{
    IEnumerable<T> GetAll();
    T GetById(int id);
    void Add(T entity);
    void Update(T entity);
    void Delete(int id);
}

Step 2: Implement Concrete Repository Next, we implement a concrete repository class that fulfills the contract defined by the repository interface. This class interacts directly with the underlying data source, such as a database, to perform data access operations.

public class DataRepository<T> : IDataRepository<T>
{
    private readonly DbContext _dbContext;
    private readonly DbSet<T> _dbSet;

    public DataRepository(DbContext dbContext)
    {
        _dbContext = dbContext;
        _dbSet = _dbContext.Set<T>();
    }

    public IEnumerable<T> GetAll()
    {
        return _dbSet.ToList();
    }

    public T GetById(int id)
    {
        return _dbSet.Find(id);
    }

    public void Add(T entity)
    {
        _dbSet.Add(entity);
        _dbContext.SaveChanges();
    }

    public void Update(T entity)
    {
        _dbSet.Update(entity);
        _dbContext.SaveChanges();
    }

    public void Delete(int id)
    {
        var entity = GetById(id);
        if (entity != null)
        {
            _dbSet.Remove(entity);
            _dbContext.SaveChanges();
        }
    }
}

Step 3: Implement Cached Repository Now, we create a cached repository class that wraps the original repository. This cached repository adds caching functionality to the data access operations, transparently caching data retrieved from the underlying data source for improved performance.

public class CachedDataRepository<T> : IDataRepository<T>
{
    private readonly IDataRepository<T> _innerRepository;
    private IEnumerable<T> _cache;

    public CachedDataRepository(IDataRepository<T> innerRepository)
    {
        _innerRepository = innerRepository;
        RefreshCache();
    }

    public IEnumerable<T> GetAll()
    {
        return _cache;
    }

    public T GetById(int id)
    {
        return _cache.FirstOrDefault(item => GetId(item) == id);
    }

    public void Add(T entity)
    {
        _innerRepository.Add(entity);
        RefreshCache();
    }

    public void Update(T entity)
    {
        _innerRepository.Update(entity);
        RefreshCache();
    }

    public void Delete(int id)
    {
        _innerRepository.Delete(id);
        RefreshCache();
    }

    private void RefreshCache()
    {
        _cache = _innerRepository.GetAll();
    }

    private int GetId(T entity)
    {
        // Implement logic to get the ID of the entity
        // For example, if the entity is an object with an "Id" property:
        // return entity.Id;
    }
}

Step 4: Usage Finally, we demonstrate how to use the cached repository in our application to interact with the data source. We instantiate the repository with the appropriate dependencies and utilize its methods to fetch, add, update, and delete entities.

// Usage example
var dbContext = new YourDbContext();
var repository = new DataRepository<YourEntity>(dbContext);
var cachedRepository = new CachedDataRepository<YourEntity>(repository);

// Use the cached repository to fetch data
var data = cachedRepository.GetAll();

Conclusion: The Cached Repository Pattern is a powerful technique for optimizing data access performance in C# applications. By combining the benefits of the Repository Pattern with caching mechanisms, developers can achieve significant improvements in application responsiveness and efficiency. Consider employing this pattern in your next C# project to enhance data access performance and provide a better user experience.


Comments

Popular posts from this blog

Implementing and Integrating RabbitMQ in .NET Core Application: Shopping Cart and Order API

RabbitMQ is a robust message broker that enables communication between services in a decoupled, reliable manner. In this guide, we’ll implement RabbitMQ in a .NET Core application to connect two microservices: Shopping Cart API (Producer) and Order API (Consumer). 1. Prerequisites Install RabbitMQ locally or on a server. Default Management UI: http://localhost:15672 Default Credentials: guest/guest Install the RabbitMQ.Client package for .NET: dotnet add package RabbitMQ.Client 2. Architecture Overview Shopping Cart API (Producer): Sends a message when a user places an order. RabbitMQ : Acts as the broker to hold the message. Order API (Consumer): Receives the message and processes the order. 3. RabbitMQ Producer: Shopping Cart API Step 1: Install RabbitMQ.Client Ensure the RabbitMQ client library is installed: dotnet add package RabbitMQ.Client Step 2: Create the Producer Service Add a RabbitMQProducer class to send messages. RabbitMQProducer.cs : using RabbitMQ.Client; usin...

How Does My .NET Core Application Build Once and Run Everywhere?

One of the most powerful features of .NET Core is its cross-platform nature. Unlike the traditional .NET Framework, which was limited to Windows, .NET Core allows you to build your application once and run it on Windows , Linux , or macOS . This makes it an excellent choice for modern, scalable, and portable applications. In this blog, we’ll explore how .NET Core achieves this, the underlying architecture, and how you can leverage it to make your applications truly cross-platform. Key Features of .NET Core for Cross-Platform Development Platform Independence : .NET Core Runtime is available for multiple platforms (Windows, Linux, macOS). Applications can run seamlessly without platform-specific adjustments. Build Once, Run Anywhere : Compile your code once and deploy it on any OS with minimal effort. Self-Contained Deployment : .NET Core apps can include the runtime in the deployment package, making them independent of the host system's installed runtime. Standardized Libraries ...

Clean Architecture: What It Is and How It Differs from Microservices

In the tech world, buzzwords like   Clean Architecture   and   Microservices   often dominate discussions about building scalable, maintainable applications. But what exactly is Clean Architecture? How does it compare to Microservices? And most importantly, is it more efficient? Let’s break it all down, from understanding the core principles of Clean Architecture to comparing it with Microservices. By the end of this blog, you’ll know when to use each and why Clean Architecture might just be the silent hero your projects need. What is Clean Architecture? Clean Architecture  is a design paradigm introduced by Robert C. Martin (Uncle Bob) in his book  Clean Architecture: A Craftsman’s Guide to Software Structure and Design . It’s an evolution of layered architecture, focusing on organizing code in a way that makes it  flexible ,  testable , and  easy to maintain . Core Principles of Clean Architecture Dependency Inversion : High-level modules s...