Python与Redis的连接教程


Posted in Python onApril 22, 2015

今天在写zabbix storm job监控脚本的时候用到了python的redis模块,之前也有用过,但是没有过多的了解,今天看了下相关的api和源码,看到有ConnectionPool的实现,这里简单说下。
在ConnectionPool之前,如果需要连接redis,我都是用StrictRedis这个类,在源码中可以看到这个类的具体解释:
 
redis.StrictRedis Implementation of the Redis protocol.This abstract class provides a Python interface to all Redis commands and an
implementation of the Redis protocol.Connection and Pipeline derive from this, implementing how the commands are sent and received to the Redis server

使用的方法:
 

r=redis.StrictRedis(host=xxxx, port=xxxx, db=xxxx)
 r.xxxx()

有了ConnectionPool这个类之后,可以使用如下方法
 

pool = redis.ConnectionPool(host=xxx, port=xxx, db=xxxx)
r = redis.Redis(connection_pool=pool)

这里Redis是StrictRedis的子类
简单分析如下:
在StrictRedis类的__init__方法中,可以初始化connection_pool这个参数,其对应的是一个ConnectionPool的对象:
 

class StrictRedis(object):
........
  def __init__(self, host='localhost', port=6379,
         db=0, password=None, socket_timeout=None,
         socket_connect_timeout=None,
         socket_keepalive=None, socket_keepalive_options=None,
         connection_pool=None, unix_socket_path=None,
         encoding='utf-8', encoding_errors='strict',
         charset=None, errors=None,
         decode_responses=False, retry_on_timeout=False,
         ssl=False, ssl_keyfile=None, ssl_certfile=None,
         ssl_cert_reqs=None, ssl_ca_certs=None):
     if not connection_pool:
       ..........
       connection_pool = ConnectionPool(**kwargs)
     self.connection_pool = connection_pool

在StrictRedis的实例执行具体的命令时会调用execute_command方法,这里可以看到具体实现是从连接池中获取一个具体的连接,然后执行命令,完成后释放连接:

 

# COMMAND EXECUTION AND PROTOCOL PARSING
  def execute_command(self, *args, **options):
    "Execute a command and return a parsed response"
    pool = self.connection_pool
    command_name = args[0]
    connection = pool.get_connection(command_name, **options) #调用ConnectionPool.get_connection方法获取一个连接
    try:
      connection.send_command(*args) #命令执行,这里为Connection.send_command
      return self.parse_response(connection, command_name, **options)
    except (ConnectionError, TimeoutError) as e:
      connection.disconnect()
      if not connection.retry_on_timeout and isinstance(e, TimeoutError):
        raise
      connection.send_command(*args) 
      return self.parse_response(connection, command_name, **options)
    finally:
      pool.release(connection) #调用ConnectionPool.release释放连接

在来看看ConnectionPool类:

class ConnectionPool(object): 
    ...........
  def __init__(self, connection_class=Connection, max_connections=None,
         **connection_kwargs):  #类初始化时调用构造函数
    max_connections = max_connections or 2 ** 31
    if not isinstance(max_connections, (int, long)) or max_connections < 0: #判断输入的max_connections是否合法
      raise ValueError('"max_connections" must be a positive integer')
    self.connection_class = connection_class #设置对应的参数
    self.connection_kwargs = connection_kwargs
    self.max_connections = max_connections
    self.reset() #初始化ConnectionPool 时的reset操作
  def reset(self):
    self.pid = os.getpid()
    self._created_connections = 0 #已经创建的连接的计数器
    self._available_connections = []  #声明一个空的数组,用来存放可用的连接
    self._in_use_connections = set() #声明一个空的集合,用来存放已经在用的连接
    self._check_lock = threading.Lock()
