基于Sentinel的Redis集群(主从&Sharding)的redis封装实现

本文介绍了如何使用Sentinel进行Redis集群的主从和Sharding配置，包括配置文件、Maven依赖、Spring配置以及封装的ShardedJedisSentinelPool类。通过这个封装类，可以实现对Redis集群的连接管理和故障切换，确保高可用性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、redis配置文件ps_redis.properties：

#数据分片参数配置
shard1=xxx
shard2=xxx
#Sentinel服务器参数配置
sentinel1=xxx
sentinel2=xxx

sentinel3=xxx

2、maven依赖

<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.7.2</version>
<type>jar</type>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>commons-pool</groupId>
<artifactId>commons-pool</artifactId>
<version>1.6</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
<version>2.0</version>
<type>jar</type>
<scope>compile</scope>
</dependency>

3、Spring中的配置文件redis.xml：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.0.xsd"
default-lazy-init="true" default-autowire="byName">


<context:property-placeholder location="file:/opt/search/resourse/ps_redis.properties"/>
<context:component-scan base-package="com.suning.cache"/>
<bean id="shardedJedisPool" class="com.suning.cache.ShardedJedisSentinelPool">
<constructor-arg index="0" ref="jedisPoolConfig" />

<constructor-arg index="1">
<list>
<value>${shard1}</value>
<value>${shard2}</value>
</list>
</constructor-arg>

<constructor-arg index="2">
<set>
<value>${sentinel1}</value>
<value>${sentinel2}</value>
<value>${sentinel3}</value>
</set>
</constructor-arg>
</bean>

<bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig">
<property name="maxTotal" value="200" />
<property name="maxIdle" value="100" />
<property name="maxWaitMillis" value="5000" />
<property name="testOnBorrow" value="true" />
</bean>



</beans>

4、封装类ShardedJedisSentinelPool.java （关键）转载自http://itindex.net/detail/48192-redis-sentinel-redis

package com.suning.cache;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.logging.Logger;
import java.util.regex.Pattern;

import org.apache.commons.pool2.PooledObject;
import org.apache.commons.pool2.PooledObjectFactory;
import org.apache.commons.pool2.impl.DefaultPooledObject;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;

import redis.clients.jedis.HostAndPort;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPubSub;
import redis.clients.jedis.JedisShardInfo;
import redis.clients.jedis.Protocol;
import redis.clients.jedis.ShardedJedis;
import redis.clients.jedis.exceptions.JedisConnectionException;
import redis.clients.util.Hashing;
import redis.clients.util.Pool;

