在Spring data中使用r2dbc

flydean發表於2020-11-28
Spring

簡介

上篇文章我們講到了怎麼在Spring webFlux中使用r2dbc,今天我們看一下怎麼使用spring-data-r2dbc這個Spring data對r2dbc的封裝來進行r2dbc操作。

依賴關係

要使用Spring-datea-r2dbc需要配置下面的依賴關係：


    <dependencies>
        <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-r2dbc</artifactId>
        <version>2.3.3.RELEASE</version>
    </dependency>

        <!-- R2DBC H2 Driver -->
        <dependency>
            <groupId>io.r2dbc</groupId>
            <artifactId>r2dbc-h2</artifactId>
            <version>${r2dbc-h2.version}</version>
        </dependency>

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

資料庫連線配置

Spring-data-r2dbc使用的是R2dbcProperties來進行配置檔案的讀取：

簡單看一下R2dbcProperties的定義：

@ConfigurationProperties(prefix = "spring.r2dbc")
public class R2dbcProperties {

    /**
     * Database name. Set if no name is specified in the url. Default to "testdb" when
     * using an embedded database.
     */
    private String name;

    /**
     * Whether to generate a random database name. Ignore any configured name when
     * enabled.
     */
    private boolean generateUniqueName;

    /**
     * R2DBC URL of the database. database name, username, password and pooling options
     * specified in the url take precedence over individual options.
     */
    private String url;

    /**
     * Login username of the database. Set if no username is specified in the url.
     */
    private String username;

    /**
     * Login password of the database. Set if no password is specified in the url.
     */
    private String password;

相應的，看一下我們的配置檔案是怎麼樣的：

spring.r2dbc.url=r2dbc:h2:mem://./testdb
spring.r2dbc.username=sa
spring.r2dbc.password=password

這裡，我們使用的是H2資料庫。

資料庫初始化

資料庫初始化過程中，我們需要建立一個users表格，這裡我們在一個initDatabase bean中實現：

    @Bean
    public ApplicationRunner initDatabase(DatabaseClient client, UsersDao usersDao) {
        List<String> statements = Arrays.asList(
                "DROP TABLE IF EXISTS USERS;",
                "CREATE TABLE IF NOT EXISTS USERS ( id SERIAL PRIMARY KEY, firstname VARCHAR(100) NOT NULL, lastname VARCHAR(100) NOT NULL);");

        statements.forEach(sql -> executeSql(client,sql)
                .doOnSuccess(count -> log.info("Schema created, rows updated: {}", count))
                .doOnError(error -> log.error("got error : {}",error.getMessage(),error))
                .subscribe()
        );

        return args ->getUser().flatMap(usersDao::save).subscribe(user -> log.info("User saved: {}", user));

    }

    private Flux<Users> getUser() {
        return Flux.just(new Users(null, "John", "Doe"), new Users(null, "Jane", "Doe"));
    }

    private Mono<Integer> executeSql(DatabaseClient client, String sql) {
        return client.execute(sql).fetch().rowsUpdated();
    }

上面的例子中，我們建立資料庫分為了兩部分，第一部分是資料庫schema的操作，我們執行了drop和create table的操作。

第二部分是向資料庫表中插入資料。

注意，上面的兩部分操作都需要執行subscribe操作，以觸發真正的Reactive操作。

DAO操作

在DAO操作之前，我們需要建立Users entity：

@Data
@AllArgsConstructor
public class Users {

    @Id
    private Integer id;
    private String firstname;
    private String lastname;

    boolean hasId() {
        return id != null;
    }
}

再看一下我們建立的UserDao：

public interface UsersDao extends ReactiveCrudRepository<Users, Long> {

    @Query("select id, firstname, lastname from users c where c.lastname = :lastname")
    Flux<Users> findByLastname(String lastname);
}

注意，這裡並不需要新增@Component註解，因為我們繼承了ReactiveCrudRepository，會自動幫我們建立UsersDao的例項，我們直接使用就可以了。

ReactiveCrudRepository為我們封裝了一些DAO的基本操作，比如save，saveAll, findById ,existsById等基礎操作。

當然，我們也可以自定義自己的SQL語句，比如上面的findByLastname。

Service操作和Transaction

我們看一下怎麼使用UserDao來進行具體的方法操作：

@Component
public class UsersService {

    @Resource
    private UsersDao usersDao;

    @Transactional
    public Mono<Users> save(Users user) {

        return usersDao.save(user).map(it -> {

            if (it.getFirstname().equals("flydean")) {
                throw new IllegalStateException();
            } else {
                return it;
            }
        });
    }

}

上面我們建立了一個save方法，用來儲存相應的User物件。

controller

最後，我們建立一個controller來對外暴露相應的方法：

@RestController
@RequiredArgsConstructor
public class UsersController {

    private final UsersDao usersDao;

    @GetMapping("/users")
    public Flux<Users> findAll() {
        return usersDao.findAll();
    }
}

測試

好了，現在我們的程式已經寫好了，可以進行測試了。

執行程式，執行：

curl "localhost:8080/users"    
[{"id":1,"firstname":"John","lastname":"Doe"},{"id":2,"firstname":"Jane","lastname":"Doe"}]%

可以看到取出了相應的結果。

完美，實驗成功。

本文的程式碼：spring-data-r2dbc

本文作者：flydean程式那些事

本文連結：http://www.flydean.com/spring-data-r2dbc/

本文來源：flydean的部落格

歡迎關注我的公眾號:「程式那些事」最通俗的解讀，最深刻的乾貨，最簡潔的教程，眾多你不知道的小技巧等你來發現！

相關文章