c#实现redis客户端(一)
最近项目使用中要改造redis客户端,看了下文档,总结分享一下。
阅读目录:
- 协议规范
- 基础通信
- 状态命令
- set、get命令
- 管道、事务
- 总结
协议规范
redis允许客户端以TCP方式连接,默认6379端口。传输数据都以rn结尾。
请求格式
*<number of arguments>rn$<number of bytes of argument 1>rn<argument data>rn
例:*1rn$4rnINFOrn
响应格式
1:简单字符串,非二进制安全字符串,一般是状态回复。 +开头,例:+OKrn
2: 错误信息。 -开头, 例:-ERR unknown command 'mush'rn
3: 整型数字。 :开头, 例::1rn
4:大块回复值,最大512M。 $开头+数据长度。 例:$4rmushrn
5:多条回复。 *开头, 例:*2rn$3rnfoorn$3rnbarrn
基础通信
定义配置类:
public class Configuration
{
public string Host { get; set; }
public int Port { get; set; }
/// <summary>
/// Socket 是否正在使用 Nagle 算法。
/// </summary>
public bool NoDelaySocket { get; set; }
public Configuration()
{
Host = "localhost";
Port = 6379;
NoDelaySocket = false;
}
}
实现socket连接:
public class RedisBaseClient
{
//配置文件
private Configuration configuration;
//通信socket
private Socket socket;
//接收字节数组
private byte[] ReceiveBuffer = new byte[100000];
public RedisBaseClient(Configuration config)
{
configuration = config;
}
public RedisBaseClient()
: this(new Configuration())
{
}
public void Connect()
{
if (socket != null && socket.Connected)
return;
socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp)
{
NoDelay = configuration.NoDelaySocket
};
socket.Connect(configuration.Host, configuration.Port);
if (socket.Connected)
return;
Close();
}
/// <summary>
/// 关闭client
/// </summary>
public void Close()
{
socket.Disconnect(false);
socket.Close();
}
}
调用:
RedisBaseClient redis = new RedisBaseClient();
redis.Connect();
服务端成功响应:
状态命令
定义Redis命令枚举:
public enum RedisCommand
{
GET, //获取一个key的值
INFO, //Redis信息。
SET, //添加一个值
EXPIRE, //设置过期时间
MULTI, //标记一个事务块开始
EXEC, //执行所有 MULTI 之后发的命令
}
发送命令构建:
public string SendCommand(RedisCommand command, params string[] args)
{
//请求头部格式, *<number of arguments>rn
const string headstr = "*{0}rn";
//参数信息 $<number of bytes of argument N>rn<argument data>rn
const string bulkstr = "${0}rn{1}rn";
var sb = new StringBuilder();
sb.AppendFormat(headstr, args.Length + 1);
var cmd = command.ToString();
sb.AppendFormat(bulkstr, cmd.Length, cmd);
foreach (var arg in args)
{
sb.AppendFormat(bulkstr, arg.Length, arg);
}
byte[] c = Encoding.UTF8.GetBytes(sb.ToString());
try
{
Connect();
socket.Send(c);
socket.Receive(ReceiveBuffer);
Close();
return ReadData();
}
catch (SocketException e)
{
Close();
}
return null;
}
private string ReadData()
{
var data = Encoding.UTF8.GetString(ReceiveBuffer);
char c = data[0];
//错误消息检查。
if (c == '-') //异常处理。
throw new Exception(data);
//状态回复。
if (c == '+')
return data;
return data;
}
调用:
private void button1_Click(object sender, EventArgs e)
{
RedisBaseClient redis = new RedisBaseClient();
var result = redis.SendCommand(RedisCommand.INFO);
richTextBox1.Text = result;
}
输出响应,其$937是数据包的长度。
set、get命令
调用:
private void button2_Click(object sender, EventArgs e)
{
RedisBaseClient redis = new RedisBaseClient();
var result = redis.SendCommand(RedisCommand.SET, "msg", "testvalue");
richTextBox1.Text = result.ToString();
}
private void button3_Click(object sender, EventArgs e)
{
RedisBaseClient redis = new RedisBaseClient();
var result = redis.SendCommand(RedisCommand.GET, "msg");
richTextBox1.Text = result.ToString();
}
输出
管道、事务
二者都是走的MULTI,EXEC命令,原子操作。管道就是发送命令(无需等上次命令回复),进入命令队列,然后多条命令一次执行,并返回客户端结果。
平常使用ServiceStack.Redis客户端都直接set了,其实是set、expire 2个命令。 简单实现如下:
public void CreatePipeline()
{
SendCommand(RedisCommand.MULTI, new string[] {}, true);
}
public string EnqueueCommand(RedisCommand command, params string[] args)
{
return SendCommand(command, args, true);
}
public string FlushPipeline()
{
var result = SendCommand(RedisCommand.EXEC, new string[] {}, true);
Close();
return result;
}
public string SendCommand(RedisCommand command, string[] args, bool isPipeline=false)
{
//请求头部格式, *<number of arguments>rn
const string headstr = "*{0}rn";
//参数信息 $<number of bytes of argument N>rn<argument data>rn
const string bulkstr = "${0}rn{1}rn";
var sb = new StringBuilder();
sb.AppendFormat(headstr, args.Length + 1);
var cmd = command.ToString();
sb.AppendFormat(bulkstr, cmd.Length, cmd);
foreach (var arg in args)
{
sb.AppendFormat(bulkstr, arg.Length, arg);
}
byte[] c = Encoding.UTF8.GetBytes(sb.ToString());
try
{
Connect();
socket.Send(c);
socket.Receive(ReceiveBuffer);
if (!isPipeline)
{
Close();
}
return ReadData();
}
catch (SocketException e)
{
Close();
}
return null;
}
public string SetByPipeline(string key, string value, int second)
{
this.CreatePipeline();
this.EnqueueCommand(RedisCommand.SET, key, value);
this.EnqueueCommand(RedisCommand.EXPIRE, key, second.ToString());
return this.FlushPipeline();
}
调用:
private void button4_Click(object sender, EventArgs e)
{
RedisBaseClient redis = new RedisBaseClient();
richTextBox1.Text = redis.SetByPipeline("cnblogs", "mushroom", 1000);
}
输出:
*2 表示2条回复。
+2 表示命令执行OK。
:1 表示命令执行的结果
总结
本文只是简单的实现,有兴趣的同学,可以继续下去。
客户端实现这块,Socket连接池管理相较复杂些。
参考资源:
http://redis.io/topics/protocol
https://github.com/ServiceStack/ServiceStack.Redis
- Spark源码系列(七)Spark on yarn具体实现
- 我们要在任何可能的地方测试XSS漏洞
- Angr:一个具有动态符号执行和静态分析的二进制分析工具
- Spark编程指南
- Spark Streaming编程指南
- Spark源码系列(八)Spark Streaming实例分析
- “震网三代”(CVE-2017-8464)的几种利用方法与防范
- Spark1.0新特性-->Spark SQL
- 挖洞经验 | 看我如何综合利用4个漏洞实现GitHub Enterprise 远程代码执行
- Spark的机器学习算法mlib的例子运行
- Spark Streaming自定义Receivers
- 利用USB橡皮鸭在目标机器上启动Empire或Meterpreter会话
- Spark部署
- Spark调优
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- rxjs里switchMap operators的用法
- rxjs里concatMap operators的用法
- rxjs里takeWhile operators的用法
- Python sql注入 过滤字符串的非法字符实例
- rxjs里combineLatest operators的用法
- rxjs里withLatestFrom operators的用法
- rxjs里distinctUntilChanged operators的用法
- pycharm安装及如何导入numpy
- rxjs里debounceTime operators的用法
- rxjs里delay operators的用法
- Android使用FontMetrics对象计算位置坐标
- rxjs里scan和mergeScan operators的用法
- Android自定义控件的步骤
- Android通过Socket与服务器之间进行通信的示例
- SAP Spartacus central configuration - B2cStorefrontModule