StackExchange.Redis 官方文档(一) Basics

基本使用方法:

StackExchange.Redis的核心是 StackExchange.Redis 命名空间的 ConnectionMultiplexer 类;它隐藏了多服务器的实现细节.ConnectionMultiplexer被设计成可以在多个客户端之间分享和复用.不用每次操作都创建一个对象实例.对于这种使用方式,它是足够的线程安全和完备的.以后所有的示例都会假设已经创建了一个 ConnectionMultiplexer 实例对象,并且可以存储出来以备复用.但是现在,我们需要创建一个ConnectionMultiplexer实例对象。使用 ConnectionMultiplexer.Connect 或者 ConnectionMultiplexer.ConnectAsync 方法,参数可以是一个配置字符串,也可以是一个 ConfigurationOptions 对象.配置字符串采用一系列被逗号分隔的节点的组成形式.接下来链接本地redis服务器的默认端口(6379)创建一个对象:

using StackExchange.Redis;
...
ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost");
// ^^^ store and re-use this!!!

注意到 ConnectionMultiplexer实现了IDisposable,当不再使用的时候可以被销毁释放。考虑到复用的思想,这里没有使用 using 的方式,因为只有在很少的情况下,你才会想要只是暂时的使用 ConnectionMultiplexer

当使用主从配置服务器时,你只需要给出组成redis逻辑层的所有服务器(他会自动判断主服务器)

ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("server1:6379,server2:6379");

如果发现两个节点都是master,可以指定一个tie-beaker key来解决这个问题,当然这种情况是很少见的。

当你有一个 ConnectionMultiplexer ,你可能想要做的事:

  • 连接到redis数据库(注意:在集群的情况下,一个逻辑数据库可以分布到多个节点服务器上)
  • 使用redis的pub/sub功能
  • 为了维护/监控需要连接到单个的服务器

使用redis数据库

连接数据库的方法:

IDatabase db = redis.GetDatabase();

GetDatabase 返回一个 cheap pass-thru 对象,不需要存储起来(类似于静态化?)。注意 redis 支持多数据库(非集群状态下);在调用此方法时可以指定特定的数据库,同样适用于异步调用:

int databaseNumber = ...
object asyncState = ...
IDatabase db = redis.GetDatabase(databaseNumber, asyncState);

当有了 IDatabase 时,就可以使用redis API。所有的方法都有同步和异步两种实现方式。遵从微软制定的命名规则,所有的异步方法都带有 ...Async(...) 后缀,且是可以 await的。

下面的操作存储了、取回了一个值:

string value = "abcdefg";
db.StringSet("mykey", value);
...
string value = db.StringGet("mykey");
Console.WriteLine(value); // writes: "abcdefg"

注意这里的 String... 前缀指的是String redis type,和 .NET String type 有很大的不同,尽管两者都可以存储字符串。另外,redis的key和value都支持二进制数据-使用方法完全相同:

byte[] key = ..., value = ...;
db.StringSet(key, value);
...
byte[] value = db.StringGet(key);

支持redis所有的redis database commands和所有的数据类型。

使用Redis的 pub/sub(发布/订阅)

另外一种较为常用的Redis使用方式是把它作为一种pub/sub message工具:使用方法同样很简单,当链接出现错误时,ConnectionMultiplexer 会处理重新订阅频道所有的工作。

ISubscriber sub = redis.GetSubscriber();

同样的, GetSubscriber 返回的是一个 cheap pass-thru 对象并且不需要存储起来。pub/sub API 没有数据库的概念,同样支持异步状态。注意所有的订阅是全局的:他们的生存周期不会限制于 ISubscriber 对象的生存周期。发布/订阅的是"channels"(频道):channels不需要在在服务器上提前订阅(一种有意思的使用方式是作为一种个人通知类似的东西,Stack Overflow实时更新的部分实现就是用这个做出来的)。和在 .NET 相似,发布采用回调委托的形式,参数是channel-name和message:

sub.Subscribe("messages", (channel, message) => {
    Console.WriteLine((string)message);
});

此时,在另外一个客户端你可以对这个频道发布消息:

sub.Publish("messages", "hello");

几乎会在同时你会在订阅的客户端打印出 "hello" .频道名称和小心支持而进制数据。

其它的功能,请参考Pub / Sub Message Order

链接特定的服务器

维护时,有时有必要使用到特定的服务器命令:

IServer server = redis.GetServer("localhost", 6379);

GetServer 使用的参数可以是一个 EndPoint 或者是一对 name/value 来区分不同的服务器。方法返回的对象不要存储,支持异步。此外可以使用如下方法获取到所有的endpoints:

EndPoint[] endpoints = redis.GetEndPoints();

服务器命令详见Server commands,例如:

DateTime lastSave = server.LastSave();
ClientInfo[] clients = server.ClientList();

同步 vs 异步 vs Fire-and-Forget

StackExchange.Redis 三种主要的使用机制:

  • 同步的 - 操作在方法返回客户端之前完成(注意这样会阻塞客户端,但是不会阻塞其他线程:StackExchange.Redis的核心思想是在并发的客户端之间分享链接)
  • 异步的 - 操作在将来的某个时刻完成,并且马上会返回一个 Task or Task<T>,之后可以进行的操作:
    • be .Wait()ed (阻塞当前线程直到得到返回结果)
    • 使用(ContinueWith in the TPL(任务并行库)) 添加回调函数
    • be awaited (简化后者的语法功能,当收到回复之后继续执行下面的语句)
  • Fire-and-Forget - 不在意返回结果,得到一个类型的默认结果

