四、Java内存数据库实践之深入浅出Redis - Java Client - Jedis的使用

一、使用Maven导入Jedis的相关jar包。

 

 

<dependencies>
    <dependency>
	    <groupId>redis.clients</groupId>
	    <artifactId>jedis</artifactId>
	    <version>2.2.0</version>
	    <type>jar</type>
	    <scope>compile</scope>
    </dependency>
  </dependencies>

 

 

二、配置Redis的pool以从pool中获取redis的对象：

#最大分配的对象数
redis.pool.maxActive=1024

#最大能够保持idel状态的对象数
redis.pool.maxIdle=200

#当池内没有返回对象时，最大等待时间
redis.pool.maxWait=1000

#当调用borrow Object方法时，是否进行有效性检查
redis.pool.testOnBorrow=false

#当调用return Object方法时，是否进行有效性检查
redis.pool.testOnReturn=true

#IP
redis.ip=192.168.1.155

#Port
redis.port=6379

 

三、相关的Java代码：

1、创建一个Java类用于管理Redis的Pool以产生Redis对象

package com.chuanliu.platform.activity.cache;

import java.util.ResourceBundle;



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

/**
 * Get the Redis Object from the Pool,
 * Redis using commons-pool to manage its own pool
 * 
 * @author Josh Wang(Sheng)
 *
 * @email  [e-mail]
 *
 */
public class RedisPoolManager {

	private static JedisPool pool;
	
	static {
		ResourceBundle bundle = ResourceBundle.getBundle("redis");
		if (bundle == null) 
			throw new IllegalArgumentException("[redis.properties] is not found");
		
		JedisPoolConfig config = new JedisPoolConfig();
		config.setMaxActive(Integer.valueOf(bundle.getString("redis.pool.maxActive")));
		config.setMaxIdle(Integer.valueOf(bundle.getString("redis.pool.maxIdle")));
		config.setMaxWait(Long.valueOf(bundle.getString("redis.pool.maxWait")));
		config.setTestOnBorrow(Boolean.valueOf(bundle.getString("redis.pool.testOnBorrow")));
		config.setTestOnReturn(Boolean.valueOf(bundle.getString("redis.pool.testOnReturn")));
		
		pool = new JedisPool(config, bundle.getString("redis.ip"), Integer.valueOf(bundle.getString("redis.port")));
	}
	
	/**
	 * Get Jedis resource from the pool
	 * @return
	 */
	public static Jedis createInstance() {
		Jedis jedis = pool.getResource();
		jedis.auth("diandi");
		return jedis;
	}
	
	/**
	 * Return the resource to pool
	 * @param jedis
	 */
	public static void returnResource(Jedis jedis) {
		pool.returnResource(jedis);
	}
}

 

2. 定义一个Java类用于使用获取到的Redis对象往内存中进行CRUD基本操作。

p/**
 * 
 */
package com.chuanliu.platform.activity.cache;

import java.util.List;
import java.util.Map;
import java.util.Set;

import org.springframework.stereotype.Component;

import com.sun.jersey.spi.resource.Singleton;

import redis.clients.jedis.Jedis;
import redis.clients.jedis.SortingParams;

/**
 * @author Josh Wang(Sheng)
 *
 * @email  [e-mail]
 *
 */
@Singleton
@Component("cacheManager")
public class CacheManager {

	private Jedis jedis = RedisPoolManager.createInstance();
	
	////////////////////Basic Functions(String related) - Start /////////////////////////////
	/**
	 * If the value existed, will override the value
	 * @param entries
	 */
	public void set(Map<String, String> entries) {
		for (Map.Entry<String, String> entry : entries.entrySet()) {
			jedis.set(entry.getKey(), entry.getValue());
		}
	}
	
	/**
	 * If the key exited, will override the value
	 * @param key
	 * @param value
	 */
	public void set(String key, String value) {
		jedis.set(key, value);
	}
	
