Skip to content

Commit 47c8f05

Browse files
catcherwongcatcherwong
committed
📝 Update docs
1 parent 1f70117 commit 47c8f05

15 files changed

+128
-175
lines changed

‎build/version.props

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
<Project>
22
<PropertyGroup>
3-
<EasyCachingCorePackageVersion>0.5.4-rc</EasyCachingCorePackageVersion>
4-
<EasyCachingMemcachedPackageVersion>0.5.4-rc</EasyCachingMemcachedPackageVersion>
5-
<EasyCachingRedisPackageVersion>0.5.4-rc</EasyCachingRedisPackageVersion>
6-
<EasyCachingSQLitePackageVersion>0.5.4-rc</EasyCachingSQLitePackageVersion>
7-
<EasyCachingInMemoryPackageVersion>0.5.4-rc</EasyCachingInMemoryPackageVersion>
8-
<EasyCachingHybridPackageVersion>0.5.4-rc</EasyCachingHybridPackageVersion>
9-
<EasyCachingAspectCorePackageVersion>0.5.4-rc</EasyCachingAspectCorePackageVersion>
10-
<EasyCachingCastlePackageVersion>0.5.4-rc</EasyCachingCastlePackageVersion>
11-
<EasyCachingResponseCachingPackageVersion>0.5.4-rc</EasyCachingResponseCachingPackageVersion>
12-
<EasyCachingJsonPackageVersion>0.5.4-rc</EasyCachingJsonPackageVersion>
13-
<EasyCachingMessagePackPackageVersion>0.5.4-rc</EasyCachingMessagePackPackageVersion>
14-
<EasyCachingProtobufPackageVersion>0.5.4-rc</EasyCachingProtobufPackageVersion>
15-
<EasyCachingCSRedisPackageVersion>0.5.4-rc</EasyCachingCSRedisPackageVersion>
16-
<EasyCachingRedisBusPackageVersion>0.5.4-rc</EasyCachingRedisBusPackageVersion>
17-
<EasyCachingCSRedisBusPackageVersion>0.5.4-rc</EasyCachingCSRedisBusPackageVersion>
18-
<EasyCachingRabbitBusPackageVersion>0.5.4-rc</EasyCachingRabbitBusPackageVersion>
3+
<EasyCachingCorePackageVersion>0.5.4</EasyCachingCorePackageVersion>
4+
<EasyCachingMemcachedPackageVersion>0.5.4</EasyCachingMemcachedPackageVersion>
5+
<EasyCachingRedisPackageVersion>0.5.4</EasyCachingRedisPackageVersion>
6+
<EasyCachingSQLitePackageVersion>0.5.4</EasyCachingSQLitePackageVersion>
7+
<EasyCachingInMemoryPackageVersion>0.5.4</EasyCachingInMemoryPackageVersion>
8+
<EasyCachingHybridPackageVersion>0.5.4</EasyCachingHybridPackageVersion>
9+
<EasyCachingAspectCorePackageVersion>0.5.4</EasyCachingAspectCorePackageVersion>
10+
<EasyCachingCastlePackageVersion>0.5.4</EasyCachingCastlePackageVersion>
11+
<EasyCachingResponseCachingPackageVersion>0.5.4</EasyCachingResponseCachingPackageVersion>
12+
<EasyCachingJsonPackageVersion>0.5.4</EasyCachingJsonPackageVersion>
13+
<EasyCachingMessagePackPackageVersion>0.5.4</EasyCachingMessagePackPackageVersion>
14+
<EasyCachingProtobufPackageVersion>0.5.4</EasyCachingProtobufPackageVersion>
15+
<EasyCachingCSRedisPackageVersion>0.5.4</EasyCachingCSRedisPackageVersion>
16+
<EasyCachingRedisBusPackageVersion>0.5.4</EasyCachingRedisBusPackageVersion>
17+
<EasyCachingCSRedisBusPackageVersion>0.5.4</EasyCachingCSRedisBusPackageVersion>
18+
<EasyCachingRabbitBusPackageVersion>0.5.4</EasyCachingRabbitBusPackageVersion>
1919
</PropertyGroup>
2020
</Project>

