Springboot redis报错ERR unknown command `CONFIG`, with args beginning with: `GET`, `notify-keyspace-ev

￡神魔★判官ぃ 2023-01-20 04:55 2阅读 0赞

今天springboot应用搬到新的环境，启动时redis key过期监听器 KeyExpiredEventMessageListener 初始化失败，报以下错误：

ERR unknown command `CONFIG`, with args beginning with: `GET`, `notify-keyspace-events`

一开始以为是redis.conf 没有开启配置：notify-keyspace-events Ex，让运维帮忙加上之后依旧报错，于是找了运维拿了新的redis.conf 的内容，发现配置文件中加了以下配置，redis 官网推荐[禁用CONFIG命令给远程用户使用][CONFIG]：

rename-command FLUSHALL "xxx"
    rename-command FLUSHDB "xxx"
    rename-command CONFIG "xxx" # rename-command 重命名命令

至此找到原因了，是因为CONFIG命令被重命名了，而springboot应用运行的时候去执行了CONFIG命令，因此才会报以上错误。

既然找到原因了，理论上不使用rename-command的话就可以避免以上错误，但是此种解决方式并不安全，那么该如何解决呢？

由于以上错误是初始化KeyExpiredEventMessageListener时报错的，那也就是这个监听器初始化的时候会去调用CONFIG命令，顺着这个监听器的继承关系，我找到以下源码：

package org.springframework.data.redis.listener;
    
    import java.util.Properties;
    import org.springframework.beans.factory.DisposableBean;
    import org.springframework.beans.factory.InitializingBean;
    import org.springframework.data.redis.connection.Message;
    import org.springframework.data.redis.connection.MessageListener;
    import org.springframework.data.redis.connection.RedisConnection;
    import org.springframework.lang.Nullable;
    import org.springframework.util.Assert;
    import org.springframework.util.ObjectUtils;
    import org.springframework.util.StringUtils;
    
    public abstract class KeyspaceEventMessageListener implements MessageListener, InitializingBean, DisposableBean {
        private static final Topic TOPIC_ALL_KEYEVENTS = new PatternTopic("__keyevent@*");
        private final RedisMessageListenerContainer listenerContainer;
        private String keyspaceNotificationsConfigParameter = "EA";
    
        ...... 此处省略部分代码
    
        public void init() {
            if (StringUtils.hasText(this.keyspaceNotificationsConfigParameter)) {
                RedisConnection connection = this.listenerContainer.getConnectionFactory().getConnection();
    
                try {
                    Properties config = connection.getConfig("notify-keyspace-events");
                    if (!StringUtils.hasText(config.getProperty("notify-keyspace-events"))) {
                        connection.setConfig("notify-keyspace-events", this.keyspaceNotificationsConfigParameter);
                    }
                } finally {
                    connection.close();
                }
            }
    
            this.doRegister(this.listenerContainer);
        }
    
         ...... 此处省略部分代码
    
        public void setKeyspaceNotificationsConfigParameter(String keyspaceNotificationsConfigParameter) {
            this.keyspaceNotificationsConfigParameter = keyspaceNotificationsConfigParameter;
        }
    
         ...... 此处省略部分代码
    }

此类中有个私有变量keyspaceNotificationsConfigParameter = "EA"，在init()方法中，我们可以看到如果判断到该变量不为空，则会获取redis的配置，之后修改redis的配置，也就是只要我们把这个变量设置为空，那么springboot 初始化实例的时候也就不会去操作redis的CONFIG了，恰好，该类提供了setKeyspaceNotificationsConfigParameter()供我们修改变量的值。

因此，我们可以在自己写的Key监听器的构造方法中把keyspaceNotificationsConfigParameter 设置为空即可解决此问题，具体如下：

@Component
    public class KeyExpiredEventMessageListener extends KeyExpirationEventMessageListener {
    
    
    
        public KeyExpiredEventMessageListener(RedisMessageListenerContainer listenerContainer) {
            super(listenerContainer);
            // 配置springboot默认Config为空，即不让应用去修改redis的默认配置，因为Redis服务出于安全会禁用CONFIG命令给远程用户使用
            setKeyspaceNotificationsConfigParameter("");
        }
    
        @Override
        public void onMessage(Message message, byte[] pattern) {
            // 用户做自己的业务处理即可,message.toString()可以获取失效的key
           ....
        }
    
    }

以上就是本人解决此问题的方法，如果各位大佬有更好的解决方法，欢迎评论指正。感谢！

[CONFIG]: https://redis.io/topics/security