GrapeCity.Forguncy.ServerApi.ICacheService

接口 ICacheService

缓存服务

命名空间: GrapeCity.Forguncy.ServerApi

程序集: GrapeCity.Forguncy.ServerApi.dll

语法

public interface ICacheService

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

示例

public class Class1 : ForguncyApi
{
   [Get]
   public object TestCacheService()
   {
       var key = "myKey";

       var cacheService = this.Context.RequestServices.GetService(typeof(ICacheService)) as ICacheService;

       if (cacheService.Exists(key))
       {
           return cacheService.Get(key);
       }

       cacheService.Add(key, "cacheValue");
       return "cacheValue";
    }
 }

方法

Add(string, object, TimeSpan)

添加缓存

声明

[Obsolete]
bool Add(string key, object value, TimeSpan expiresIn)

参数

类型	名称	描述
string	key	缓存键
object	value	缓存Value
System.TimeSpan	expiresIn	缓存过期时间

返回值

类型	描述
bool	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

Add(string, object)

添加缓存

声明

[Obsolete]
bool Add(string key, object value)

参数

类型	名称	描述
string	key	缓存键
object	value	缓存Value

返回值

类型	描述
bool	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

AddAsync(string, object, TimeSpan)

添加缓存

声明

Task<bool> AddAsync(string key, object value, TimeSpan expiresIn)

参数

类型	名称	描述
string	key	缓存键
object	value	缓存Value
System.TimeSpan	expiresIn	缓存过期时间

返回值

类型	描述
System.Threading.Tasks.Task<TResult><bool>	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

AddAsync(string, object)

添加缓存

声明

Task<bool> AddAsync(string key, object value)

参数

类型	名称	描述
string	key	缓存键
object	value	缓存Value

返回值

类型	描述
System.Threading.Tasks.Task<TResult><bool>	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

Exists(string)

验证缓存项是否存在

声明

[Obsolete]
bool Exists(string key)

参数

类型	名称	描述
string	key	缓存键

返回值

类型	描述
bool	是否存在

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

ExistsAsync(string)

验证缓存项是否存在

声明

Task<bool> ExistsAsync(string key)

参数

类型	名称	描述
string	key	缓存键

返回值

类型	描述
System.Threading.Tasks.Task<TResult><bool>	是否存在

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

Get(string)

获取缓存

声明

[Obsolete]
object Get(string key)

参数

类型	名称	描述
string	key	缓存键

返回值

类型	描述
object	缓存值

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

Get<T>(string)

获取缓存

声明

[Obsolete]
T Get<T>(string key)

参数

类型	名称	描述
string	key	缓存键

返回值

类型	描述
T	缓存值

类型参数

名称	描述
T

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

GetAsync(string)

获取缓存

声明

Task<object> GetAsync(string key)

参数

类型	名称	描述
string	key	缓存键

返回值

类型	描述
System.Threading.Tasks.Task<TResult><object>	缓存值

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

GetAsync<T>(string)

获取缓存

声明

Task<T> GetAsync<T>(string key)

参数

类型	名称	描述
string	key	缓存键

返回值

类型	描述
System.Threading.Tasks.Task<TResult><T>	缓存值

类型参数

名称	描述
T

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

GetOrSetAsync<T>(string, string, TimeSpan)

获取或添加

声明

Task<T> GetOrSetAsync<T>(string key, string value, TimeSpan expiresIn)

参数

类型	名称	描述
string	key	缓存键
string	value	缓存Value
System.TimeSpan	expiresIn	缓存时长

返回值

类型	描述
System.Threading.Tasks.Task<TResult><T>	缓存值

类型参数

名称	描述
T

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

Remove(string)

删除缓存

声明

[Obsolete]
bool Remove(string key)

参数

类型	名称	描述
string	key	缓存键

返回值

类型	描述
bool	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

RemoveAll(IEnumerable<string>)

批量删除缓存

声明

[Obsolete]
void RemoveAll(IEnumerable<string> keys)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><string>	keys	缓存键集合

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

RemoveAllAsync(IEnumerable<string>)

批量删除缓存

声明

Task RemoveAllAsync(IEnumerable<string> keys)

参数

类型	名称	描述
System.Collections.Generic.IEnumerable<T><string>	keys	缓存键集合

返回值

类型	描述
System.Threading.Tasks.Task

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

RemoveAsync(string)

删除缓存

声明

Task<bool> RemoveAsync(string key)

参数

类型	名称	描述
string	key	缓存键

返回值

类型	描述
System.Threading.Tasks.Task<TResult><bool>	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

Replace(string, object, TimeSpan)

修改缓存

声明

[Obsolete]
bool Replace(string key, object value, TimeSpan expiresIn)

参数

类型	名称	描述
string	key	缓存键
object	value	缓存Value
System.TimeSpan	expiresIn	缓存时长

返回值

类型	描述
bool	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

Replace(string, object)

修改缓存

声明

[Obsolete]
bool Replace(string key, object value)

参数

类型	名称	描述
string	key	缓存键
object	value	缓存值

返回值

类型	描述
bool	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

ReplaceAsync(string, object, TimeSpan)

修改缓存

声明

Task<bool> ReplaceAsync(string key, object value, TimeSpan expiresIn)

参数

类型	名称	描述
string	key	缓存键
object	value	缓存Value
System.TimeSpan	expiresIn	缓存时长

返回值

类型	描述
System.Threading.Tasks.Task<TResult><bool>	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务

ReplaceAsync(string, object)

修改缓存

声明

Task<bool> ReplaceAsync(string key, object value)

参数

类型	名称	描述
string	key	缓存键
object	value	缓存值

返回值

类型	描述
System.Threading.Tasks.Task<TResult><bool>	是否成功

备注

缓存服务的默认实现是MemoryCache，在负载均衡模式下会使用Redis服务