‎docs/AspectCore.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,11 @@ public class Startup
7272
{
7373
services.AddScoped<IDemoService, DemoService>();
7474

75-
services.AddDefaultInMemoryCache();
75+
services.AddEasyCaching(option=>
76+
{
77+
//use memory cache
78+
option.UseInMemory("default");
79+
});
7680

7781
services.AddMvc();
7882

@@ -101,7 +105,7 @@ public class ValuesController : Controller
101105
{
102106
if(type == 1)
103107
{
104-
return _service.GetCurrentUtcTime();
108+
return _service.GetCurrentUtcTime();
105109
}
106110
else if(type == 2)
107111
{
@@ -115,7 +119,7 @@ public class ValuesController : Controller
115119
else
116120
{
117121
return "other";
118-
}
122+
}
119123
}
120124
}
121125
```

‎docs/CSRedis.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ First of all, we can config by C# code.
2424
public class Startup
2525
{
2626
//...
27-
27+
2828
public void ConfigureServices(IServiceCollection services)
2929
{
3030
//other services.
3131
32-
//Important step for Redis Caching
32+
//Important step for Redis Caching
3333
services.AddEasyCaching(option =>
3434
{
3535
option.UseCSRedis(config =>
@@ -53,13 +53,12 @@ What's more, we also can read the configuration from `appsettings.json`.
5353
public class Startup
5454
{
5555
//...
56-
56+
5757
public void ConfigureServices(IServiceCollection services)
5858
{
5959
//other services.
6060
6161
//Important step for Redis Caching
62-
services.AddDefaultRedisCache(Configuration);
6362
services.AddEasyCaching(option =>
6463
{
6564
option.UseCSRedis(Configuration, "myredisname", "easycaching:csredis");

‎docs/Castle.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Install-Package EasyCaching.Interceptor.Castle
1515
1616
Install-Package EasyCaching.InMemory
1717
```
18+
1819
## 2. Define services
1920

2021
### 2.1 Define the interface
@@ -23,7 +24,7 @@ Just define a regular interface.
2324

2425
```csharp
2526
public interface IDemoService
26-
{
27+
{
2728
string GetCurrentUtcTime();
2829

2930
string PutSomething(string str);
@@ -72,7 +73,11 @@ public class Startup
7273
{
7374
services.AddScoped<IDemoService, DemoService>();
7475

75-
services.AddDefaultInMemoryCache();
76+
services.AddEasyCaching(option =>
77+
{
78+
//use memory cache
79+
option.UseInMemory("default");
80+
});
7681

7782
services.AddMvc();
7883

@@ -101,7 +106,7 @@ public class ValuesController : Controller
101106
{
102107
if(type == 1)
103108
{
104-
return _service.GetCurrentUtcTime();
109+
return _service.GetCurrentUtcTime();
105110
}
106111
else if(type == 2)
107112
{
@@ -115,7 +120,7 @@ public class ValuesController : Controller
115120
else
116121
{
117122
return "other";
118-
}
123+
}
119124
}
120125
}
121126
```

‎docs/Features.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@
1212
9. GetByPrefix/GetByPrefixAsync
1313
10. RemoveAll/RemoveAllAsync
1414
11. GetCount
15-
12. Flush/FlushAsync
15+
12. Flush/FlushAsync
16+
13. TrySet/TrySetAsync
1617
- Caching Providers(Both local caching and distributed caching)
1718
1. In-Memory
1819
2. Memcached
19-
3. Redis
20-
4. SQLite
21-
5. Hybrid
20+
3. Redis(Based on StackExchange.Redis)
21+
4. Redis(Based on csredis)
22+
5. SQLite
23+
6. Hybrid
2224
- Caching Interceptors
2325
1. AspectCore
2426
2. Castle

