Spring redis listener container配置问题

今天遇到一个redis 的问题，当我们使用redis进行消息sub/pub传输的时候，需要进行如下的配置：

消费端：

<!-- 定义Spring Redis的序列化器 -->
    <bean id="stringRedisSerializer" class="org.springframework.data.redis.serializer.StringRedisSerializer" />
    <bean id="jsonRedisSerializer" class="org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer" />

<!-- 定义处理本地数据同步的Redis消息监听器 -->
    <bean id="dataSyncEventListener" class="com.test.cache.DataSyncEventListener" />

<!-- 注册Redis消息订阅的监听器 -->
    <redis:listener-container>
        <redis:listener ref="dataSyncEventListener" serializer="jsonRedisSerializer" method="handleMessage" topic="someMessage-*" />
    </redis:listener-container>

监听类：

public class DataSyncEventListener implements MessageListener {

@Autowired
private RedisSerializer<Object> jsonRedisSerializer;

@Override
public void onMessage(Message message, byte[] pattern) {
    Object object =   jsonRedisSerializer.deserialize(message.getBody());
    System.out.println(object.toString());

生产端：

redisTemplate.convertAndSend(someMessage-test, "this is a test message");

可以看到在监听端有一个method 的属性，该属性配置了handleMessage 名字的方法，此处是spring-redis官方给出的配置，但是在实际的监听类中，我这里继承的是spring-redis-data的MessageListener类，并重写了其onMessage方法，并没有handleMessage方法，但是实际环境中是可以顺利接收到消息的，也就是说method指定方法名称并没有生效，这让我非常的不解，查了好多博客也没得到答案，因此去看一下源码是如何描述这里的。

找到redis:listener-container的注解，点进去看一下：

<xsd:attribute name="method" type="xsd:string">
      <xsd:annotation>
        <xsd:documentation><![CDATA[
The name of the listener method to invoke. If not specified,
the target bean is supposed to implement the MessageListener
interface or provide a method named 'handleMessage'.

关于method这个属性spring是这样描述的，也就是说，如果没有指定，默认的方法为handleMessage，如果指定了方法，就执行指定的方法，如果继承了MessageListener这个接口，则去调用该接口的实现，再看一下MessageListenerAdapter这个类的源码：

public class MessageListenerAdapter extends AbstractAdaptableMessageListener implements SubscriptionNameProvider {
    public static final String ORIGINAL_DEFAULT_LISTENER_METHOD = "handleMessage";
    private Object delegate;
    private String defaultListenerMethod = "handleMessage";

可以看到默认方法指定了handleMessage

public void onMessage(Message message, Session session) throws JMSException {
        Object delegate = this.getDelegate();
        if(delegate != this) {
            if(delegate instanceof SessionAwareMessageListener) {
                if(session != null) {
                    ((SessionAwareMessageListener)delegate).onMessage(message, session);
                    return;
                }

                if(!(delegate instanceof MessageListener)) {
                    throw new IllegalStateException("MessageListenerAdapter cannot handle a SessionAwareMessageListener delegate if it hasn\'t been invoked with a Session itself");
                }
            }

            if(delegate instanceof MessageListener) {
                ((MessageListener)delegate).onMessage(message);
                return;
            }
        }

onMessage方法中，可以看到，如果继承于MessageListener，则默认调用onMessage方法，而不去执行指定的方法名称。

如果我们不实现任何接口，自己实现一个监听类，则可以指定方法名称

public class EventListener {

        public void getMessage(String json, String channel){
            System.out.println(json);
        }
}       

<bean id="stringRedisSerializer" class="org.springframework.data.redis.serializer.StringRedisSerializer" />

<bean id="eventListener" class="com.test.EventListener" />
    <!-- 注册Redis消息订阅的监听器 -->
    <redis:listener-container task-executor="taskExecutor">
        <redis:listener ref="eventListener" serializer="stringRedisSerializer" method="getMessage" topic="message-*" />
    </redis:listener-container>

综上，得出结论，如果redis 的监听类实现了MessageListener接口，则不需要指定method名称，如果自己实现一个监听类不去实现任何接口，则可以指定一个method名称。