EasyCaching.Extensions.EasyCompressor 2.1.0 (original) (raw)

A nice integration between EasyCaching and EasyCompressor.

This library aids in Improving Performance by Reducing Memory Usage and Bandwidth Usage by compressing your cache data, especially for distributed cache (such as Redis).

EasyCaching is an Easy-to-Use caching library that offers many features and supports many providers and serializers.

EasyCompressor is an Easy-to-Use and Optimized compression library for .NET that unified several compression algorithms including LZ4, Snappy, Zstd, LZMA, Brotli, GZip, ZLib, and Deflate.

How to use

1. Install Package

PM> Install-Package EasyCaching.Extensions.EasyCompressor
PM> Install-Package EasyCompressor.LZ4

PM> # Install-Package EasyCompressor.Snappier
PM> # Install-Package EasyCompressor.ZstdSharp
PM> # Install-Package EasyCompressor (for Brotli, GZip, Deflate, ZLib)

2. Add Services

Basic Using

Just add your desired compressor and use the WithCompressor() method just after the serializer.

services.AddLZ4Compressor();

services.AddEasyCaching(options =>
{
    options.UseRedis(config =>
    {
        config.DBConfig.Endpoints.Add(new ServerEndPoint("127.0.0.1", 6379));
        config.SerializerName = "msgpack";
    })
    .WithMessagePack("msgpack")
    .WithCompressor();
});

Using a specific Compressor for each Serializer.

It assigns lz4 compressor to msgpack serializer and snappier compressor to protobuf serializer.

services.AddLZ4Compressor("lz4");
services.AddSnappierCompressor("snappier");

services.AddEasyCaching(options =>
{
    options.UseRedis(config =>
    {
        config.DBConfig.Endpoints.Add(new ServerEndPoint("127.0.0.1", 6379));
        config.SerializerName = "msgpack";
    }, "redis1")
    .WithMessagePack("msgpack")
    .WithCompressor("msgpack", "lz4");

    options.UseRedis(config =>
    {
        config.DBConfig.Endpoints.Add(new ServerEndPoint("127.0.0.1", 6379));
        config.SerializerName = "protobuf";
    }, "redis2")
    .WithProtobuf("protobuf")
    .WithCompressor("protobuf", "snappier");
});

Benchmarks

You can see the benchmark of compressors here.

Contributing

Create an issue or discussion if you found a BUG or have a Suggestion or Question.

Or if you want to develop this project:

1. Fork it
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request

Give a Star! ⭐️

If you find this repository useful and like it, why not give it a star? if not, never mind! 😃

License

Copyright © 2020 Mohammad Javad Ebrahimi under the MIT License.