使用@Autowired 注入RedisTemplate報錯的問題及解決

2022-08-18 18:01:22

@Autowired 注入RedisTemplate報錯

先看報錯資訊

Field redisTemplate in xxx.xxx required a bean of type 'org.springframework.data.redis.core. RedisTemplate' that could not be found.

The injection point has the following annotations:

@org.springframework.beans.factory.annotation.Autowired(required=true)

下面是Redis設定類

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(LettuceConnectionFactory lettuceConnectionFactory) {
        // 設定序列化
        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        // 設定redisTemplate
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(lettuceConnectionFactory);
        RedisSerializer<?> stringSerializer = new StringRedisSerializer();
        redisTemplate.setKeySerializer(stringSerializer);// key序列化
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);// value序列化
        redisTemplate.setHashKeySerializer(stringSerializer);// Hash key序列化
        redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);// Hash value序列化
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }
}

下面是注入方式

   @Autowired
    private RedisTemplate<String, Object> redisTemplate;

解決方法一

將@Autowired改為 @Resource

   @Resource
    private RedisTemplate<String, Object> redisTemplate;

解決方法二

去掉泛型

@Autowired
private RedisTemplate redisTemplate;

下面咱們來看一下原因

首先我們需要了解@Autowired和@Resource的區別

他們的共同點

@Resource和@Autowired都是做bean的注入時使用的。

不同點

Autowired預設是按照型別裝配注入的，預設情況下它要求依賴物件必須存在
Resource預設是按照名稱來裝配注入的，只有當找不到與名稱匹配的bean才會按照型別來裝配注入

由於Autowired是根據型別來裝配注入的，所以泛型也被考慮進去了，所以它會去spring容器中找 RedisTemplate<String, Object> 這個bean ；

String[] beanDefinitionNames = run.getBeanDefinitionNames();
System.out.println(Arrays.toString(beanDefinitionNames));

通過程式碼獲取到spring容器中所有的bean ，控制檯列印redisTemplate 所以無法找到對應的bean

@Autowired 注入RedisTemplate為null

最近使用Springboot引入redis，直接在Service裡使用@Autowired 注入RedisTemplate，但是啟動時發現注入的@RedisTemplate為null

@Service
public class CacheRedisImpl implements Cache {

    @Autowired(required = false)
    private RedisTemplate<String,Object> redisTemplate;
	....    
}

上述程式碼執行啟動之後斷點，如下圖，無論如何都是null

最後去查閱spring的原始碼 RedisAutoConfiguration（在org.springframework.boot.autoconfigure.data.redis包）

@Configuration
@ConditionalOnClass(RedisOperations.class)
@EnableConfigurationProperties(RedisProperties.class)
@Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class })
public class RedisAutoConfiguration {

	@Bean
	@ConditionalOnMissingBean(name = "redisTemplate")
	public RedisTemplate<Object, Object> redisTemplate(
			RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
		RedisTemplate<Object, Object> template = new RedisTemplate<>();
		template.setConnectionFactory(redisConnectionFactory);
		return template;
		}
		...

終於發現問題了，spring注入的是RedisTemplate<Object, Object>

而我注入的泛型是RedisTemplate<String,Object>。

解決

通過上述排查分析，解決方案有如下

1.@Autowired 時使用RedisTemplate<Object, Object> 或RedisTemplate

@Service
public class CacheRedisImpl implements Cache {
    @Autowired(required = false)
    private RedisTemplate redisTemplate;

執行效果如下圖：

2.如一定要使用RedisTemplate<String,Object>，寫一個Configuration自行手動注入@Bean

@Configuration
public class RedisAutoConfig {
    @Bean(name = "redisTemplate4String")
    public RedisTemplate<String,Object> redisTemplate4String(RedisConnectionFactory redisConnectionFactory){
        RedisTemplate<String,Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory);

        return  redisTemplate;
    }
}

效果如下：

PS: 其實細心的童鞋可能會發現我的程式碼裡@Autowired設定是(required = false)。如果去掉的話，springboot 啟動裡會直接報錯找不到bean。解決方案與本文類似。

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。