SpringBoot中整合Redis（緩存篇）

時間  2019-11-06
標籤 springboot 整合 redis 緩存 欄目 Spring 简体版
原文   原文鏈接

實際開發中緩存處理是必須的，不可能咱們每次客戶端去請求一次服務器，服務器每次都要去數據庫中進行查找，爲何要使用緩存？說究竟是爲了提升系統的運行速度。將用戶頻繁訪問的內容存放在離用戶最近，訪問速度最快的地方，提升用戶的響 應速度，今天先來說下在springboot中整合redis的詳細步驟。android

1、安裝

首先要在本地安裝一個redis程序，redis下載地址，安裝過程十分簡單（略過），安裝完成後進入到redis文件夾中能夠看到以下：git

點擊redis-server.exe開啓redis服務，能夠看到以下圖所示即表明開啓redis服務成功：github

那麼咱們能夠開啓redis客戶端進行測試：

2、整合到springboot

一、在項目中加入redis依賴，pom文件中添加以下：redis

<!-- 整合Redis緩存支持 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
複製代碼

二、在application.yml中添加redis配置：spring

##默認密碼爲空
redis:
      host: 127.0.0.1
      # Redis服務器鏈接端口
      port: 6379
      jedis:
        pool:
          #鏈接池最大鏈接數（使用負值表示沒有限制）
          max-active: 100
          # 鏈接池中的最小空閒鏈接
          max-idle: 10
          # 鏈接池最大阻塞等待時間（使用負值表示沒有限制）
          max-wait: 100000
      # 鏈接超時時間（毫秒）
      timeout: 5000
      #默認是索引爲0的數據庫
      database: 0 
複製代碼

三、新建RedisConfiguration配置類，繼承CachingConfigurerSupport，@EnableCaching開啓註解數據庫

@Configuration
@EnableCaching
public class RedisConfiguration extends CachingConfigurerSupport {
    /**
     * 自定義生成key的規則
     */
    @Override
    public KeyGenerator keyGenerator() {
        return new KeyGenerator() {
            @Override
            public Object generate(Object o, Method method, Object... objects) {
                //格式化緩存key字符串
                StringBuilder sb = new StringBuilder();
                //追加類名
                sb.append(o.getClass().getName());
                //追加方法名
                sb.append(method.getName());
                //遍歷參數而且追加
                for (Object obj : objects) {
                    sb.append(obj.toString());
                }
                System.out.println("調用Redis緩存Key : " + sb.toString());
                return sb.toString();
            }
        };
    }
    
    /**
     * 採用RedisCacheManager做爲緩存管理器
     * @param connectionFactory
     */
    @Bean
    public CacheManager cacheManager(RedisConnectionFactory connectionFactory) {
        RedisCacheManager redisCacheManager = RedisCacheManager.create(connectionFactory);
        return  redisCacheManager;
    }

    @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;
    }
}
複製代碼

四、建立自定義的接口來定義須要的redis的功能數組

/**
 * K 指以hash結構操做時 鍵類型
 * T 爲數據實體 應實現序列化接口,並定義serialVersionUID * RedisTemplate 提供了五種數據結構操做類型 hash / list / set / zset / value
 * 方法命名格式爲 數據操做類型 + 操做 如 hashPut 指以hash結構(也就是map)想key添加鍵值對 
 */
public interface RedisHelper<HK, T> {
    /**
     * Hash結構 添加元素 * @param key key * @param hashKey hashKey * @param domain 元素
     */
    void hashPut(String key, HK hashKey, T domain);

    /**
     * Hash結構 獲取指定key全部鍵值對 * @param key * @return
     */
    Map<HK, T> hashFindAll(String key);

    /**
     * Hash結構 獲取單個元素 * @param key * @param hashKey * @return
     */
    T hashGet(String key, HK hashKey);

    void hashRemove(String key, HK hashKey);

    /**
     * List結構 向尾部(Right)添加元素 * @param key * @param domain * @return
     */
    Long listPush(String key, T domain);

    /**
     * List結構 向頭部(Left)添加元素 * @param key * @param domain * @return
     */
    Long listUnshift(String key, T domain);

    /**
     * List結構 獲取全部元素 * @param key * @return
     */
    List<T> listFindAll(String key);

    /**
     * List結構 移除並獲取數組第一個元素 * @param key * @return
     */
    T listLPop(String key);

    /**
     * 對象的實體類
     * @param key
     * @param domain
     * @return
     */
    void valuePut(String key, T domain);

    /**
     * 獲取對象實體類
     * @param key
     * @return
     */
    T getValue(String key);

    void remove(String key);

    /**
     * 設置過時時間 * @param key 鍵 * @param timeout 時間 * @param timeUnit 時間單位
     */
    boolean expirse(String key, long timeout, TimeUnit timeUnit);
}
複製代碼

下面是建立RedisHelperImpl進行接口的實現緩存

@Service("RedisHelper")
public class RedisHelperImpl<HK, T> implements RedisHelper<HK, T> {
    // 在構造器中獲取redisTemplate實例, key(not hashKey) 默認使用String類型
    private RedisTemplate<String, T> redisTemplate;
    // 在構造器中經過redisTemplate的工廠方法實例化操做對象
    private HashOperations<String, HK, T> hashOperations;
    private ListOperations<String, T> listOperations;
    private ZSetOperations<String, T> zSetOperations;
    private SetOperations<String, T> setOperations;
    private ValueOperations<String, T> valueOperations;

    // IDEA雖然報錯,可是依然能夠注入成功, 實例化操做對象後就能夠直接調用方法操做Redis數據庫
    @Autowired
    public RedisHelperImpl(RedisTemplate<String, T> redisTemplate) {
        this.redisTemplate = redisTemplate;
        this.hashOperations = redisTemplate.opsForHash();
        this.listOperations = redisTemplate.opsForList();
        this.zSetOperations = redisTemplate.opsForZSet();
        this.setOperations = redisTemplate.opsForSet();
        this.valueOperations = redisTemplate.opsForValue();
    }

