nebula-software-systems / nebula.caching

Make your dotnet core apps shine by using caching without cluttering your projects.

Nebula.Caching

Make use of caching without any hassle.

About

Nebula.Caching is an Open-Source caching library that allows you to use caching in your projects with minimal configuration.

As of today, we support caching using Redis, InMemory and Memcached, but in the future we hope to support your favourite caching provider!

Nuget Package

Name	Released Package
NebulaCaching.Redis
NebulaCaching.InMemory
NebulaCaching.Memcached

Usage

Step 1 : Install one of the available packages

Install the package via Package Manager:

Install-Package NebulaCaching.Redis
Install-Package NebulaCaching.InMemory
Install-Package NebulaCaching.Memcached

or

Via .NET CLI:

dotnet add package NebulaCaching.Redis
dotnet add package NebulaCaching.InMemory
dotnet add package NebulaCaching.Memcached

Step 2 : Register cache usage in the Program class (will change depending on which caching provider you are using, please refer to the package documentation)

public class Program
{
    public static void Main(string[] args)
    {
      // ...

      builder.Host.UseNebulaCaching();
      builder.Services.AddRedisChache(new RedisConfigurations
      {
        //some amazing configuration options which can be see in the samples or documentation section
      });
    }
}

Step 3 : Use the caching attribute in your interface definitions (will change depending on which caching provider you are using, please refer to the package documentation)

    public interface IRedisStuff
    {
        [RedisCache(CacheDurationInSeconds = 120)]
        List<SomeObject> SomeMethod(int param1, int param2);
    }

Documentation

Our documentation can be found here.

Samples

Some useful code snippets can be found here.

Roadmap

To check what we want to achieve in the future, please refer to our ROADMAP.

Contributing

This project welcomes and appreciates any contributions made.

There are several ways you can contribute, namely:

• Report any bug found.
• Suggest some features or improvements.
• Creating pull requests.

License

Nebula.Caching is a free and open-source software licensed under the MIT License.

See LICENSE for more details.

nebula.caching's Issues

Nice project. But my humble opinion is that the architecture of the project is a bit wrong.

Hi. I just saw your document on dev.to. I think it's a nice project. I hope it gets where you want it to go. However, in my humble opinion, the architecture of the project is a bit off. Currently, your project doesn't have any solution file and is a single project only built on Redis. You need to create a solution and split your project into several different ones.

For example, initially, you need two projects: Nebula.Caching.Core and Nebula.Caching.RedisCache:

Nebula.Caching.Core: This is a core project where you have all of your interfaces and all caching system-independent DTOs. And the core mechanics.
Nebula.Caching.RedisCache: This is a project that contains all things related to Redis. Caching, key generations, etc. It has Nebula.Caching.Core reference and all necessary implementations of the interfaces that you defined in the core project.
So your core code will work independently of caching over interfaces.
Then you can release Nebula.Caching.RedisCache nuget package and users can use your library with redis.

After that, when you want to implement more libraries, caching systems you can easily implement them in your system by adding another project to your solution. The new caching systems will also just implement the caching stuff and all necessary interfaces comes from core project and your code will work with the new caching system.
For example:

After that, users who want to use Redis can use the system by adding the Nebula.Caching.RedisCache NuGet package to their projects, and users who want to use in-memory cache can use the system by adding the Nebula.Caching.InMemory NuGet package to their projects.