ConnectionPool实现redis在python中的连接

迷南。 2021-11-11 08:56 195阅读 0赞

这篇文章主要介绍了Python与Redis的连接教程,Redis是一个高性能的基于内存的数据库,需要的朋友可以参考下

今天在写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

使用的方法：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>r</code> 
      <code>=</code> 
      <code>redis.StrictRedis(host</code> 
      <code>=</code> 
      <code>xxxx, port</code> 
      <code>=</code> 
      <code>xxxx, db</code> 
      <code>=</code> 
      <code>xxxx)</code> 
     </div> 
     <div> 
      <code>r.xxxx()</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

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

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>pool </code> 
      <code>=</code> 
      <code>redis.ConnectionPool(host</code> 
      <code>=</code> 
      <code>xxx, port</code> 
      <code>=</code> 
      <code>xxx, db</code> 
      <code>=</code> 
      <code>xxxx)</code> 
     </div> 
     <div> 
      <code>r </code> 
      <code>=</code> 
      <code>redis.Redis(connection_pool</code> 
      <code>=</code> 
      <code>pool)</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

这里Redis是StrictRedis的子类 简单分析如下： 在StrictRedis类的\_\_init\_\_方法中，可以初始化connection\_pool这个参数，其对应的是一个ConnectionPool的对象：

[?][Link 1]

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

[?][Link 1]

在来看看ConnectionPool类：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div> 
    <div>
      15 
    </div> 
    <div>
      16 
    </div> 
    <div>
      17 
    </div> 
    <div>
      18 
    </div> 
    <div>
      19 
    </div> 
    <div>
      20 
    </div> 
    <div>
      21 
    </div> 
    <div>
      22 
    </div> 
    <div>
      23 
    </div> 
    <div>
      24 
    </div> 
    <div>
      25 
    </div> 
    <div>
      26 
    </div> 
    <div>
      27 
    </div> 
    <div>
      28 
    </div> 
    <div>
      29 
    </div> 
    <div>
      30 
    </div> 
    <div>
      31 
    </div> 
    <div>
      32 
    </div> 
    <div>
      33 
    </div> 
    <div>
      34 
    </div> 
    <div>
      35 
    </div> 
    <div>
      36 
    </div> 
    <div>
      37 
    </div> 
    <div>
      38 
    </div> 
    <div>
      39 
    </div> 
    <div>
      40 
    </div> 
    <div>
      41 
    </div> 
    <div>
      42 
    </div> 
    <div>
      43 
    </div> 
    <div>
      44 
    </div> 
    <div>
      45 
    </div> 
    <div>
      46 
    </div> 
    <div>
      47 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>class</code> 
      <code>ConnectionPool(</code> 
      <code>object</code> 
      <code>): </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>...........</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>def</code> 
      <code>__init__(</code> 
      <code>self</code> 
      <code>, connection_class</code> 
      <code>=</code> 
      <code>Connection, max_connections</code> 
      <code>=</code> 
      <code>None</code> 
      <code>,</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>*</code> 
      <code>*</code> 
      <code>connection_kwargs):&nbsp; </code> 
      <code>#类初始化时调用构造函数</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>max_connections </code> 
      <code>=</code> 
      <code>max_connections </code> 
      <code>or</code> 
      <code>2</code> 
      <code>*</code> 
      <code>*</code> 
      <code>31</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>if</code> 
      <code>not</code> 
      <code>isinstance</code> 
      <code>(max_connections, (</code> 
      <code>int</code> 
      <code>, </code> 
      <code>long</code> 
      <code>)) </code> 
      <code>or</code> 
      <code>max_connections &lt; </code> 
      <code>0</code> 
      <code>: </code> 
      <code>#判断输入的max_connections是否合法</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>raise</code> 
      <code>ValueError(</code> 
      <code>'"max_connections" must be a positive integer'</code> 
      <code>)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>.connection_class </code> 
      <code>=</code> 
      <code>connection_class </code> 
      <code>#设置对应的参数</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>.connection_kwargs </code> 
      <code>=</code> 
      <code>connection_kwargs</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>.max_connections </code> 
      <code>=</code> 
      <code>max_connections</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>.reset() </code> 
      <code>#初始化ConnectionPool 时的reset操作</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>def</code> 
      <code>reset(</code> 
      <code>self</code> 
      <code>):</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>.pid </code> 
      <code>=</code> 
      <code>os.getpid()</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._created_connections </code> 
      <code>=</code> 
      <code>0</code> 
      <code>#已经创建的连接的计数器</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._available_connections </code> 
      <code>=</code> 
      <code>[]&nbsp; </code> 
      <code>#声明一个空的数组，用来存放可用的连接</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._in_use_connections </code> 
      <code>=</code> 
      <code>set</code> 
      <code>() </code> 
      <code>#声明一个空的集合，用来存放已经在用的连接</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._check_lock </code> 
      <code>=</code> 
      <code>threading.Lock()</code> 
     </div> 
     <div> 
      <code>.......</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>def</code> 
      <code>get_connection(</code> 
      <code>self</code> 
      <code>, command_name, </code> 
      <code>*</code> 
      <code>keys, </code> 
      <code>*</code> 
      <code>*</code> 
      <code>options): </code> 
      <code>#在连接池中获取连接的方法</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>"Get a connection from the pool"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._checkpid()</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>try</code> 
      <code>:</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>connection </code> 
      <code>=</code> 
      <code>self</code> 
      <code>._available_connections.pop() </code> 
      <code>#获取并删除代表连接的元素，在第一次获取connectiong时，因为_available_connections是一个空的数组，</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>会直接调用make_connection方法</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>except</code> 
      <code>IndexError:</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>connection </code> 
      <code>=</code> 
      <code>self</code> 
      <code>.make_connection()</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._in_use_connections.add(connection)&nbsp; </code> 
      <code>#向代表正在使用的连接的集合中添加元素</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>connection&nbsp; </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>def</code> 
      <code>make_connection(</code> 
      <code>self</code> 
      <code>): </code> 
      <code>#在_available_connections数组为空时获取连接调用的方法</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>"Create a new connection"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>if</code> 
      <code>self</code> 
      <code>._created_connections &gt;</code> 
      <code>=</code> 
      <code>self</code> 
      <code>.max_connections:&nbsp; </code> 
      <code>#判断创建的连接是否已经达到最大限制，max_connections可以通过参数初始化</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>raise</code> 
      <code>ConnectionError(</code> 
      <code>"Too many connections"</code> 
      <code>)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._created_connections </code> 
      <code>+</code> 
      <code>=</code> 
      <code>1</code>&nbsp; 
      <code>#把代表已经创建的连接的数值+1</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>self</code> 
      <code>.connection_class(</code> 
      <code>*</code> 
      <code>*</code> 
      <code>self</code> 
      <code>.connection_kwargs)&nbsp;&nbsp; </code> 
      <code>#返回有效的连接，默认为Connection(**self.connection_kwargs)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>def</code> 
      <code>release(</code> 
      <code>self</code> 
      <code>, connection): </code> 
      <code>#释放连接，链接并没有断开，只是存在链接池中</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>"Releases the connection back to the pool"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._checkpid()</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>if</code> 
      <code>connection.pid !</code> 
      <code>=</code> 
      <code>self</code> 
      <code>.pid:</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._in_use_connections.remove(connection)&nbsp; </code> 
      <code>#从集合中删除元素</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._available_connections.append(connection) </code> 
      <code>#并添加到_available_connections 的数组中</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>def</code> 
      <code>disconnect(</code> 
      <code>self</code> 
      <code>): </code> 
      <code>#断开所有连接池中的链接</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>"Disconnects all connections in the pool"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>all_conns </code> 
      <code>=</code> 
      <code>chain(</code> 
      <code>self</code> 
      <code>._available_connections,</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._in_use_connections)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>for</code> 
      <code>connection </code> 
      <code>in</code> 
      <code>all_conns:</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>connection.disconnect()</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