    @Override
    public void hashPut(String key, HK hashKey, T domain) {
        hashOperations.put(key, hashKey, domain);
    }

    @Override
    public Map<HK, T> hashFindAll(String key) {
        return hashOperations.entries(key);
    }

    @Override
    public T hashGet(String key, HK hashKey) {
        return hashOperations.get(key, hashKey);
    }

    @Override
    public void hashRemove(String key, HK hashKey) {
        hashOperations.delete(key, hashKey);
    }

    @Override
    public Long listPush(String key, T domain) {
        return listOperations.rightPush(key, domain);
    }

    @Override
    public Long listUnshift(String key, T domain) {
        return listOperations.leftPush(key, domain);
    }

    @Override
    public List<T> listFindAll(String key) {
        if (!redisTemplate.hasKey(key)) {
            return null;
        }
        return listOperations.range(key, 0, listOperations.size(key));
    }

    @Override
    public T listLPop(String key) {
        return listOperations.leftPop(key);
    }

    @Override
    public void valuePut(String key, T domain) {
        valueOperations.set(key, domain);
    }

    @Override
    public T getValue(String key) {
        return valueOperations.get(key);
    }

    @Override
    public void remove(String key) {
        redisTemplate.delete(key);
    }

    @Override
    public boolean expirse(String key, long timeout, TimeUnit timeUnit) {
        return redisTemplate.expire(key, timeout, timeUnit);
    }
}
複製代碼

3、測試

編寫TestRedis類進行測試springboot

@RunWith(SpringRunner.class)
@SpringBootTest
public class TestRedis {

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    @Autowired
    private RedisTemplate redisTemplate;

    @Autowired
    private RedisHelperImpl redisHelper;

    @Test
    public void test() throws Exception{
//        基本寫法
//        stringRedisTemplate.opsForValue().set("aaa","111");
//        Assert.assertEquals("111",stringRedisTemplate.opsForValue().get("aaa"));
//        System.out.println(stringRedisTemplate.opsForValue().get("aaa"));
        Author user=new Author();
        user.setName("Alex");
        user.setIntro_l("不會打籃球的程序不是好男人");
        redisHelper.valuePut("aaa",user);
        System.out.println(redisHelper.getValue("aaa"));
    }

    @Test
    public void testObj() throws Exception {
        Author user=new Author();
        user.setName("Jerry");
        user.setIntro_l("不會打籃球的程序不是好男人!");

        ValueOperations<String, Author> operations=redisTemplate.opsForValue();
        operations.set("502", user);
        Thread.sleep(500);
        boolean exists=redisTemplate.hasKey("502");
        if(exists){
            System.out.println(redisTemplate.opsForValue().get("502"));
        }else{
            System.out.println("exists is false");
        }
        // Assert.assertEquals("aa", operations.get("com.neo.f").getUserName());
    }
}
複製代碼

運行TestRedis測試類，結果以下：bash

注意：若是在RedisConfiguration中不配置redisTemplate(RedisConnectionFactory factory)註解，會形成鍵、值的一個序列化問題，有興趣的能夠去試一下。

4、項目實戰

首先須要在程序的入口處Application中添加@EnableCaching開啓緩存的註解

@EnableCaching  //開啓緩存
@SpringBootApplication
public class PoetryApplication {

    public static void main(String[] args) {
        SpringApplication.run(PoetryApplication.class, args);
    }
}
複製代碼

上面的redis相關寫法是咱們自定義設置並獲取的，那麼咱們常常要在訪問接口的地方去使用redis進行緩存相關實體對象以及集合等，那麼咱們怎麼實現呢？好比我如今想在AuthorController中去緩存做者相關信息的緩存數據，該怎麼辦呢？以下：

@RestController
@RequestMapping(value = "/poem")
public class AuthorController {

    private final static Logger logger = LoggerFactory.getLogger(AuthorController.class);

    @Autowired
    private AuthorRepository authorRepository;

    @Cacheable(value="poemInfo")  //自動根據方法生成緩存
    @PostMapping(value = "/poemInfo")
    public Result<Author> author(@RequestParam("author_id") int author_id, @RequestParam("author_name")String author_name) {
        if(StringUtils.isEmpty(author_id) || StringUtils.isEmpty(author_name)){
            return ResultUtils.error(ResultCode.INVALID_PARAM_EMPTY);
        }
        Author author;
        Optional<Author> optional = authorRepository.getAuthorByIdAndName(author_id, author_name);
        if (optional.isPresent()) {
            author = optional.get();
            //經過\n或者多個空格 進行過濾去重
            if (!StringUtils.isEmpty(author.getIntro_l())) {
                String s = author.getIntro_l();
                String intro = s.split("\\s +")[0];
                author.setIntro_l(intro);
            }
        } else {
           return ResultUtils.error(ResultCode.NO_FIND_THINGS);
        }
        return ResultUtils.ok(author);
    }
}
複製代碼

這裏 @Cacheable(value="poemInfo")這個註解的意思就是自動根據方法生成緩存，value就是緩存下來的key。

到這裏咱們就已經把redis整合到了springboot中了，感興趣的同窗能夠關注一下咱們的一個開源項目Android App《最美詩詞》。

App《最美詩詞》Android端源碼Github地址： VinsonGuo/android-poetry

App《最美詩詞》服務端源碼(本教程)Github地址： Alex-Jerry/Java-Poetry

App《最美詩詞》APK酷安下載地址： 最美詩詞(com.tech502.poetry) - 1.0 - 應用 - 酷安網

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程