	/**
	 * 
	 * @param entries
	 */
	public void setnx(Map<String, String> entries) {
		for (Map.Entry<String, String> entry : entries.entrySet()) {
			jedis.setnx(entry.getKey(), entry.getValue());
		}
	}
	
	/**
	 * Only set the value when the key not exist
	 * @param key
	 * @param value
	 */
	public void setnx(String key, String value) {
		jedis.setnx(key, value);
	}
	
	/**
	 * Set the value to the key and specify the key's life cycle as seconds.
	 * @param key
	 * @param live
	 * @param value
	 */
	public void setKeyLive(String key, int live, String value) {
		jedis.setex(key, live, value);
	}
	
	/**
	 * Append the value to an existing key
	 * @param key
	 * @param value
	 */
	public void append(String key, String value) {
		jedis.append(key, value);
	}
	
	/**
	 * Get the value by the given key
	 * @param key
	 * @return
	 */
	public String getValue(String key) {
		return jedis.get(key);
	}
	
	/**
	 * Get the values of the specified keys
	 * @param keys
	 * @return
	 */
	public List<String> getValues(String... keys) {
		return jedis.mget(keys);
	}
	
	/**
	 * remove the value by the key from the cache
	 * @param key
	 * @return
	 */
	public Long removeValue(String key) {
		return jedis.del(key);
	}
	
	/**
	 * Delete the expected values from the cache
	 * @param keys
	 * @return
	 */
	public Long removeValues(String... keys) {
		return jedis.del(keys);
	}
	
	/**
	 * Identify whether the key in the cache or not
	 * @param key
	 * @return
	 */
	public boolean exists(String key) {
		return jedis.exists(key);
	}
	
	/**
	 * Release the resource 
	 */
	public void returnSource() {
		RedisPoolManager.returnResource(jedis);
	}
	
	/**
	 * Clear the cache
	 */
	public String clear() {
		return jedis.flushDB();
	}
	
	/**
	 * Calculate the size of the cache
	 * @return
	 */
	public long calculateSize() {
		return jedis.dbSize();
	}
	
	/**
	 * Get and update the member by the key in the cache
	 * @param key
	 * @param value
	 * @return
	 */
	public String getSet(String key, String value) {
		return jedis.getSet(key, value);
	}
	
	/**
	 * 
	 * @param key
	 * @param startOffset
	 * @param endOffset
	 * @return
	 */
	public String getRange(String key, int startOffset, int endOffset) {
		return jedis.getrange(key, startOffset, endOffset);
	}
	
	////////////////////Basic Functions(String related) - End /////////////////////////////
	
	
	
	////////////////////List Functions - Start /////////////////////////////
	/**
	 * push the value to the given list
	 * 
	 * 将一个或多个值 value 插入到列表 key 的表头

     *如果有多个 value 值，那么各个 value 值按从左到右的顺序依次插入到表头： 
     *比如说，对空列表 mylist 执行命令 LPUSH mylist a b c ，列表的值将是 c b a ，
     *这等同于原子性地执行 LPUSH mylist a 、 LPUSH mylist b 和 LPUSH mylist c 三个命令。

     *如果 key 不存在，一个空列表会被创建并执行 LPUSH 操作。

     *当 key 存在但不是列表类型时，返回一个错误。
	 * 
	 * @param listName
	 * @param value
	 * @return
	 */
	public long add2List(String listName, String... values) {
		return jedis.lpush(listName, values);
	}
	
	/**
	 * get the list size
	 * @param listName
	 * @return
	 */
	public long getListSize(String listName) {
		return jedis.llen(listName);
	}
	
	/**
	 * Update the member on the index
	 * @param listName
	 * @param index
	 * @param value
	 */
	public void updateList(String listName, int index, String value) {
		jedis.lset(listName, index, value);
	}
	
	/**
	 * Get the value on the index
	 * @param listName
	 * @param index
	 * @return
	 */
	public String getIndexValue(String listName, int index) {
		return jedis.lindex(listName, index);
	}
	