.......
  def get_connection(self, command_name, *keys, **options): #在连接池中获取连接的方法
    "Get a connection from the pool"
    self._checkpid()
    try:
      connection = self._available_connections.pop() #获取并删除代表连接的元素,在第一次获取connectiong时,因为_available_connections是一个空的数组,
      会直接调用make_connection方法
    except IndexError:
      connection = self.make_connection()
    self._in_use_connections.add(connection)  #向代表正在使用的连接的集合中添加元素
    return connection  
  def make_connection(self): #在_available_connections数组为空时获取连接调用的方法
    "Create a new connection"
    if self._created_connections >= self.max_connections:  #判断创建的连接是否已经达到最大限制,max_connections可以通过参数初始化
      raise ConnectionError("Too many connections")
    self._created_connections += 1  #把代表已经创建的连接的数值+1
    return self.connection_class(**self.connection_kwargs)   #返回有效的连接,默认为Connection(**self.connection_kwargs)
  def release(self, connection): #释放连接,链接并没有断开,只是存在链接池中
    "Releases the connection back to the pool"
    self._checkpid()
    if connection.pid != self.pid:
      return
    self._in_use_connections.remove(connection)  #从集合中删除元素
    self._available_connections.append(connection) #并添加到_available_connections 的数组中
  def disconnect(self): #断开所有连接池中的链接
    "Disconnects all connections in the pool"
    all_conns = chain(self._available_connections,
             self._in_use_connections)
    for connection in all_conns:
      connection.disconnect()

execute_command最终调用的是Connection.send_command方法,关闭链接为 Connection.disconnect方法,而Connection类的实现:
 

class Connection(object):
  "Manages TCP communication to and from a Redis server"
  def __del__(self):  #对象删除时的操作,调用disconnect释放连接
    try:
      self.disconnect()
    except Exception:
      pass

核心的链接建立方法是通过socket模块实现:

 
   

def _connect(self):
    err = None
    for res in socket.getaddrinfo(self.host, self.port, 0,
                   socket.SOCK_STREAM):
      family, socktype, proto, canonname, socket_address = res
      sock = None
      try:
        sock = socket.socket(family, socktype, proto)
        # TCP_NODELAY
        sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
        # TCP_KEEPALIVE
        if self.socket_keepalive:  #构造函数中默认 socket_keepalive=False,因此这里默认为短连接
          sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
          for k, v in iteritems(self.socket_keepalive_options):
            sock.setsockopt(socket.SOL_TCP, k, v)
        # set the socket_connect_timeout before we connect
        sock.settimeout(self.socket_connect_timeout) #构造函数中默认socket_connect_timeout=None,即连接为blocking的模式
        # connect
        sock.connect(socket_address)
        # set the socket_timeout now that we're connected
        sock.settimeout(self.socket_timeout) #构造函数中默认socket_timeout=None
        return sock
      except socket.error as _:
        err = _
        if sock is not None:
          sock.close()
.....

关闭链接的方法:
 

def disconnect(self):
    "Disconnects from the Redis server"
    self._parser.on_disconnect()
    if self._sock is None:
      return
    try:
      self._sock.shutdown(socket.SHUT_RDWR) #先shutdown再close
      self._sock.close()
    except socket.error:
      pass
    self._sock = None

       
可以小结如下
1)默认情况下每创建一个Redis实例都会构造出一个ConnectionPool实例,每一次访问redis都会从这个连接池得到一个连接,操作完成后会把该连接放回连接池(连接并没有释放),可以构造一个统一的ConnectionPool,在创建Redis实例时,可以将该ConnectionPool传入,那么后续的操作会从给定的ConnectionPool获得连接,不会再重复创建ConnectionPool。
2)默认情况下没有设置keepalive和timeout,建立的连接是blocking模式的短连接。
3)不考虑底层tcp的情况下,连接池中的连接会在ConnectionPool.disconnect中统一销毁。

