1. 程式人生 > >spring-boot(三.redis的整合使用)

spring-boot(三.redis的整合使用)

spring boot對常用的資料庫支援外,對nosql 資料庫也進行了封裝自動化。

redis介紹

Redis是目前業界使用最廣泛的記憶體資料儲存。相比memcached,Redis支援更豐富的資料結構,例如hashes, lists, sets等,同時支援資料持久化。除此之外,Redis還提供一些類資料庫的特性,比如事務,HA,主從庫。可以說Redis兼具了快取系統和資料庫的一些特性,因此有著豐富的應用場景。本文介紹Redis在Spring Boot中兩個典型的應用場景。

如何使用

1、引入 spring-boot-starter-redis

<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-redis</artifactId>  
</dependency>  

此處由於使用的是spring-boot2.x的版本因此新增的jar依賴為:

       <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

2、新增配置檔案

# REDIS (RedisProperties)
# Redis資料庫索引(預設為0)
spring.redis.database=0  
# Redis伺服器地址
spring.redis.host=192.168.0.58
# Redis伺服器連線埠
spring.redis.port=6379  
# Redis伺服器連線密碼(預設為空)
spring.redis.password=  
# 連線池最大連線數(使用負值表示沒有限制)
spring.redis.pool.max-active=8  
# 連線池最大阻塞等待時間(使用負值表示沒有限制)
spring.redis.pool.max-wait=-1  
# 連線池中的最大空閒連線
spring.redis.pool.max-idle=8  
# 連線池中的最小空閒連線
spring.redis.pool.min-idle=0  
# 連線超時時間(毫秒)
spring.redis.timeout=0  

3、新增cache的配置類

@Configuration
@EnableCaching
public class RedisConfig extends CachingConfigurerSupport{
    
    @Bean
    public KeyGenerator keyGenerator() {
        return new KeyGenerator() {
            @Override
            public Object generate(Object target, Method method, Object... params) {
                StringBuilder sb = new StringBuilder();
                sb.append(target.getClass().getName());
                sb.append(method.getName());
                for (Object obj : params) {
                    sb.append(obj.toString());
                }
                return sb.toString();
            }
        };
    }

    @SuppressWarnings("rawtypes")
    @Bean
    public CacheManager cacheManager(RedisTemplate redisTemplate) {
        RedisCacheManager rcm = new RedisCacheManager(redisTemplate);
        //設定快取過期時間
        //rcm.setDefaultExpiration(60);//秒
        return rcm;
    }
    
    @Bean
    public RedisTemplate<String, String> redisTemplate(RedisConnectionFactory factory) {
        StringRedisTemplate template = new StringRedisTemplate(factory);
        Jackson2JsonRedisSerializer 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);
        template.setValueSerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();
        return template;
    }

}

spring-boot2.x的版本中的cacheManager的生成方式發生了改變:

因此使用的步驟如下:{

關於redis的基本操作和對java物件的操作,請見筆者部落格。

本文我們介紹springboot整合redis。

首先是pom依賴:

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-data-redis</artifactId>
     <version>2.0.0.RELEASE</version>
</dependency>
1.假設我們操作的是User類,其程式碼如下:

public class User implements Serializable {
 
    private String username;
    private String password;
    private String nickname;
    private String age;
    private String gender;
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public String getNickname() {
        return nickname;
    }
    public void setNickname(String nickname) {
        this.nickname = nickname;
    }
    public String getAge() {
        return age;
    }
    public void setAge(String age) {
        this.age = age;
    }
    public String getGender() {
        return gender;
    }
    public void setGender(String gender) {
        this.gender = gender;
    }
}
注意一定要實現serializable介面。

2.序列化和反序列化工具類:

public class ObjectRedisSerializer implements RedisSerializer<Object> {
    
    /**
     * 定義序列化和反序列化轉化類
     */
    private Converter<Object, byte[]> serializer = new SerializingConverter();
    private Converter<byte[], Object> deserializer = new DeserializingConverter();
    
    /**
     * 定義轉換空位元組陣列
     */
    private static final byte[] EMPTY_ARRAY = new byte[0]; 
    
    @Override
    public byte[] serialize(Object obj) throws SerializationException {
        byte[] byteArray = null;
        if (null == obj) {
            System.err.println("----------------------------->:Redis待序列化的物件為空.");
            byteArray = EMPTY_ARRAY;
        } else {
            try {
                byteArray = serializer.convert(obj);
            } catch (Exception e) {
                System.err.println("----------------------------->Redis序列化物件失敗,異常:"+e.getMessage());
                byteArray = EMPTY_ARRAY;
            }
        }
        return byteArray;
    }
 
    @Override
    public Object deserialize(byte[] datas) throws SerializationException {
        Object obj = null;
        if((null == datas)|| (datas.length == 0)){
            System.out.println("---------------------------------->Redis待反序列化的物件為空.");
        }else{
            try {
                obj = deserializer.convert(datas);
            } catch (Exception e) {
                System.out.println("------------------------------------->Redis反序列化物件失敗,異常:"+e.getMessage());
            }
        }
        return obj;
    }
}
此處我們使用spring的SerializingConverter和DeserializingConverter類來實現java物件的序列化和反序列化,這兩個類實現了Converter介面。使用這個類相比getBytes()方法的好處是可以將大的物件也可以序列化,效能相比getBytes()做了優化。

3.redis的springboot配置類:

@Configuration
public class RedisConfig {
 
    @Bean
    public RedisTemplate<Serializable, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        RedisTemplate<Serializable, Object> template = new RedisTemplate<Serializable, Object>();
        template.setConnectionFactory(connectionFactory);
        template.afterPropertiesSet();
        // redis存取物件的關鍵配置
        template.setKeySerializer(new StringRedisSerializer());
        // ObjectRedisSerializer類為java物件的序列化和反序列化工具類
        template.setValueSerializer(new ObjectRedisSerializer());
        return template;
    }
}
連線和配置redis的類。
4.application.properties配置檔案:

# REDIS
# Redis資料庫索引(預設為0)
spring.redis.database=0 
# Redis伺服器地址 (預設為127.0.0.1)
spring.redis.host=127.0.0.1
# Redis伺服器連線埠 (預設為6379)
spring.redis.port=6379
# Redis伺服器連線密碼(預設為空)
spring.redis.password=
# 連線超時時間(毫秒)
spring.redis.timeout=2000ms
5.在TestController類中編寫介面方法,測試redis:

@RestController
public class TestController {
 
    @Autowired
    private RedisTemplate<Serializable, Object> redisTemplate;
 
    @RequestMapping("/set")
    public String setPOJO(){
 
        User user = new User();
        user.setAge("18");
        user.setGender("男");
        user.setNickname("cherish");
        user.setPassword("123456");
        user.setUsername("admin");
        redisTemplate.opsForValue().set("user1", user);
        return "儲存物件";
    }
 
    @RequestMapping("/get")
    public Object getPOJO(){
 
        return redisTemplate.opsForValue().get("user1");
    }
 
}
6.測試,首先訪問"/set"介面設定user物件:

再訪問"/get"介面獲取剛剛儲存的user物件:

springboot整合redis成功。

當然,在這裡也可以操作string等java物件,讀者可以自行操作。
--------------------- 
作者:亦心_yan 
來源:CSDN 
原文:https://blog.csdn.net/m0_38075425/article/details/81181726 
版權宣告:本文為博主原創文章,轉載請附上博文連結!

}

 

3、好了,接下來就可以直接使用了

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(Application.class)
public class TestRedis {

    @Autowired
    private StringRedisTemplate stringRedisTemplate;
    
    @Autowired
    private RedisTemplate redisTemplate;

    @Test
    public void test() throws Exception {
        stringRedisTemplate.opsForValue().set("aaa", "111");
        Assert.assertEquals("111", stringRedisTemplate.opsForValue().get("aaa"));
    }
    
    @Test
    public void testObj() throws Exception {
        User user=new User("[email protected]", "aa", "aa123456", "aa","123");
        ValueOperations<String, User> operations=redisTemplate.opsForValue();
        operations.set("com.neox", user);
        operations.set("com.neo.f", user,1,TimeUnit.SECONDS);
        Thread.sleep(1000);
        //redisTemplate.delete("com.neo.f");
        boolean exists=redisTemplate.hasKey("com.neo.f");
        if(exists){
            System.out.println("exists is true");
        }else{
            System.out.println("exists is false");
        }
       // Assert.assertEquals("aa", operations.get("com.neo.f").getUserName());
    }
}

以上都是手動使用的方式,如何在查詢資料庫的時候自動使用快取呢,看下面;

4、自動根據方法生成快取

@RequestMapping("/getUser")
@Cacheable(value="user-key")
public User getUser() {
    User user=userRepository.findByUserName("aa");
    System.out.println("若下面沒出現“無快取的時候呼叫”字樣且能打印出資料表示測試成功");  
    return user;
}

其中value的值就是快取到redis中的key

 

 

《!-- 實現session的共享,使用redis進行管理的方式 --》

共享Session-spring-session-data-redis

分散式系統中,sessiong共享有很多的解決方案,其中託管到快取中應該是最常用的方案之一,

Spring Session官方說明

Spring Session provides an API and implementations for managing a user’s session information.

如何使用

1、引入依賴

<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-data-redis</artifactId>
</dependency>

2、Session配置:

@Configuration
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 86400*30)
public class SessionConfig {
}

maxInactiveIntervalInSeconds: 設定Session失效時間,使用Redis Session之後,原Boot的server.session.timeout屬性不再生效

好了,這樣就配置好了,我們來測試一下

3、測試

新增測試方法獲取sessionid

@RequestMapping("/uid")
    String uid(HttpSession session) {
        UUID uid = (UUID) session.getAttribute("uid");
        if (uid == null) {
            uid = UUID.randomUUID();
        }
        session.setAttribute("uid", uid);
        return session.getId();
    }

登入redis 輸入 keys '*sessions*'

t<spring:session:sessions:db031986-8ecc-48d6-b471-b137a3ed6bc4
t(spring:session:expirations:1472976480000

其中 1472976480000為失效時間,意思是這個時間後session失效,db031986-8ecc-48d6-b471-b137a3ed6bc4 為sessionId,登入http://localhost:8080/uid 發現會一致,就說明session 已經在redis裡面進行有效的管理了。

如何在兩臺或者多臺中共享session

其實就是按照上面的步驟在另一個專案中再次配置一次,啟動後自動就進行了session共享。