	/**
	 * 根据参数 count 的值，移除列表中与参数 value 相等的元素。
	 * count 的值可以是以下几种：

     *count > 0 : 从表头开始向表尾搜索，移除与 value 相等的元素，数量为 count 。
     *count < 0 : 从表尾开始向表头搜索，移除与 value 相等的元素，数量为 count 的绝对值。
     *count = 0 : 移除表中所有与 value 相等的值。

	 * 
	 * @param listName
	 * @param count
	 * @param value
	 * @return
	 */
	public long removeLValue(String listName, int count, String value) {
		return jedis.lrem(listName, count, value);
	}
	
	/**
	 * Remove the value out side of the range
	 * 
	 * @param listName
	 * @param start
	 * @param end
	 * @return
	 */
	public String removeOutterValue(String listName, int start, int end) {
		return jedis.ltrim(listName, start, end);
	}
	
	/**
	 * Pop the lists
	 * @param listName
	 * @return
	 */
	public String popList(String listName) {
		return jedis.lpop(listName);
	}
	
	/**
	 * Get the specified list values
	 * 
	 * 返回列表 key 中指定区间内的元素，区间以偏移量 start 和 stop 指定。

	 * 下标(index)参数 start 和 stop 都以 0 为底，也就是说，以 0 表示列表的第一个元素，以 1 表示列表的第二个元素，以此类推。
     
	 * 你也可以使用负数下标，以 -1 表示列表的最后一个元素， -2 表示列表的倒数第二个元素，以此类推
	 * 
	 * 注意LRANGE命令和编程语言区间函数的区别

	        假如你有一个包含一百个元素的列表，对该列表执行 LRANGE list 0 10 ，结果是一个包含11个元素的列表，
	        这表明 stop 下标也在 LRANGE 命令的取值范围之内(闭区间)，  这和某些语言的区间函数可能不一致，
	        比如Ruby的 Range.new 、 Array#slice 和Python的 range() 函数
	 * 
	 * @param listName
	 * @param start
	 * @param end
	 * @return
	 */
	public List<String> getListValues(String listName, long start, long end) {
		return jedis.lrange(listName, start, end);
	}
	
	/**
	 * Get all of the values of the list
	 * 
	 * @param listName
	 * @return
	 */
	public List<String> getAllListValues(String listName) {
		return jedis.lrange(listName, 0, -1);
	}
	
	/**
	 * Sort the list
	 * @param listName
	 * @return
	 */
	public List<String> sort(String listName) {
		return jedis.sort(listName);
	}
	
	/**
	 * 
	 * @param key
	 * @param params
	 * @param dstKey
	 * @return
	 */
	public Long sort(String key, SortingParams params, String dstKey) {
		return jedis.sort(key, params, dstKey);
	}
	
	////////////////////List Functions - End /////////////////////////////
	
	
	////////////////////Set Functions - Start /////////////////////////////
	/**
	 * Identify whether the member in the given set or not
	 * @param setName
	 * @param member
	 * @return
	 */
	public boolean exists(String setName, String member) {
		return jedis.sismember(setName, member);
	}
	
	/**
	 * Add the members to set
	 * @param setName
	 * @param members
	 * @return
	 */
	public long add2Set(String setName, String... members) {
		return jedis.sadd(setName, members);
	}
	
	/**
	 * Get all of the values of the set
	 * 
	 * @param setName
	 * @return
	 */
	public Set<String> getAllSetValues(String setName) {
		return jedis.smembers(setName);
	}
	
	/**
	 * Remove members from the set
	 * 
	 * @param setName
	 * @param members
	 * @return
	 */
	public Long removeSValues(String setName, String ... members) {
		return jedis.srem(setName, members);
	}
	
	/**
	 * Set Pop
	 * @param setName
	 * @return
	 */
	public String popSet(String setName) {
		return jedis.spop(setName);
	}
	
