EasyCaching.Extensions.EasyCompressor 2.0.2

dotnet add package EasyCaching.Extensions.EasyCompressor --version 2.0.2
NuGet\Install-Package EasyCaching.Extensions.EasyCompressor -Version 2.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="EasyCaching.Extensions.EasyCompressor" Version="2.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EasyCaching.Extensions.EasyCompressor --version 2.0.2
#r "nuget: EasyCaching.Extensions.EasyCompressor, 2.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install EasyCaching.Extensions.EasyCompressor as a Cake Addin
#addin nuget:?package=EasyCaching.Extensions.EasyCompressor&version=2.0.2

// Install EasyCaching.Extensions.EasyCompressor as a Cake Tool
#tool nuget:?package=EasyCaching.Extensions.EasyCompressor&version=2.0.2

NuGet Badge License: MIT Build Status

EasyCaching.Extensions.EasyCompressor

<img src="/src/EasyCompressor.png" width="100" height="100" align="left"/>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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on EasyCaching.Extensions.EasyCompressor:

Package Downloads
SmartCacheManager

SmartCacheManager is a smart caching module to cache objects with resilient and variable expiration timing that is useful for caching result of web services.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.2 28,580 2/8/2024
2.0.1 94 2/8/2024
2.0.0 93 2/8/2024
1.4.0 180,722 3/20/2021
1.3.0 3,757 11/15/2020
1.2.4 710 9/12/2020
1.2.3 479 7/22/2020
1.2.2 653 6/8/2020
1.2.1 441 4/18/2020
1.2.0 450 4/15/2020