An open API service indexing awesome lists of open source software.

https://github.com/AoxeTech/Aoxe.Redis

Redis wrappers by StackExchange.Redis
https://github.com/AoxeTech/Aoxe.Redis

Last synced: about 1 year ago
JSON representation

Redis wrappers by StackExchange.Redis

Awesome Lists containing this project

README

          

# Aoxe.Redis

[Redis](https://github.com/antirez/redis) is an in-memory database that persists on disk. The data model is key-value, but many different kind of values are supported: Strings, Lists, Sets, Sorted Sets, Hashes, HyperLogLogs, Bitmaps. [http://redis.io](http://redis.io)

## Introduction

This redis client wrappers and serializers.

## QuickStart

### NuGet

```CLI
Install-Package Aoxe.StackExchangeRedis
Install-Package Aoxe.NewtonsoftJson
```

### Build Project

Create an asp.net core project and import references in startup.cs. Get [Aoxe.StackExchangeRedis](https://github.com/AoxeTech/Aoxe.Redis/tree/master/src/Aoxe.StackExchangeRedis/Aoxe.StackExchangeRedis) and [Aoxe.NewtonsoftJson](https://github.com/AoxeTech/Aoxe.Serialization/tree/master/src/Aoxe.NewtonsoftJson) from Nuget,otherwise we have other serializers:

[Aoxe.Binary](https://github.com/AoxeTech/Aoxe.Serialization/tree/master/src/Aoxe.Binary)

[Aoxe.Jil](https://github.com/AoxeTech/Aoxe.Serialization/tree/master/src/Aoxe.Jil)

[Aoxe.MsgPack](https://github.com/AoxeTech/Aoxe.Serialization/tree/master/src/Aoxe.MsgPack)

[Aoxe.Protobuf](https://github.com/AoxeTech/Aoxe.Serialization/tree/master/src/Aoxe.Protobuf)

[Aoxe.SystemTextJson](https://github.com/AoxeTech/Aoxe.Serialization/tree/master/src/Aoxe.SystemTextJson)

[Aoxe.Utf8Json](https://github.com/AoxeTech/Aoxe.Serialization/tree/master/src/Aoxe.Utf8Json)

[Aoxe.Xml](https://github.com/AoxeTech/Aoxe.Serialization/tree/master/src/Aoxe.Xml)

[Aoxe.ZeroFormatter](https://github.com/AoxeTech/Aoxe.Serialization/tree/master/src/Aoxe.ZeroFormatter)

```CSharp
using Aoxe.StackExchangeRedis;
using Aoxe.StackExchangeRedis.Abstractions;
using Aoxe.NewtonsoftJson;
```

Register AoxeRedisClient in Configuration like

```CSharp
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
services.AddSingleton(p =>
new AoxeRedisClient(new AoxeStackExchangeRedisOptions
{
ConnectionString = "192.168.78.140:6379,abortConnect=false,syncTimeout=3000"),
DefaultExpiry = TimeSpan.FromMinutes(10),
Serializer = new AoxeSerializer()
});
}
```

Add a TestClass for the demo

```CSharp
public class TestModel
{
public Guid Id { get; set; }

public string Name { get; set; }

public int Age { get; set; }

public DateTime CreateTime { get; set; }
}
```

Create a controller like this

```CSharp
[Route("api/[controller]/[action]")]
[ApiController]
public class RedisDemoController : ControllerBase
{
private readonly IAoxeRedisClient _redisHandler;

public RedisDemoController(IAoxeRedisClient handler)
{
_redisHandler = handler;
}

[HttpGet]
[HttpPost]
public Guid Add()
{
var testModel = new TestModel
{
Id = Guid.NewGuid(),
Name = "apple",
Age = 18,
CreateTime = DateTime.Now
};
_redisHandler.Add(testModel.Id.ToString(), testModel);
return testModel.Id;
}

[HttpGet]
[HttpPost]
public List AddRange(int quantity)
{
var testModles = new List>();
for (var i = 0; i < quantity; i++)
{
var id = Guid.NewGuid();
testModles.Add(new Tuple(id.ToString(),
new TestModel
{
Id = id,
Name = "apple",
Age = 18,
CreateTime = DateTime.Now
}));
}

_redisHandler.AddRange(testModles);

return testModles.Select(p => p.Item1).ToList();
}

[HttpGet]
[HttpPost]
public void Delete(string key)
{
_redisHandler.Delete(key);
}

[HttpGet]
[HttpPost]
public void DeleteAll([FromBody]IList keys)
{
_redisHandler.DeleteAll(keys);
}

[HttpGet]
[HttpPost]
public TestModel Get(string key)
{
return _redisHandler.Get(key);
}

[HttpGet]
[HttpPost]
public Dictionary GetAll([FromBody]IList keys)
{
return _redisHandler.Get(keys);
}
}
```

Now you can run a [Postman](https://www.getpostman.com/) and send some requests to try it.And the AoxeRedisClient has async methods like AddAsync/AddRangeAsync/DeleteAsync/DeleteAllAsync,you can try it yourself.