	/**
	 * 交集
	 * Get the intersection 
	 * @param sets
	 * @return
	 */
	public Set<String> intersection(String... sets) {
		return jedis.sinter(sets);
	}
	
	/**
	 * 并集
	 * Get the union set of the given sets
	 * @param sets
	 * @return
	 */
	public Set<String> union(String... sets) {
		return jedis.sunion(sets);
	}
	
	/**
	 * 差集
	 * Get the difference set of the given sets
	 * 
	 * @param sets
	 * @return
	 */
	public Set<String> diff(String... sets) {
		return jedis.sdiff(sets);
	}
	
	////////////////////Set Functions - End /////////////////////////////
	
	
	////////////////////Sorted Set Functions - Start /////////////////////////////
	/**
	 * 将一个或多个 member 元素及其 score 值加入到有序集 key 当中。
	 * 如果某个 member 已经是有序集的成员，那么更新这个 member 的 score 值，并通过重新插入这个 member 元素，
	 * 来保证该 member 在正确的位置上。
	 * 
	 * 
	 * @param ssetName - 如果 ssetName 不存在，则创建一个空的有序集并执行 ZADD 操作。
	 * 					   当 ssetName 存在但不是有序集类型时，返回一个错误。
	 * @param score - 可以是整数值或者双精度浮点数，用于排序
	 * @param member
	 * @return
	 */
	public long add2SSet(String ssetName, double score, String member) {
		return jedis.zadd(ssetName, score, member);
	}
	
	/**
	 * Return the size of the sorted set
	 * @param sset
	 * @return
	 */
	public long card(String sset) {
		return jedis.zcard(sset);
	}
	
	/**
	 * Get the sub set 
	 * @param sset
	 * @param start
	 * @param end
	 * @return
	 */
	public Set<String> getSubSet(String sset, long start, long end) {
		return jedis.zrange(sset, start, end);
	}
	
	/**
	 * Get the index of the member
	 * @param sset
	 * @param member
	 * @return
	 */
	public Double getIndex(String sset, String member) {
		return jedis.zscore(sset, member);
	}
	
	/**
	 * Remove the members 
	 * @param sset
	 * @param members
	 * @return
	 */
	public Long removeSSValues(String sset, String ...members) {
		return jedis.zrem(sset, members);
	}
	
	/**
	 * Get all of the values of the sorted set
	 * @param sset
	 * @return
	 */
	public Set<String> getAllSSValues(String sset) {
		return jedis.zrange(sset, 0, -1);
	}
	
	/**
	 * 
	 * @param sset
	 * @param start
	 * @param end
	 * @return
	 */
	public Long countRange(String sset, double start, double end) {
		return jedis.zcount(sset, start, end);
	}
	
	////////////////////Sorted Set Functions - End /////////////////////////////
	
	
	////////////////////Hash Map Functions - Start /////////////////////////////
	/**
	 * Push the value to the map on the key
	 * @param map
	 * @param key
	 * @param value
	 * @return
	 */
	public long push(String map, String key, String value) {
		return jedis.hset(map, key, value);
	}
	
	/**
	 * Identify whether the key exist or not
	 * @param map
	 * @param key
	 * @return
	 */
	public boolean hexists(String map, String key) {
		return jedis.hexists(map, key);
	}
	
	/**
	 * Get the value of the key
	 * @param map
	 * @param key
	 * @return
	 */
	public String getValue(String map, String key) {
		return jedis.hget(map, key);
	}
	
	/**
	 * Get the values of the keys 
	 * 
	 * @param map
	 * @param keys
	 * @return
	 */
	public List<String> getHValues(String map, String... keys) {
		return jedis.hmget(map, keys);
	}
	
	/**
	 * Remove the values by the keys
	 * @param map
	 * @param keys
	 * @return
	 */
	public Long removeHValues(String map, String ... keys) {
		return jedis.hdel(map, keys);
	}
	