Python 相关文章推荐
python实现得到一个给定类的虚函数
Sep 28 Python
将Python中的数据存储到系统本地的简单方法
Apr 11 Python
python使用MySQLdb访问mysql数据库的方法
Aug 03 Python
Python的“二维”字典 (two-dimension dictionary)定义与实现方法
Apr 27 Python
python matlibplot绘制3D图形
Jul 02 Python
python中多个装饰器的执行顺序详解
Oct 08 Python
对Python3中bytes和HexStr之间的转换详解
Dec 04 Python
django认证系统 Authentication使用详解
Jul 22 Python
详解Python可视化神器Yellowbrick使用
Nov 11 Python
Django admin禁用编辑链接和添加删除操作详解
Nov 15 Python
python+tifffile之tiff文件读写方式
Jan 13 Python
Jupyter notebook快速入门教程(推荐)
May 18 Python
Python实现的数据结构与算法之快速排序详解
Apr 22 #Python
利用Fn.py库在Python中进行函数式编程
Apr 22 #Python
Python实现的数据结构与算法之基本搜索详解
Apr 22 #Python
Python实现的数据结构与算法之链表详解
Apr 22 #Python
Python实现的数据结构与算法之双端队列详解
Apr 22 #Python
Python实现的数据结构与算法之队列详解
Apr 22 #Python
详尽讲述用Python的Django框架测试驱动开发的教程
Apr 22 #Python
You might like
php入门学习知识点三 PHP上传
2011/07/14 PHP
手把手编写PHP框架 深入了解MVC运行流程
2016/09/19 PHP
PHP实现类似题库抽题效果
2018/08/16 PHP
使用vs code编辑调试php配置的方法
2019/01/29 PHP
B/S开发中常用javaScript技术与代码
2007/03/09 Javascript
一实用的实现table排序的Javascript类库
2007/09/12 Javascript
js+CSS 图片等比缩小并垂直居中实现代码
2008/12/01 Javascript
JavaScript Cookie 直接浏览网站分网址
2009/12/08 Javascript
Javascript异步编程模型Promise模式详细介绍
2014/05/08 Javascript
jQuery内容过滤选择器用法分析
2015/02/10 Javascript
javascript常用函数(2)
2015/11/05 Javascript
jQuery form插件的使用之处理server返回的JSON, XML,HTML数据
2016/01/26 Javascript
javascript实现右下角广告框效果
2017/02/01 Javascript
php简单数据库操作类的封装
2017/06/08 Javascript
vue.js全局API之nextTick全面解析
2017/07/07 Javascript
Javascript实现运算符重载详解
2018/04/07 Javascript
解决vue 退出动画无效的问题
2020/08/09 Javascript
在vue中实现清除echarts上次保留的数据(亲测有效)
2020/09/09 Javascript
JavaScript实现简单日历效果
2020/09/11 Javascript
在Python的Flask框架下收发电子邮件的教程
2015/04/21 Python
Python3远程监控程序的实现方法
2019/07/15 Python
Python交互式图形编程的实现
2019/07/25 Python
详谈tensorflow gfile文件的用法
2020/02/05 Python
StubHub哥伦比亚:购买和出售您的门票
2016/10/20 全球购物
婴儿鞋,独特的婴儿服装和配件:Zutano
2018/11/03 全球购物
时尚圣经:The Fashion Bible
2019/03/03 全球购物
英语三分钟演讲稿
2014/08/19 职场文书
励志演讲稿3分钟
2014/08/21 职场文书
2015年安全生产月工作总结
2015/07/27 职场文书
大学优秀学生主要事迹材料
2015/11/04 职场文书
队名及霸气口号大全
2015/12/25 职场文书
nginx如何将http访问的网站改成https访问
2021/03/31 Servers
go语言基础 seek光标位置os包的使用
2021/05/09 Golang
安装配置mysql及Navicat prenium的详细流程
2021/06/10 MySQL
pycharm无法安装cv2模块问题
2022/05/20 Python
Win11无法安装更新补丁KB3045316怎么办 附KB3045316补丁修复教程
2022/08/14 数码科技