public class ShardedJedisSentinelPool extends Pool<ShardedJedis> {

public static final int MAX_RETRY_SENTINEL = 10;

protected final Logger log = Logger.getLogger(getClass().getName());

protected GenericObjectPoolConfig poolConfig;

protected int timeout = Protocol.DEFAULT_TIMEOUT;

private int sentinelRetry = 0;

protected String password;

protected int database = Protocol.DEFAULT_DATABASE;

protected Set<MasterListener> masterListeners = new HashSet<MasterListener>();

private volatile List<HostAndPort> currentHostMasters;

public ShardedJedisSentinelPool(List<String> masters, Set<String> sentinels) {
this(masters, sentinels, new GenericObjectPoolConfig(),
Protocol.DEFAULT_TIMEOUT, null, Protocol.DEFAULT_DATABASE);
}

public ShardedJedisSentinelPool(List<String> masters, Set<String> sentinels, String password) {
this(masters, sentinels, new GenericObjectPoolConfig(),
Protocol.DEFAULT_TIMEOUT, password);
}

public ShardedJedisSentinelPool(final GenericObjectPoolConfig poolConfig, List<String> masters, Set<String> sentinels) {
this(masters, sentinels, poolConfig, Protocol.DEFAULT_TIMEOUT, null,
Protocol.DEFAULT_DATABASE);
}

public ShardedJedisSentinelPool(List<String> masters, Set<String> sentinels,
final GenericObjectPoolConfig poolConfig, int timeout,
final String password) {
this(masters, sentinels, poolConfig, timeout, password,
Protocol.DEFAULT_DATABASE);
}

public ShardedJedisSentinelPool(List<String> masters, Set<String> sentinels,
final GenericObjectPoolConfig poolConfig, final int timeout) {
this(masters, sentinels, poolConfig, timeout, null,
Protocol.DEFAULT_DATABASE);
}

public ShardedJedisSentinelPool(List<String> masters, Set<String> sentinels,
final GenericObjectPoolConfig poolConfig, final String password) {
this(masters, sentinels, poolConfig, Protocol.DEFAULT_TIMEOUT,
password);
}

public ShardedJedisSentinelPool(List<String> masters, Set<String> sentinels,
final GenericObjectPoolConfig poolConfig, int timeout,
final String password, final int database) {
this.poolConfig = poolConfig;
this.timeout = timeout;
this.password = password;
this.database = database;

List<HostAndPort> masterList = initSentinels(sentinels, masters);
initPool(masterList);
}

public void destroy() {
for (MasterListener m : masterListeners) {
m.shutdown();
}

super.destroy();
}

public List<HostAndPort> getCurrentHostMaster() {
  return currentHostMasters;
}

private void initPool(List<HostAndPort> masters) {
  if (!equals(currentHostMasters, masters)) {
  StringBuffer sb = new StringBuffer();
  for (HostAndPort master : masters) {
  sb.append(master.toString());
  sb.append(" ");
  }
  log.info("Created ShardedJedisPool to master at [" + sb.toString() + "]");
  List<JedisShardInfo> shardMasters = makeShardInfoList(masters);
  initPool(poolConfig, new ShardedJedisFactory(shardMasters, Hashing.MURMUR_HASH, null));
  currentHostMasters = masters;
  }
}

private boolean equals(List<HostAndPort> currentShardMasters, List<HostAndPort> shardMasters) {
  if (currentShardMasters != null && shardMasters != null) {
  if (currentShardMasters.size() == shardMasters.size()) {
  for (int i = 0; i < currentShardMasters.size(); i++) {
  if (!currentShardMasters.get(i).equals(shardMasters.get(i))) return false;
  }
  return true;
  }
  }
return false;
}

private List<JedisShardInfo> makeShardInfoList(List<HostAndPort> masters) {
List<JedisShardInfo> shardMasters = new ArrayList<JedisShardInfo>();
for (HostAndPort master : masters) {
JedisShardInfo jedisShardInfo = new JedisShardInfo(master.getHost(), master.getPort(), timeout);
jedisShardInfo.setPassword(password);

shardMasters.add(jedisShardInfo);
}
return shardMasters;
}

private List<HostAndPort> initSentinels(Set<String> sentinels, final List<String> masters) {

  Map<String, HostAndPort> masterMap = new HashMap<String, HostAndPort>();
  List<HostAndPort> shardMasters = new ArrayList<HostAndPort>();

log.info("Trying to find all master from available Sentinels...");

for (String masterName : masters) {
HostAndPort master = null;
boolean fetched = false;

while (!fetched && sentinelRetry < MAX_RETRY_SENTINEL) {
for (String sentinel : sentinels) {
final HostAndPort hap = toHostAndPort(Arrays.asList(sentinel.split(":")));

log.fine("Connecting to Sentinel " + hap);

try {
Jedis jedis = new Jedis(hap.getHost(), hap.getPort());
master = masterMap.get(masterName);
if (master == null) {
List<String> hostAndPort = jedis.sentinelGetMasterAddrByName(masterName);
if (hostAndPort != null && hostAndPort.size() > 0) {
master = toHostAndPort(hostAndPort);
log.fine("Found Redis master at " + master);
shardMasters.add(master);
masterMap.put(masterName, master);
fetched = true;
jedis.disconnect();
break;
}
}
} catch (JedisConnectionException e) {
log.warning("Cannot connect to sentinel running @ " + hap + ". Trying next one.");
}
}

if (null == master) {
try {
log.severe("All sentinels down, cannot determine where is "
+ masterName + " master is running... sleeping 1000ms, Will try again.");
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
fetched = false;
sentinelRetry++;
}
}

// Try MAX_RETRY_SENTINEL times.
if (!fetched && sentinelRetry >= MAX_RETRY_SENTINEL) {
log.severe("All sentinels down and try " + MAX_RETRY_SENTINEL + " times, Abort.");
throw new JedisConnectionException("Cannot connect all sentinels, Abort.");
}
}

// All shards master must been accessed.
if (masters.size() != 0 && masters.size() == shardMasters.size()) {

log.info("Starting Sentinel listeners...");
for (String sentinel : sentinels) {
final HostAndPort hap = toHostAndPort(Arrays.asList(sentinel.split(":")));
MasterListener masterListener = new MasterListener(masters, hap.getHost(), hap.getPort());
masterListeners.add(masterListener);
masterListener.start();
}
}

return shardMasters;
}

private HostAndPort toHostAndPort(List<String> getMasterAddrByNameResult) {
  String host = getMasterAddrByNameResult.get(0);
  int port = Integer.parseInt(getMasterAddrByNameResult.get(1));

  return new HostAndPort(host, port);
}

/**
* PoolableObjectFactory custom impl.
*/
protected static class ShardedJedisFactory implements PooledObjectFactory<ShardedJedis> {
private List<JedisShardInfo> shards;
private Hashing algo;
private Pattern keyTagPattern;

public ShardedJedisFactory(List<JedisShardInfo> shards, Hashing algo, Pattern keyTagPattern) {
this.shards = shards;
this.algo = algo;
this.keyTagPattern = keyTagPattern;
}

public PooledObject<ShardedJedis> makeObject() throws Exception {
ShardedJedis jedis = new ShardedJedis(shards, algo, keyTagPattern);
return new DefaultPooledObject<ShardedJedis>(jedis);
}

public void destroyObject(PooledObject<ShardedJedis> pooledShardedJedis) throws Exception {
final ShardedJedis shardedJedis = pooledShardedJedis.getObject();
for (Jedis jedis : shardedJedis.getAllShards()) {
try {
try {
jedis.quit();
} catch (Exception e) {

}
jedis.disconnect();
} catch (Exception e) {

}
}
}

public boolean validateObject(PooledObject<ShardedJedis> pooledShardedJedis) {
try {
ShardedJedis jedis = pooledShardedJedis.getObject();
for (Jedis shard : jedis.getAllShards()) {
if (!shard.ping().equals("PONG")) {
return false;
}
}
return true;
} catch (Exception ex) {
return false;
}
}

public void activateObject(PooledObject<ShardedJedis> p) throws Exception {

}

public void passivateObject(PooledObject<ShardedJedis> p) throws Exception {

}
}

protected class JedisPubSubAdapter extends JedisPubSub {
@Override
public void onMessage(String channel, String message) {
}

@Override
public void onPMessage(String pattern, String channel, String message) {
}

@Override
public void onPSubscribe(String pattern, int subscribedChannels) {
}

@Override
public void onPUnsubscribe(String pattern, int subscribedChannels) {
}

@Override
public void onSubscribe(String channel, int subscribedChannels) {
}

@Override
public void onUnsubscribe(String channel, int subscribedChannels) {
}
}

protected class MasterListener extends Thread {

protected List<String> masters;
protected String host;
protected int port;
protected long subscribeRetryWaitTimeMillis = 5000;
protected Jedis jedis;
protected AtomicBoolean running = new AtomicBoolean(false);

protected MasterListener() {
}

public MasterListener(List<String> masters, String host, int port) {
this.masters = masters;
this.host = host;
this.port = port;
}

public MasterListener(List<String> masters, String host, int port,
long subscribeRetryWaitTimeMillis) {
this(masters, host, port);
this.subscribeRetryWaitTimeMillis = subscribeRetryWaitTimeMillis;
}

public void run() {

running.set(true);

while (running.get()) {

jedis = new Jedis(host, port);

try {
jedis.subscribe(new JedisPubSubAdapter() {
@Override
public void onMessage(String channel, String message) {
log.fine("Sentinel " + host + ":" + port + " published: " + message + ".");

String[] switchMasterMsg = message.split(" ");

if (switchMasterMsg.length > 3) {

int index = masters.indexOf(switchMasterMsg[0]);
if (index >= 0) {
HostAndPort newHostMaster = toHostAndPort(Arrays.asList(switchMasterMsg[3], switchMasterMsg[4]));
List<HostAndPort> newHostMasters = new ArrayList<HostAndPort>();
for (int i = 0; i < masters.size(); i++) {
newHostMasters.add(null);
}
Collections.copy(newHostMasters, currentHostMasters);
newHostMasters.set(index, newHostMaster);

initPool(newHostMasters);
} else {
StringBuffer sb = new StringBuffer();
for (String masterName : masters) {
sb.append(masterName);
sb.append(",");
}
log.fine("Ignoring message on +switch-master for master name "
+ switchMasterMsg[0]
+ ", our monitor master name are ["
+ sb + "]");
}

} else {
log.severe("Invalid message received on Sentinel "
+ host
+ ":"
+ port
+ " on channel +switch-master: "
+ message);
}
}
}, "+switch-master");

} catch (JedisConnectionException e) {

if (running.get()) {
log.severe("Lost connection to Sentinel at " + host
+ ":" + port
+ ". Sleeping 5000ms and retrying.");
try {
Thread.sleep(subscribeRetryWaitTimeMillis);
} catch (InterruptedException e1) {
e1.printStackTrace();
}
} else {
log.fine("Unsubscribing from Sentinel at " + host + ":"
+ port);
}
}
}
}

public void shutdown() {
try {
log.fine("Shutting down listener on " + host + ":" + port);
running.set(false);
// This isn't good, the Jedis object is not thread safe
jedis.disconnect();
} catch (Exception e) {
log.severe("Caught exception while shutting down: " + e.getMessage());
}
}
}
}

5、测试：

@Autowired
private ShardedJedisSentinelPool pool;

ShardedJedis jedis = null;
try {
jedis = pool.getResource();
jedis.set("KEY1", value);
Thread.sleep(500);
result = jedis.get("KEY1");
System.out.println(result);
} catch (JedisConnectionException e){
log.error("连接jedis异常", e);
}
finally {
if (jedis != null) pool.returnResource(jedis);
pool.destroy();
}