	/**
	 * Increment the value on the key for the map
	 * @param map
	 * @param key
	 * @param value
	 * @return
	 */
	public Long increment(String map, String key, long value) {
		return jedis.hincrBy(map, key, value);
	}
	
	/**
	 * Get all of the keys of the map
	 * @param map
	 * @return
	 */
	public Set<String> getKeys(String map) {
		return jedis.hkeys(map);
	}
	
	/**
	 * Get all of the values of the map
	 * @param map
	 * @return
	 */
	public List<String> getValues(String map) {
		return jedis.hvals(map);
	}
	
	////////////////////Hash Map Functions - End //////////////////////////////
}

 

3. 创建相关的Unit Test类进行测试

/**
 * 
 */
package com.chuanliu.platform.activity.cache;


import javax.annotation.Resource;


import org.junit.Before;
import org.junit.Test;



import com.chuanliu.platform.activity.basic.test.SpringBaseTest;


/**
 * @author Josh Wang(Sheng)
 *
 * @email  [e-mail]
 */

public class TestCacheManager extends SpringBaseTest {
	
	private @Resource CacheManager cacheManager;
	
	@Before
	public void init() {
		printHighlight(cacheManager.hashCode() + "");
	}
	
	@Test
	public void basicTest() {
		print("============= Basic1 ==========================");
		
		// 清空数据
		print(cacheManager.clear());
		
		print(cacheManager.exists("josh"));
		
		// 存储数据
		cacheManager.set("josh", "WangSheng");
		
		print(cacheManager.exists("josh"));
		
		print(cacheManager.getValue("josh"));
		
		print("============= Basic 2 ==========================");
		
		// 若key不存在，则存储
		cacheManager.setnx("josh", "wang sheng");
		print(cacheManager.getValue("josh"));
		
		// 覆盖数据
		cacheManager.set("josh", "wang sheng");
		print(cacheManager.getValue("josh"));
		
		// 追加数据
		cacheManager.append("josh", "Lily");
		print(cacheManager.getValue("josh"));
		
		print("============= Basic 3 ==========================");
		
		// 设置key的有效期，并存储数据
		cacheManager.setKeyLive("josh", 2, "WangSheng-Lily");
		print(cacheManager.getValue("josh"));
		
		try {
			Thread.sleep(3000);
			print(cacheManager.getValue("josh"));
		} catch (InterruptedException e) {
			print("Josh released  ... now ^_^");
		}
		
		
		
		print("============= Basic 4 ==========================");
		
		// 获取并更改数据
		cacheManager.getSet("josh", "wang sheng");
		print(cacheManager.getValue("josh"));
		
		print("============= Basic 5 ==========================");
		// 截取value的值
		print(cacheManager.getRange("josh", 1, 3));
		
		cacheManager.set("MJ", "Jordan");
		
		print(cacheManager.getValues("josh", "MJ"));
		
		print("============= Basic 6 ==========================");
		cacheManager.removeValues(new String[]{"josh", "MJ"});
		
		print(cacheManager.getValues("josh", "MJ"));
	}
	
	/**
	 * List 是无序的，所以测试结果和expect的结果可能不一致
	 * 
	 * 还是是从-1开始？
	 */
	@Test
	public void listTest() {
		System.out.println("============= list1 ==========================");
		// 清空数据
		print(cacheManager.clear());
		
		// 添加数据
		cacheManager.add2List("ball", "Jordan");
		cacheManager.add2List("ball", "Maddie");
		cacheManager.add2List("ball", "AI");
		cacheManager.add2List("ball", "Yao");

		// The order should be : Yao, AI, Maddie, Jordan
		
		// 数组长度
		print(cacheManager.getListSize("ball"));
		
		print(cacheManager.getAllListValues("ball"));
		
		print(cacheManager.getListValues("ball", 0, -1));
		
		System.out.println("============= list2 ==========================");
		
		// 修改列表中单个值
		cacheManager.updateList("ball", 1, "Allen Iversen");
		print(cacheManager.getListValues("ball", 0, 3));
		
		// 获取列表指定下标的值
		print(cacheManager.getIndexValue("ball", 2));
		
		// 删除列表指定下标的值
		print(cacheManager.removeLValue("ball", 1, "Yao"));
		print(cacheManager.getAllListValues("ball"));
		
		// 删除区间以外的数据
		print(cacheManager.removeOutterValue("ball", 0, 1));
		print(cacheManager.getAllListValues("ball"));
		
		// 列表出栈
		print(cacheManager.popList("ball"));
	}
	
