SpringBoot數據訪問（三） SpringBoot整合Redis

前言

除了對關系型數據庫的整合支持外，SpringBoot對非關系型數據庫也提供了非常好的支持，比如，對Redis的支持。

Redis（Remote Dictionary Server，即遠程字典服務）是一個高性能的key-value數據庫，它是一種跨平台的非關系型數據庫。Redis 通常被稱為數據結構服務器，因為它的值（value）可以是字符串(String)、哈希(Hash)、列表(list)、集合(sets)和有序集合(sorted sets)等類型。

下面，我們來看一下SpringBoot與Redis要如何進行整合。

SpringBoot與非關系型數據庫Redis的整合

（1）添加Spring Data Redis依賴啟動器

引入這個依賴器創建項目，在項目pom.xml文件會出現以下依賴：

（2）編寫實體類

Person：

package com.hardy.springbootdataredis.domain;

import org.springframework.data.annotation.Id;
import org.springframework.data.redis.core.RedisHash;
import org.springframework.data.redis.core.index.Indexed;

/**
 * @Author: HardyYao
 * @Date: 2021/6/15
 */
@RedisHash("persons")   // 指定操作實體類對象在Redis數據庫中的存儲空間
public class Person {

    @Id // 標識實體類主鍵
    private String id;

    @Indexed // 標識對應屬性在Redis數據庫中生成二級索引
    private String firstname;

    @Indexed
    private String lastname;

    private Address address;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getFirstname() {
        return firstname;
    }

    public void setFirstname(String firstname) {
        this.firstname = firstname;
    }

    public String getLastname() {
        return lastname;
    }

    public void setLastname(String lastname) {
        this.lastname = lastname;
    }

    public Address getAddress() {
        return address;
    }

    public void setAddress(Address address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "Person{" +
                "id='" + id + '\'' +
                ", firstname='" + firstname + '\'' +
                ", lastname='" + lastname + '\'' +
                ", address=" + address +
                '}';
    }
}

Address：

package com.hardy.springbootdataredis.domain;

import org.springframework.data.redis.core.index.Indexed;

/**
 * @Author: HardyYao
 * @Date: 2021/6/15
 */
public class Address {

    @Indexed
    private String city;

    @Indexed
    private String country;

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public String getCountry() {
        return country;
    }

    public void setCountry(String country) {
        this.country = country;
    }

    @Override
    public String toString() {
        return "Address{" +
                "city='" + city + '\'' +
                ", country='" + country + '\'' +
                '}';
    }
}

在上述兩個實體類中，涉及了關於Redis數據庫的數據操作的幾個注解：

• @RedisHash("persons")：用於指定操作實體類對象在Redis數據庫中的存儲空間，此處表示針對Person實體類的數據操作都存儲在Redis數據庫中名為persons的存儲空間下。
• @Id：用於標識實體類主鍵。在Redis數據庫中會默認生成字符串形式的HashKey表示唯一的實體對象id，當然也可以在數據存儲時手動指定id。
• @Indexed：用於標識對應屬性在Redis數據庫中生成二級索引。使用該注解后會在數據庫中生成屬性對應的二級索引，索引名稱就是屬性名，可以方便地進行數據查詢。

（3）編寫Repository接口

SpringBoot針對包括Redis在內的一些常用數據庫提供了自動化配置，可以通過實現Repository接口簡化對數據庫中的數據進行增刪查改的操作：

package com.hardy.springbootdataredis.repository;

import com.hardy.springbootdataredis.domain.Person;
import org.springframework.data.repository.CrudRepository;

import java.util.List;

/**
 * @Author: HardyYao
 * @Date: 2021/6/15
 */
public interface PersonRepository extends CrudRepository<Person, String> {

    List<Person> findByAddress_City(String City);

}

注意：在操作Redis數據庫時編寫的Repository接口類需要繼承最底層的CrudRepository接口，而不是繼承JpaRepository（JpaRepository是SpringBoot整合JPA特有的）。當然，也可以在項目pom.xml文件中同時導入SpringBoot整合的JPA依賴和Redis依賴，這樣就可以編寫一個繼承JpaRepository的接口的操作Redis數據庫。

（4）Redis數據庫連接配置

在項目的全局配置文件application.properties中添加Redis數據庫的連接配置，示例代碼如下：

# Redis服務器地址
spring.redis.host=127.0.0.1
# Redis服務器連接端口
spring.redis.port=6379
# Redis服務器連接密碼（默認為空）
spring.redis.password=

（5）編寫單元測試方法

package com.hardy.springbootdataredis;

import com.hardy.springbootdataredis.domain.Address;
import com.hardy.springbootdataredis.domain.Person;
import com.hardy.springbootdataredis.repository.PersonRepository;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class SpringbootdataRedisApplicationTests {

    @Autowired
    private PersonRepository repository;

    @Test
    public void savePerson() {
        Person person = new Person();
        person.setFirstname("張");
        person.setLastname("三");
        Address address = new Address();
        address.setCity("北京");
        address.setCountry("中國");
        person.setAddress(address);
        // 向Redis數據庫添加數據
        Person save = repository.save(person);
    }

    @Test
    public void selectPerson() {
        List<Person> list = repository.findByAddress_City("北京");
        for (Person person : list) {
            System.out.println(person);
        }
    }

}

（6）整合測試

打開Redis客戶端可視化管理工具，先連接本地Redis服務器：

連接成功后，可以看到原來本地Redis數據庫中是沒有數據的：

運行上文中編寫好的兩個測試方法，查看控制台打印結果：

為了驗證save()方法確實把數據寫入到本地Redis數據庫中了，打開Redis客戶端可視化管理工具，刷新一下數據，可以看到數據成功寫入了：

通過上圖可知：執行save()方法添加的數據在Redis數據庫中存儲成功。另外，在數據庫列表左側還形成了一張類似address.city、firstname、lastname等二級索引，這些二級索引是前面創建Person類時在對應屬性上添加@Indexed注解而生成的。同時，由於在Redis數據庫中生成了對應屬性的二級索引，所以可以通過二級索引來查詢具體的數據信息，例如repository.findByAddress_City("北京")通過address.city索引查詢索引值為北京的數據信息。如果沒有設置對應屬性的二級索引，那么通過屬性索引查詢的數據結果將為空。