Redis如何在SpringBoot项目中使用
Redis如何在SpringBoot项目中使用？很多新手对此不是很清楚，为了帮助大家解决这个难题，下面小编将为大家详细讲解，有这方面需求的人可以来学习下，希望你能有所收获。
SpringBoot环境
快速搭建一个SpringBoot工程
进入 https://start.spring.io 网站, 使用该网站初始化一个SpringBoot工程
添加相关依赖
因为使用spring initializer已经帮我们把Redis的依赖建立好了; 但是由于我们要使用Jedis客户端访问Redis, 所以还需要添加Jedis的依赖;
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>2.9.0</version>//版本号可以放在properties中作为属性,这边用${jedis.version}来依赖
</dependency>配置Redis节点信息
打开application.properties文件, 初始化的文件是空的; 我们将spring redis最基本的信息加入进去
spring.redis.host=localhost spring.redis.port=6379
将Redis信息读入到程序中
新建一个Java类命名为StandaloneRedisConfig.java， 放在com.xxx.example.config包下
packagecom.terrylmay.redis.example.config;
importorg.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
importorg.springframework.boot.context.properties.ConfigurationProperties;
importorg.springframework.context.annotation.Configuration;
@Configuration
@ConfigurationProperties(prefix="spring.redis")
@ConditionalOnProperty(name={"spring.redis.host"})
publicclassStandaloneRedisConfig{
Stringhost;
intport;
publicStringgetHost(){
returnhost;
}
publicvoidsetHost(Stringhost){
this.host=host;
}
publicintgetPort(){
returnport;
}
publicvoidsetPort(intport){
this.port=port;
}
}上面配置中的@ConditionalOnProperty(name = {"spring.redis.host"}) 如果只是单机的Redis则不需要添加该属性; 但是为了后面一套代码兼容多个Redis部署模式, 使用该属性作为是否创建Bean的条件; 如果是集群模式那么就不会使用spring.redis.host来作为连接字符串了;
配置Jedis的连接池
将Redis连接对象放入到Spring容器中进行管理
packagecom.terrylmay.redis.example;
importcom.terrylmay.redis.example.config.StandaloneRedisConfig;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
importorg.springframework.boot.autoconfigure.condition.ConditionalOnBean;
importorg.springframework.context.annotation.Bean;
importorg.springframework.data.redis.connection.RedisConnectionFactory;
importorg.springframework.data.redis.connection.RedisStandaloneConfiguration;
importorg.springframework.data.redis.connection.jedis.JedisConnectionFactory;
importorg.springframework.data.redis.core.StringRedisTemplate;
@SpringBootApplication(scanBasePackages={"com.terrylmay.redis.example"})
publicclassRedisExampleApplication{
publicstaticvoidmain(String[]args){
SpringApplication.run(RedisExampleApplication.class,args);
}
@Autowired
StandaloneRedisConfigstandaloneRedisConfig;
@Autowired
RedisConnectionFactoryredisConnectionFactory;
@Bean
@ConditionalOnBean(value={StandaloneRedisConfig.class})
publicRedisConnectionFactorystandaloneRedisConnectionFactory(){
JedisConnectionFactoryfactory=newJedisConnectionFactory(newRedisStandaloneConfiguration(standaloneRedisConfig.getHost(),standaloneRedisConfig.getPort()));
returnfactory;
}
@Bean
publicStringRedisTemplatestringRedisTemplate(){
returnnewStringRedisTemplate(redisConnectionFactory);
}
}这里的@ConditionalOnBean(value = {StandaloneRedisConfig.class})与上面的ConditionalOnProperty 是一个道理
这里的scanBasePackages = {"com.terrylmay.redis.example"} 是为了以后将Redis的客户端独立出一个工程而做的, 当然独立出来的工程base包名还要是这个才可以;
因为还没有看Redis支持的数据结构, 那么现在只是把Redis字符串模板类放到Spring 容器中, 后续再增加其他数据类型的支持;
创建操作Redis的接口 以及实现
创建ICacheProvider.java接口:
packagecom.terrylmay.redis.example.provider;
publicinterfaceICacheProvider{
voidsetString(Stringkey,Stringvalue);
StringgetString(Stringkey);
}Jedis版本的实现：
packagecom.terrylmay.redis.example.provider.impl;
importcom.terrylmay.redis.example.provider.ICacheProvider;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.data.redis.core.StringRedisTemplate;
importorg.springframework.stereotype.Component;
@Component
publicclassJedisCacheProviderimplementsICacheProvider{
@Autowired
StringRedisTemplatestringRedisTemplate;
@Override
publicvoidsetString(Stringkey,Stringvalue){
stringRedisTemplate.opsForValue().set(key,value);
}
@Override
publicStringgetString(Stringkey){
returnstringRedisTemplate.opsForValue().get(key);
}
}这样基本上一个可以操作Redis的Java程序就已经就绪了; 那么我们需要验证一下, 当然如果在主工程中写一个类去验证也是没有问题的, 比如创建一个Bean, 并且放到被PostContruct注解的方法里面;
但是更加专业的做法是写一个测试程序来测试, 下面看一下该测试程序应该怎么写
UT测试程序可用性
因为创建工程的时候, 就已经有一个测试类在test目录下面了, 我们增加我们想要的功能
packagecom.terrylmay.redis.example;
importcom.terrylmay.redis.example.provider.ICacheProvider;
importorg.junit.Assert;
importorg.junit.Test;
importorg.junit.runner.RunWith;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.boot.test.context.SpringBootTest;
importorg.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes={RedisExampleApplication.class})
publicclassRedisExampleApplicationTests{
@Autowired
ICacheProviderjedisCacheProvider;
@Test
publicvoidcontextLoads(){
jedisCacheProvider.setString("name","terrylmay");
System.out.println(jedisCacheProvider.getString("name"));
Assert.assertEquals("terrylmay",jedisCacheProvider.getString("name"));
}
}注: 程序中不要有打印, 使用Logger或者直接断言来处理 （本来想用markdown语法来标红的, 但是发现简书竟然不支持html的写法; 没办法只能用``来搞定了）
开发过程中遇到的问题
一、在写好所有的程序之后, 跑测试用例, 但是始终都是报NoSuchBeanException
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException:No qualifying bean of type 'com.terrylmay.redis.example.config.StandaloneRedisConfig' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
原因共有三点：
1、写了scanBasepackages来扫描包下面的bean, 扫描的包与类所在的包不一样， 只有一个字符之差 com.terrylmay.redis.example 与 com.terrlmay.redis.example, 当然这时候idea会报错， 只是我不认识那个错而已; Idea报错如图所示:
2、按照网上的application.properties属性的读取方式, 只使用了一个注解:@ConfigurationProperties(prefix = "spring.redis") 但是点进该注解里面看, 它其实并没有Component注解的功能; 所以增加了@Configuration注解
3、第三个原因不仔细断然不会发现这个错误
我理解的是只要工程里面父工程是spring-boot-starter-parent, 那么就不应该存在这类Jar包没有依赖的问题, 打开文档
依赖可粘贴版:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency>
看完上述内容是否对您有帮助呢？如果还想对相关知识有进一步的了解或阅读更多相关文章，请关注恰卡编程网行业资讯频道，感谢您对恰卡编程网的支持。