	@Test
	public void testSet() {
		print("========================= Set ====================");
		
		// 清空数据
		print(cacheManager.clear());
		
		// 添加数据
		cacheManager.add2Set("ball", "Jordan");
		cacheManager.add2Set("ball", "Maddie");
		cacheManager.add2Set("ball", "AI");
		cacheManager.add2Set("ball", "Yao");
		
		// 判断value是否在列表中
		print(cacheManager.exists("ball", "AI"));
		print(cacheManager.exists("ball", "Yao "));
		
		// 整个列表的值
		print(cacheManager.getAllSetValues("ball"));
		
		// 删除指定的元素
		print(cacheManager.removeSValues("ball", "Yao"));
		
		// 出栈
		print(cacheManager.popSet("ball"));
		
		// 整个列表的值
		print(cacheManager.getAllSetValues("ball"));
		
		cacheManager.add2Set("bball", "Jordan");
		cacheManager.add2Set("bball", "Maddie");
		cacheManager.add2Set("bball", "AI");
		cacheManager.add2Set("bball", "Yao");
		
		cacheManager.add2Set("fball", "Jordan");
		cacheManager.add2Set("fball", "Ronaldo");
		cacheManager.add2Set("fball", "Rivaldo");
		cacheManager.add2Set("fball", "Cristiano Ronaldo");
		cacheManager.add2Set("fball", "Ronaldinho");
		
		// 交集
		print(cacheManager.intersection("bball", "fball"));
		
		// 并集
		print(cacheManager.union("bball", "fball"));
		
		// 差集
		print(cacheManager.diff("bball", "fball"));
		
	}
	
	@Test
	public void testHash() {
		System.out.println("=============  hash ==========================");
		
		// 清空数据
		print(cacheManager.clear());
		
		// 添加数据
		cacheManager.push("hball", "Jordan", "Chicago");
		cacheManager.push("hball", "Maddie", "Houston");
		cacheManager.push("hball", "AI", "Philadelphia");
		cacheManager.push("hball", "Yao", "Houston");
		
		// 判断某个值是否存在
		print(cacheManager.hexists("hball", "Yao "));
		print(cacheManager.hexists("hball", "AI"));
		
		// 获取指定的值
		print(cacheManager.getValue("hball", "Jordan"));
		
		// 批量获取指定的值
		print(cacheManager.getHValues("hball", "Jordan", "Maddie"));
		
		// 删除指定的值
		print(cacheManager.removeHValues("hball", "Yao"));
		
		// 为key中的域 field 的值加上增量 increment, hash value must be a data value
		// print(cacheManager.increment("hball", "Jordan", 123l));
		
		// 获取所有的keys
		print(cacheManager.getKeys("hball"));
		
		// 获取所有的values
		print(cacheManager.getValues("hball"));
	}
	
}

 

这一篇讲了基本的Jedis的使用，下一篇讲接着讲解Jedis的高级使用，即Sharding。

 

 

 

 

评论

2 楼 Josh_Persistence 2015-01-22  

你好，CacheManager是单例的，这个地方忘记贴出相关代码了。

1 楼 忆苔青 2015-01-14  

写得很不错，请问在CacheManager这个之类中的Jedis成员变量是线程安全的吗？而且使用的是单例对吧；看到https://github.com/xetorthio/jedis/wiki/Getting-started中有说道“A single Jedis instance is not threadsafe!”有点疑惑