同步的使用方法在上面例子当中已经给出,这只是最简单的使用方法,并且不会涉及到TPL

对于异步的使用方法,最主要的区别是方法添加了 Async 后缀,并且可以await的语法功能,举个例子来说:

string value = "abcdefg";
await db.StringSetAsync("mykey", value);
...
string value = await db.StringGetAsync("mykey");
Console.WriteLine(value); // writes: "abcdefg"

fire-and-forget的使用方式是所有方法当中的可选参数 CommandFlags flags 。使用这种方式将会立即得到一个默认的放回结果(String 返回nullInt64返回0)。操作将会在后台继续执行。典型的使用方式是增加浏览页数

db.StringIncrement(pageKey, flags: CommandFlags.FireAndForget);

原文地址StackExchange.Redis
大部分为意译,如有不当还请指正

转载:

http://www.cnblogs.com/ArvinZhao/p/6000823.html

时间: 2024-10-29 19:07:14

StackExchange.Redis 官方文档(一) Basics的相关文章

【译】StackExchange.Redis官方文档-中文版(序)

StackExchange.Redis官方文档-中文版(序) Intro 最近想深入学习一些 Redis 相关的东西.于是看了看官方的项目,发现里面有一份文档,于是打算翻译成中文,方便大家学习参考,如果有什么翻译不准确的地方,欢迎大家指出. 翻译进度 文档还有一部分还未翻译完,我会争取在三月中旬前将剩下的部分翻译结束. 翻译进度详见:https://github.com/WeihanLi/StackExchange.Redis-docs-cn 文档地址: 原文文档地址: https://gith

Redis官方文档》持久化

原文链接 译者:Alexandar Mahone 这篇文章从技术层面描述了Redis持久化,建议所有读者阅读.如果希望更多了解Redis持久化和持久性保障,建议阅读Redis持久化揭秘. Redis 持久化 提供了多种不同级别的持久化方式: RDB 持久化可以在指定的时间间隔内生成数据集的时间点快照(point-in-time snapshot). AOF 持久化记录服务器执行的所有写操作命令,并在服务器启动时,通过重新执行这些命令来还原数据集. AOF 文件中的命令全部以 Redis 协议的格

Swift -- 中文版两大官方文档汇总

Swift官方文档由CocoaChina翻译小组精心翻译制作而成,目前两本文档中文版已全部完成!在此,我们对所有参与的译者.组织人员以及工作人员表示衷心的感谢!本文为您提供两本文档的在线阅读以及下载!请多多关注Swift!!多多关注CocoaChina!!! The Swift Programming Language 欢迎使用Swift (一)关于Swift--About Swift (二)Swift 初见--A Swift Tour Swift -- 语言指南 (一)基础部分 -- The

Android 官方文档:(一)动画和图像 —— 1.5 画布和画图

The Android framework APIs provides a set 2D drawing APIs that allow you to render your owncustom graphics onto a canvas or to modify existing Views to customize their look and feel.When drawing 2D graphics, you'll typically do so in one of two ways:

Matlab最新的官方文档中文翻译

文章翻译的是Matlab最新的官方文档R2016b,可能后续如果我还有时间会继续翻译,希望能够帮到大家,翻译的不好请大家不要吐槽. Matlab官方文档地址:http://cn.mathworks.com/help/pdf_doc/matlab/getstart.pdf Desktop Basics  当您启动MATLAB时,桌面以其默认布局显示如下: 说明:请大家对照着英文原版看,我没有截图,因为实在太麻烦 桌面包括以下面板: ?当前文件夹 - 访问您的文件. ?命令窗口 - 在命令行中输入命

Android官方文档training中英文翻译目录大全:29篇已翻译,45篇未翻译

Android官方文档training中英文翻译目录大全:29篇已翻译,45篇未翻译 1. Getting Started Building Your First App: 原文: https://developer.android.com/training/basics/firstapp/index.html译文:http://wiki.eoeandroid.com/Building_Your_First_AppAdding the Action Bar:原文:https://develope

Android官方文档之Bound Services

绑定式Service在CS结构中扮演着Server的角色.绑定式Service允许其他组件(如Activity)绑定该Service.发送请求.接收响应.甚至IPC通信( interprocess communication).绑定式Service通常服务于其他应用程序的组件.且没有明确的后台的概念(does not run in the background indefinitely). 本文将介绍bound Service的相关内容,包括其创建.与其他应用组件如何绑定 等.有关Service

Google 官方文档解析之——Application Fundamentals

Android apps are written in the java programming language.The Android SDK tools compile your code-along with any data and resource file-into an APK:an Android package,which is an archive file with an .apk suffix.One APK file contains all the contents

Spark官方文档: Spark Configuration(Spark配置)

Spark官方文档: Spark Configuration(Spark配置) Spark主要提供三种位置配置系统: 环境变量:用来启动Spark workers,可以设置在你的驱动程序或者conf/spark-env.sh 脚本中: java系统性能:可以控制内部的配置参数,两种设置方法: 编程的方式(程序中在创建SparkContext之前,使用System.setProperty("xx","xxx")语句设置相应系统属性值): 在conf/spark-env