‎docs/Hybrid.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Install-Package EasyCaching.Bus.Redis
2727
public class Startup
2828
{
2929
//...
30-
30+
3131
public void ConfigureServices(IServiceCollection services)
3232
{
3333
services.AddMvc();
34-
34+
3535
services.AddEasyCaching(option =>
3636
{
3737
// local
@@ -44,10 +44,15 @@ public class Startup
4444
}, "myredis");
4545

4646
// combine local and distributed
47-
option.UseHybrid(config =>
47+
option.UseHybrid(config =>
4848
{
4949
config.TopicName = "test-topic";
5050
config.EnableLogging = false;
51+
52+
// specify the local cache provider name after v0.5.4
53+
config.LocalCacheProviderName = "m1";
54+
// specify the distributed cache provider name after v0.5.4
55+
config.DistributedCacheProviderName = "myredis";
5156
})
5257
// use redis bus
5358
.WithRedisBus(busConf =>
@@ -79,7 +84,7 @@ public class ValuesController : Controller
7984
{
8085
//Set
8186
_provider.Set("demo", "123", TimeSpan.FromMinutes(1));
82-
87+
8388
//others
8489
//...
8590
}

‎docs/In-Memory.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,17 @@ First of all, we can config by C# code.
2222
public class Startup
2323
{
2424
//...
25-
25+
2626
public void ConfigureServices(IServiceCollection services)
2727
{
2828
//other services.
2929
3030
//Important step for In-Memory Caching
31-
services.AddDefaultInMemoryCache();
31+
services.AddEasyCaching(option =>
32+
{
33+
//use memory cache
34+
option.UseInMemory("default");
35+
});
3236
}
3337
}
3438
```
@@ -39,13 +43,17 @@ What's more, we also can read the configuration from `appsettings.json`.
3943
public class Startup
4044
{
4145
//...
42-
46+
4347
public void ConfigureServices(IServiceCollection services)
4448
{
4549
//other services.
4650
4751
//Important step for In-Memory Caching
48-
services.AddDefaultInMemoryCache(Configuration);
52+
services.AddEasyCaching(option =>
53+
{
54+
//use memory cache
55+
option.UseInMemory(Configuration, "default", "easycahing:inmemory");
56+
});
4957
}
5058
}
5159
```

‎docs/Json.md

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ DefaultJsonSerializer is a serializer based on **Newtonsoft.Json**.
1010
Install-Package EasyCaching.Serialization.Json
1111
```
1212

13-
## Use In EasyCaching.Redis
13+
## Configuration
1414

1515
```
1616
public class Startup
@@ -21,34 +21,11 @@ public class Startup
2121
{
2222
services.AddMvc();
2323
24-
services.AddDefaultRedisCache(option=>
25-
{
26-
option.Endpoints.Add(new ServerEndPoint("127.0.0.1", 6379));
27-
option.Password = "";
24+
services.AddEasyCaching(option =>
25+
{
26+
//specify to use json serializer
27+
option.WithJson();
2828
});
29-
//specify to use json serializer
30-
services.AddDefaultJsonSerializer();
31-
}
32-
}
33-
```
34-
35-
## Use In EasyCaching.Memcached
36-
37-
```
38-
public class Startup
39-
{
40-
//others...
41-
42-
public void ConfigureServices(IServiceCollection services)
43-
{
44-
services.AddMvc();
45-
46-
services.AddDefaultMemcached(op=>
47-
{
48-
op.AddServer("127.0.0.1",11211);
49-
});
50-
//specify the Transcoder use json serializer.
51-
services.AddDefaultJsonSerializer();
5229
}
5330
}
5431
```

‎docs/Memcached.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,26 @@ Install-Package EasyCaching.Memcached
2020
public class Startup
2121
{
2222
//...
23-
23+
2424
public void ConfigureServices(IServiceCollection services)
2525
{
2626
services.AddMvc();
27-
27+
2828
//Important step for Memcached Cache
29-
services.AddDefaultMemcached(option=>
30-
{
31-
option.AddServer("127.0.0.1",11211);
32-
});
29+
services.AddEasyCaching(option =>
30+
{
31+
//use memmemcachedory cache
32+
option.UseMemcached(config =>
33+
{
34+
config.DBConfig.AddServer("127.0.0.1", 11211);
35+
});
36+
});
3337
}
34-
38+
3539
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
3640
{
37-
//Important step for Memcache Cache
38-
app.UseDefaultMemcached();
41+
// Important step for Memcache Cache
42+
app.UseEasyCaching();
3943
}
4044
}
4145
```

‎docs/MessagePack.md

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ DefaultMessagePackSerializer is is a serializer based on **MessagePack**.
1010
Install-Package EasyCaching.Serialization.MessagePack
1111
```
1212

13-
## Use In EasyCaching.Redis
13+
## Configuration
1414

1515
```
1616
public class Startup
@@ -21,34 +21,11 @@ public class Startup
2121
{
2222
services.AddMvc();
2323
24-
services.AddDefaultRedisCache(option=>
25-
{
26-
option.Endpoints.Add(new ServerEndPoint("127.0.0.1", 6379));
27-
option.Password = "";
28-
});
29-
//specify to use messagepack serializer
30-
services.AddDefaultMessagePackSerializer();
31-
}
32-
}
33-
```
34-
35-
## Use In EasyCaching.Memcached
36-
37-
```
38-
public class Startup
39-
{
40-
//others...
41-
42-
public void ConfigureServices(IServiceCollection services)
43-
{
44-
services.AddMvc();
45-
46-
services.AddDefaultMemcached(op=>
47-
{
48-
op.AddServer("127.0.0.1",11211);
24+
services.AddEasyCaching(option =>
25+
{
26+
//specify to use messagepack serializer
27+
option.WithMessagePack();
4928
});
50-
//specify the Transcoder use messagepack serializer.
51-
services.AddDefaultMessagePackSerializer();
5229
}
5330
}
5431
```

0 commit comments

Comments
 (0)