• 本系列博文是“伪”官方文档翻译（更加本土化），并非完全将官方文档进行翻译，而是在查阅、测试原始文档并转换为自己真知灼见后的“准”翻译。有不同见解 / 说明不周的地方，还请海涵、不吝拍砖 ：）

• 官方文档见此：https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/introduction.html

• 本系列对应的版本环境：ElasticSearch@7.3.1，NEST@7.3.1，IDE 和开发平台默认为 VS2019，.NET CORE 2.1

NEST 默认情况下使用预设的值与 ElasticSearch 集群进行交互，并提供了许多配置选项和组件来修改默认值（行为）。

你可以修改 ConnectionConfiguration 和 ConnectionStrings 的属性以达到修改默认连接行为的效果：

• ConnectionConfiguration：面向 ElasticSearch.Net。

• ConnectionStrings：面向 NEST。

配置 ConnectionConfiguration

因为 ConnectionStrings 继承自 ConnectionConfiguration，所以以下选项（方法/属性）适用于 ConnectionConfiguration 和 ConnectionStrings。

• ApiKeyAuthentication： 与所有请求一起发送到Elasticsearch的 Api Key。

• BasicAuthentication： 与所有请求一起发送到Elasticsearch的 基本身份验证凭证。

• ClientCertificate： 为所有 HTTP 请求使用 X509Certificate 认证。你也可以在每一个请求上通过 ClientCertificates 属性来进行设置。

• 本系列博文是“伪”官方文档翻译（更加本土化），并非完全将官方文档进行翻译，而是在查阅、测试原始文档并转换为自己真知灼见后的“准”翻译。有不同见解 / 说明不周的地方，还请海涵、不吝拍砖 ：）

• 官方文档见此：https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/introduction.html

• 本系列对应的版本环境：ElasticSearch@7.3.1，NEST@7.3.1，IDE 和开发平台默认为 VS2019，.NET CORE 2.1

Elasticsearch.Net 和 NEST 对比说明：

• Elasticsearch 官方为 .NET 提供了 2 个官方客户端库：Elasticsearch.Net 和 NEST。

• 可以简单理解为 Elasticsearch.Net 是 NEST 的一个子集。

• NEST 内部使用了 ElasticSearch.Net ，并通过 NEST 可以对外暴露 ElasticSearch.Net 客户端。

• 但 NEST 包含了 ElasticSearch.Net 所没有的一些高级功能，如：

  • 强类型查询 DSL：可以将所有请求和响应的对象类型转换 1:1 的.NET 类型。
  • 自动转换为 CLR 的数据类型。

基本上 .NET 项目到了要使用上 ElasticSearch 的地步，直接选择 NEST 即可。

在使用 NEST 作为客户端的时候，建议将 ElasticClient 对象作为单例来使用。

• ElasticClient 被设计为线程安全。

• ES 中的缓存是根据 ConnectionSettings 来划分的，即服务端缓存针对的是每一个 ConnectionStrings

• 例外： 当你需要连接不同的 ES 集群的时候，就不要用单例了，应为不同的 ElasticClient 使用不同的 ConnectionStrings。

快速使用

• 使用 Nest 的时候约定 Nest 版本需要跟 ElasticSearch 版本保持一致，即服务端 ES版本为 7.3.1，则 Nest 版本也要使用 7.3.1

• 以下示例通过 IoC 进行注入（单例），你也可以直接通过单例模式来实现。

• 本系列博文是“伪”官方文档翻译，并非完全将官方文档进行翻译，而是我在查阅、测试原始文档并转换为自己东西后进行的“准”翻译。

• 原始文档见此：https://stackexchange.github.io/StackExchange.Redis/

• 本系列本博文基于 redis 5.0.6，系列中部分博文跟官方文档有出入，有不同见解 / 说明不当的地方，还请大家不吝拍砖。

StackExchange.Redis 为 windows 环境提供了测试套件，截至本文发布前，作者尚未正式发布跨平台的套件信息。

StackExchange.Redis 提供的单元和继承测试很简单，有 2 个主要步骤：

1. 开启服务器

2. 运行测试

• 测试默认使用本机 Redis 服务（127.0.0.1），你可以修改 json 配置来自定义。

1
2
3
4
5

{
  "RunLongRunning": true,
  "MasterServer": "192.168.10.5",
  "MasterPort": 2333
}

