小项目整合Jedis并带自动释放

背景

有些时候，项目特别小，比如并没有整合SpringBoot这样的框架，仅仅是一个Console程序。简单使用Jedis的话，经常会忘了jedis.close()操作而导致资源被占满。所以，写个带自动释放的工具类。

加上依赖

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>3.2.0</version>
</dependency>

配置文件 config.properties

#Redis
redis_host=100.xx.xx.xx
redis_port=6379
redis_password=yourPassword
redis_database=1

执行接口 RedisCallable.java

package Util;

import redis.clients.jedis.Jedis;

@FunctionalInterface
public interface RedisCallable {
   void call(Jedis jedis);
}

工具类 RedisUtil.java

package Util;

import Common.PropertiesUtil;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;

import java.nio.file.Paths;

public class RedisUtil {
    static String configPath = "config.properties";
    //服务器IP地址
    private static String ADDR = "读取配置文件失败时的默认地址，如:192.168.xx.xx";
    //端口
    private static int PORT = 6379;
    //密码
    private static String AUTH = "读取配置文件失败时的默认密码，没有则空";
    //连接实例的最大连接数
    private static int MAX_ACTIVE = 200;
    //控制一个pool最少有多少个状态为idle(空闲的)的jedis实例，默认值是0。
    private static int MIN_IDLE= 5;
    //控制一个pool最多有多少个状态为idle(空闲的)的jedis实例，默认值也是8。
    private static int MAX_IDLE = 15;
    //等待可用连接的最大时间，单位毫秒，默认值为-1，表示永不超时。如果超过等待时间，则直接抛出JedisConnectionException
    private static int MAX_WAIT = 10000;
    //连接超时的时间　　
    private static int TIMEOUT = 10000;
    // 在borrow一个jedis实例时，是否提前进行validate操作；如果为true，则得到的jedis实例均是可用的；
    private static boolean TEST_ON_BORROW = true;

    private static JedisPool jedisPool = null;
    //数据库模式是16个数据库 0~15
    public static int DEFAULT_DATABASE = 2;
    /**
     * 初始化Redis连接池
     */

    static {

        try {

            JedisPoolConfig config = new JedisPoolConfig();
            config.setMaxTotal(MAX_ACTIVE);
            config.setMinIdle(MIN_IDLE);
            config.setMaxIdle(MAX_IDLE);
            config.setMaxWaitMillis(MAX_WAIT);
            config.setTestOnBorrow(TEST_ON_BORROW);
            config.setBlockWhenExhausted(true);


            PropertiesUtil propertiesUtil = new PropertiesUtil(Paths.get(System.getProperty("user.dir")).resolve(configPath).toString());
            ADDR=propertiesUtil.readValue("redis_host");
            PORT=Integer.parseInt(propertiesUtil.readValue("redis_port"));
            AUTH=propertiesUtil.readValue("redis_password");
            DEFAULT_DATABASE = Integer.parseInt(propertiesUtil.readValue("redis_database"));

            if (!AUTH.isEmpty()) {
                jedisPool = new JedisPool(config, ADDR, PORT, TIMEOUT,AUTH,DEFAULT_DATABASE);
            }else {
                jedisPool=new JedisPool(config, ADDR, PORT, TIMEOUT,null,DEFAULT_DATABASE);

            }


        } catch (Exception e) {

            e.printStackTrace();
        }

    }

    /**
     * 带自动释放的执行redis操作，建议使用这个
     * @param callable
     * example:  (jedis)->{jedis.get("key")}
     */
    public static void execute(RedisCallable callable){
        try(Jedis jedis=jedisPool.getResource()){
            callable.call(jedis);
        }
    }

    /**
     * 获取Jedis实例，需要手工close，不建议使用
     */
    @Deprecated
    public synchronized static Jedis getJedis() {

        try {

            if (jedisPool != null) {
                Jedis resource = jedisPool.getResource();
                //System.out.println("redis--服务正在运行: "+resource.ping());
                return resource;
            } else {
                return null;
            }

        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }

    }

    /***
     *
     * 释放资源
     */

    public static void returnResource(final Jedis jedis) {
        if(jedis != null) {
            //jedisPool.returnResource(jedis);
            jedis.close();
        }

    }
}

使用

public static void main(String[] args){
	RedisUtil.execute(jedis -> {
    	String value = jedis.get("key");
    	System.out.println(value);
	});
	//自动释放，无须close操作
	//其他代码。。。
}