Jedis集成与踩坑经历

Jedis简介

Jedis是Redis的Java客户端实现，封装了对Redis的通信和命令处理等。

Jedis提供了资源池，可以很方便地实现对Redis的API调用。

之前是通过组内对Jedis封装的Spring Bean来获取和使用Jedis的，现在希望自行实现类似功能，设计目标如下：

具体思路就是针对设计目标而定的：

由于需求比较基础，还没有太多应用场景，实现也没考虑太复杂。整体逻辑不到50行，可以在我的GitHub上大致看一下。

后续使用可以直接使用Spring将Bean注入。

由于不按常规方法使用JedisPool可能背离了JedisPool设计的使用场景，因此在其中踩了不少坑。

其次，虽然平常常用组内的Jedis组件，但实际上对Jedis的API不了解，本次根据平常使用过程中的一些感受进行“黑盒临摹”，在爬坑过程中其实也学习了其他一些方面的经验，比如Guava Reflections等。

背景

最开始通过FactoryBean提供的连接并未使用动态代理，也就是说仅提供了一个Jedis，所有线程使用同一个Jedis连接。

现象

业务中较频繁地报异常，异常信息为java.lang.ClassCastException: java.util.ArrayList cannot be cast to [B等，基本是ClassCastException，异常抛出位置为调用Jedis的位置。

初看以为是Jedis的泛型bug，但不是必现，可以排除这种猜测；
有人认为是对于Redis的响应命令处理不完善，如OK、NIL等响应，但这种bug太低级了，不应该出现在Jedis这种久经考验的库中，排除；
有人认为发生异常情况时Jedis的buffer未清空，导致后续使用中残存之前的错误数据，这个倒是有点道理，因为这种情况不是必现，但同上一条，不应该出现在这种库中；

原因

最终在另一篇资料指引下来到jedis/issues，在参考资料中发现了最可信最合理的原因：Jedis并非线程安全，不应当并发操作。

正确使用

Single connection. Single thread.

正如参考资料中回答提到的，每个线程（每次调用）都从JedisPool中获取一个连接，并在使用后归还。

也正是因为这一点跟最初的FactoryBean封装方式冲突了，后来才改用提供动态代理类的方式封装FactoryBean。

背景

我使用的Jedis版本为3.0.1，网上的不少资料指出在使用连接后归还可以使用JedisPool的void returnResource(Jedis resource)方法，但在3.0.1版本中这个方法是protected可见的，没有间接调用方法。

另外Jedis源码中找不到注释，这有点奇怪，我想当然地认为版本升级后可以自动归还资源了，于是仅在设置最大连接数之后就部署到业务中了。

现象

业务线程启动后每访问一定次数（调用Jedis达到一定次数）后就完全不响应请求了：

后续所有请求超时无响应
CPU正常，内存正常
Java线程有不少处于等待状态，GC正常，但从日志看没有任何请求到达Servlet
Nginx（用于反向代理）日志中响应状态码是499
- 499是Nginx自定义的，对应的是client has closed connection即用户浏览器断开Http连接了

还是在参考资料的指引下查看Tomcat监听的端口，的确很多连接处于CLOSE_WAIT状态，表明客户端已断开连接（我自己测试的时候刷新页面太多，很多就中途断开了）。

原因

结合TCP四次挥手过程，应该是中间有资源释放不了导致没有进入LAST_ACK状态，推测是Jedis连接资源未归还而总连接数有限制，导致很多线程在等待获取Jedis资源。

正确使用

在Jedis连接使用完毕后，需要调用Jedis的close()方法将资源归还JedisPool，close方法是用于替代returnResource方法的。

这个方法语义比较奇怪，真实作用是“归还或关闭连接”，最开始其实就是考虑到资源复用的问题才没有考虑使用这个close方法的。