• 本系列博文是“伪”官方文档翻译，并非完全将官方文档进行翻译，而是我在查阅、测试原始文档并转换为自己东西后进行的“准”翻译。

• 原始文档见此：https://stackexchange.github.io/StackExchange.Redis/

• 本系列本博文基于 redis 5.0.6，系列中部分博文跟官方文档有出入，有不同见解 / 说明不当的地方，还请大家不吝拍砖。

StackExchange.Redis 库中提供了以下几个接口来让你执行 LUA 基本脚本：

• IServer.ScriptLoad(Async)

• IServer.ScriptExists(Async)

• IServer.ScriptFlush(Async)

• IDatabase.ScriptEvaluate

• IDatabaseAsync.ScriptEvaluateAsync

要执行复杂脚本的话，可以通过 LuaScript 类来进行构建。

LuaScript 示例

• 本系列博文是“伪”官方文档翻译，并非完全将官方文档进行翻译，而是我在查阅、测试原始文档并转换为自己东西后进行的“准”翻译。

• 原始文档见此：https://stackexchange.github.io/StackExchange.Redis/

• 本系列本博文基于 redis 5.0.6，系列中部分博文跟官方文档有出入，有不同见解 / 说明不当的地方，还请大家不吝拍砖。

StackExchange.Redis公开了一些方法和类型来启用性能分析。

性能分析接口由以下几个接口和方法组成：

• IProfiler

• ConnectionMultiplexer.RegisterProfiler(IProfiler)

• ConnectionMultiplexer.BeginProfiling(object)

• ConnectionMultiplexer.FinishProfiling(object),

• IProfiledCommand

你可以通过 ConnectionMultiplexer 来注册一个 IProfiler 实例，无法被更改。

• 本系列博文是“伪”官方文档翻译，并非完全将官方文档进行翻译，而是我在查阅、测试原始文档并转换为自己东西后进行的“准”翻译。

• 原始文档见此：https://stackexchange.github.io/StackExchange.Redis/

• 本系列本博文基于 redis 5.0.6，系列中部分博文跟官方文档有出入，有不同见解 / 说明不当的地方，还请大家不吝拍砖。

StackExchange.Redis 面向的是 redis 集群，所以需要直到哪些命令面向 database，哪些命令面向 server。
KEYS, SCAN, FLUSHDB 这些命令都属于服务端命令。

以下命令面向的是单台服务器（包含但不限于）

• KEYS / SCAN：仅列出当前服务器上的 key；不包括更广逻辑上的 database。

• FLUSHDB / FLUSHALL：仅移除当前服务器上的 key，不包括更广逻辑上的 database。

• RANDOMKEY：仅随机选择当前服务器上的 key，不包括更广逻辑上的 database。

• CLIENT

• CLUSTER

• CONFIG / INFO / TIME

• SLAVEOF

• SAVE / BGSAVE / LASTSAVE

• SCRIPT (not to be confused with EVAL / EVALSHA)

• SHUTDOWN

• SLOWLOG

• PUBSUB (not to be confused with PUBLISH / SUBSCRIBE / etc)

• some DEBUG operations

• 本系列博文是“伪”官方文档翻译，并非完全将官方文档进行翻译，而是我在查阅、测试原始文档并转换为自己东西后进行的“准”翻译。

• 原始文档见此：https://stackexchange.github.io/StackExchange.Redis/

• 本系列本博文基于 redis 5.0.6，系列中部分博文跟官方文档有出入，有不同见解 / 说明不当的地方，还请大家不吝拍砖。

说明

• Stream 数据类型是在 Redis 5.0 版本新引入的。它以更抽象的方式来模拟日志数据结构。

• 目前 StackExchange.Redis 客户端已经实现了所有原生 Stream 相关的命令。

• 关于 Stream 的介绍可以见此。

往 Streams 中写入数据

• Stream 中的每条消息/条目都由 StreamEntry 类型表示。每个 Stream 条目包含一个唯一的 ID 和一个 Name/Value 对。

eg：通过单个 name/value对 往 Stream 中添加一条简单消息

• 本系列博文是“伪”官方文档翻译，并非完全将官方文档进行翻译，而是我在查阅、测试原始文档并转换为自己东西后进行的“准”翻译。

• 原始文档见此：https://stackexchange.github.io/StackExchange.Redis/