execute\_command最终调用的是Connection.send\_command方法，关闭链接为 Connection.disconnect方法，而Connection类的实现：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>class</code> 
      <code>Connection(</code> 
      <code>object</code> 
      <code>):</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>"Manages TCP communication to and from a Redis server"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>def</code> 
      <code>__del__(</code> 
      <code>self</code> 
      <code>):&nbsp; </code> 
      <code>#对象删除时的操作，调用disconnect释放连接</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>try</code> 
      <code>:</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>.disconnect()</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>except</code> 
      <code>Exception:</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>pass</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

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

[?][Link 1]

关闭链接的方法：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>def</code> 
      <code>disconnect(</code> 
      <code>self</code> 
      <code>):</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>"Disconnects from the Redis server"</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._parser.on_disconnect()</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>if</code> 
      <code>self</code> 
      <code>._sock </code> 
      <code>is</code> 
      <code>None</code> 
      <code>:</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>try</code> 
      <code>:</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._sock.shutdown(socket.SHUT_RDWR) </code> 
      <code>#先shutdown再close</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._sock.close()</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>except</code> 
      <code>socket.error:</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>pass</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;</code> 
      <code>self</code> 
      <code>._sock </code> 
      <code>=</code> 
      <code>None</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

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

转载于:https://www.cnblogs.com/kenD/p/11127790.html

[Link 1]: http://www.jb51.net/article/64646.htm#