Rystem.RepositoryFramework allows you to use correctly concepts like repository pattern, CQRS and DDD. You have interfaces for your domains, auto-generated api, auto-generated HttpClient to simplify connection "api to front-end", a functionality for auto-population in memory of your models, a functionality to simulate exceptions and waiting time from external sources to improve your implementation/business test and load test.
Get Started
$ dotnet add package Rystem.RepositoryFramework.AbstractionsReadme
Interfaces
Based on CQRS we could split our repository pattern in two main interfaces, one for update (write, delete) and one for read.
Command (Write-Delete)
public interface ICommand<T, TKey> : ICommandPattern
where TKey : notnull
{
Task<bool> InsertAsync(TKey key, T value, CancellationToken cancellationToken = default);
Task<bool> UpdateAsync(TKey key, T value, CancellationToken cancellationToken = default);
Task<bool> DeleteAsync(TKey key, CancellationToken cancellationToken = default);
}
Query (Read)
public interface IQuery<T, TKey> : IQueryPattern
where TKey : notnull
{
Task<T?> GetAsync(TKey key, CancellationToken cancellationToken = default);
Task<IEnumerable<T>> QueryAsync(Expression<Func<T, bool>>? predicate = null, int? top = null, int? skip = null, CancellationToken cancellationToken = default);
}
Repository Pattern (Write-Delete-Read)
Repository pattern is a sum of CQRS interfaces.
public interface IRepository<T, TKey> : ICommand<T, TKey>, IQuery<T, TKey>, IRepositoryPattern, ICommandPattern, IQueryPattern
where TKey : notnull
{
}
Examples
Model
public class User
{
public string Id { get; set; }
public string Name { get; set; }
public string Email { get; set; }
}
Command
public class UserWriter : ICommand<User, string>
{
public Task<bool> DeleteAsync(string key, CancellationToken cancellationToken = default)
{
//delete on with DB or storage context
throw new NotImplementedException();
}
public Task<bool> InsertAsync(string key, User value, CancellationToken cancellationToken = default)
{
//insert on DB or storage context
throw new NotImplementedException();
}
public Task<bool> UpdateAsync(string key, User value, CancellationToken cancellationToken = default)
{
//update on DB or storage context
throw new NotImplementedException();
}
}
Query
public class UserReader : IQuery<User, string>
{
public Task<User?> GetAsync(string key, CancellationToken cancellationToken = default)
{
//get an item by key from DB or storage context
throw new NotImplementedException();
}
public Task<IEnumerable<User>> QueryAsync(Expression<Func<User, bool>>? predicate = null, int? top = null, int? skip = null, CancellationToken cancellationToken = default)
{
//get a list of items by a predicate with top and skip from DB or storage context
throw new NotImplementedException();
}
}