• 本系列本博文基于 redis 5.0.6，系列中部分博文跟官方文档有出入，有不同见解 / 说明不当的地方，还请大家不吝拍砖。

当你使用 pub/sub 的时候，需要考虑在一个连接中，消息是顺序处理还是并行处理。StackExchange 推荐如果可以的话是并行处理。

顺序处理的好处是你不需要要担心线程安全，且处理消息的顺序和消息的发送顺序是一致的（通过队列），但问题是消息间有可能相互延时。

1
2
3

multiplexer.GetSubscriber().SubScribe("messages", (channel, message) => {
    Console.WriteLine((string)message);
    });

并发处理的好处是更快，可扩展性更高，一般消息间没有什么关联的时候用并发模式。并发的问题是因为消息是无序的，你需要自己保证并发消息不会破坏你的内部状态。

1
2
3
4

var channelMessageQueue = multiplexer.GetSubscriber().SubScribe("messages");
channel.OnMessage(message =>{
    Console.WriteLine((string)message.Message);
    });

• 本系列博文是“伪”官方文档翻译，并非完全将官方文档进行翻译，而是我在查阅、测试原始文档并转换为自己东西后进行的“准”翻译。

• 原始文档见此：https://stackexchange.github.io/StackExchange.Redis/

• 本系列本博文基于 redis 5.0.6，系列中部分博文跟官方文档有出入，有不同见解 / 说明不当的地方，还请大家不吝拍砖。

ConnectionMultiplexer 对外提供了多个事件以便让你可以捕获内部执行情况，你可以通过这些事件按需记录日志。

事件

• ConfigurationChanged：当 ConnectionMultiplexer 中的连接发生改变的时候该事件会被触发。

• ConfigurationChangedBroadcast：当通过 pub/sub 接收到重新配置的消息时，该事件会被触发。通常情况下，引发该事件的是调用 IServer.MakeMaster 去改变一个节点的副本配置（该节点可以将此类请求广播到所有客户端。）

• ConnectionFailed：任何原因导致物理连接失败的时候会触发该事件。在下次连接被重新成功建立前，该事件只会触发一次。

• ConnectionRestored：在上一次连接失败后，连接重新被建立（恢复）的时候，会触发该事件。

• ErrorMessage：当 Redis 服务端用错误信息响应客户端请求的时候，该事件会被触发。另外，触发该事件后，常规的异常/错误依然会返回/告知到调用方。

• HashSlotMoved：使用“redis 集群”的时候，当 hash-slot 在节点间发生迁移的时候，该事件就会别触发。注意，请求会自动重新路由，一般用户不需要做什么特殊操作。

• InternalError：当 StackExchange.Redis 库内部发生错误的时候会触发该事件，一般在 DEBUG 的时候可以使用该事件。

请注意，StackExchange.Redis中的 pub/sub 实现与事件类似，Subscribe / SubscribeAsync 方法接受一个 Action<RedisChannel，RedisValue> 回调，该回调在收到消息时会被触发。

• 本系列博文是“伪”官方文档翻译，并非完全将官方文档进行翻译，而是我在查阅、测试原始文档并转换为自己东西后进行的“准”翻译。

• 原始文档见此：https://stackexchange.github.io/StackExchange.Redis/

• 本系列本博文基于 redis 5.0.6，系列中部分博文跟官方文档有出入，有不同见解 / 说明不当的地方，还请大家不吝拍砖。

Redis 中的事务说明

• Redis 中的事务跟我们常说的数据库事务不同：

  • 数据库事务必须保证全部成功，否则就回滚。
  • 而 Redis 中的事务更偏向于“一组打包的批量执行脚本”，其中任何一条命令的执行失败，不会导致已经执行的命令回滚，也不会中断后续的命令执行。

• 在使用数据库事务的时候，你可以在事务中使用条件判断。但在 Redis 事务中，你无法使用条件判断。（条件见下方说明）

如何使用事务？

• 在 Redis 原生命令中使用 MULTI 来开启事务，EXEC 来执行事务（或者 DISCARD 来取消事务）

• 一旦使用 MULTI，在 MULTI 之后的命令不会立即执行，它们会排队，直到接收到 EXEC命令。如果接收到的时 DISCARD 命令，则所有已传输的命令会全部抛弃。

  • 因为 Redis 命令会排队执行，所以无法在 Redis 中使用条件判断。