Gunakan Spring Data R2DBC dengan Azure SQL Database

Artikel
05/23/2023

Artikel ini menunjukkan pembuatan aplikasi contoh yang menggunakan Spring Data R2DBC untuk menyimpan dan mengambil informasi di Azure SQL Database menggunakan implementasi R2DBC untuk Microsoft SQL Server dari repositori GitHub r2dbc-mssql.

R2DBC membawa API reaktif ke database relasional tradisional. Anda dapat menggunakannya dengan Spring WebFlux untuk membuat aplikasi Spring Boot yang sepenuhnya reaktif, yang menggunakan API non-blocking. Ini akan memberikan skalabilitas yang lebih baik daripada pendekatan klasik "satu utas per koneksi".

Prasyarat

Langganan Azure - membuat secara gratis.
Java Development Kit (JDK), versi 8 atau yang lebih tinggi.
Apache Maven.
Azure CLI.

Utilitas sqlcmd.
cURL atau utilitas HTTP serupa untuk menguji fungsionalitas.

Lihat aplikasi sampel

Dalam artikel ini, Anda akan membuat kode aplikasi sampel. Jika Anda ingin lebih cepat, aplikasi ini sudah dikodekan dan tersedia di https://github.com/Azure-Samples/quickstart-spring-data-r2dbc-sql-server.

Menyiapkan lingkungan kerja

Pertama-tama, siapkan beberapa variabel lingkungan menggunakan beberapa perintah berikut:

export AZ_RESOURCE_GROUP=database-workshop
export AZ_DATABASE_NAME=<YOUR_DATABASE_NAME>
export AZ_LOCATION=<YOUR_AZURE_REGION>
export AZ_SQL_SERVER_ADMIN_USERNAME=spring
export AZ_SQL_SERVER_ADMIN_PASSWORD=<YOUR_AZURE_SQL_ADMIN_PASSWORD>
export AZ_SQL_SERVER_NON_ADMIN_USERNAME=nonspring
export AZ_SQL_SERVER_NON_ADMIN_PASSWORD=<YOUR_AZURE_SQL_NON_ADMIN_PASSWORD>
export AZ_LOCAL_IP_ADDRESS=<YOUR_LOCAL_IP_ADDRESS>

Ganti tempat penampung dengan nilai berikut, yang digunakan di seluruh artikel ini:

<YOUR_DATABASE_NAME>: Nama server Azure SQL Database Anda, yang harus unik di seluruh Azure.
<YOUR_AZURE_REGION>: Wilayah Azure yang akan Anda gunakan. Anda dapat menggunakan eastus secara default, tetapi kami menyarankan agar Anda mengonfigurasi wilayah yang lebih dekat ke tempat tinggal Anda. Anda dapat melihat daftar lengkap wilayah yang tersedia dengan menggunakan az account list-locations.
<AZ_SQL_SERVER_ADMIN_PASSWORD> dan <AZ_SQL_SERVER_NON_ADMIN_PASSWORD>: Kata sandi server Azure SQL Database Anda, yang harus memiliki minimal delapan karakter. Kata sandi Anda harus berisi karakter dari tiga kategori berikut – huruf besar Inggris, huruf kecil Inggris, angka (0-9), dan karakter non-alfanumerik (!, $, #,%, dll.).
<YOUR_LOCAL_IP_ADDRESS>: Alamat IP komputer lokal, tempat Anda akan menjalankan aplikasi Spring Boot. Salah satu cara mudah untuk menemukannya adalah dengan membuka whatismyip.akamai.com.

Berikutnya, buat grup sumber daya menggunakan perintah berikut:

az group create \
    --name $AZ_RESOURCE_GROUP \
    --location $AZ_LOCATION \
    --output tsv

Membuat contoh Azure SQL Database

Selanjutnya, buat instans server Azure SQL Database terkelola dengan menjalankan perintah berikut.

Catatan

Kata sandi MS SQL harus memenuhi kriteria tertentu, dan penyiapan akan gagal dengan kata sandi yang tidak sesuai. Untuk informasi selengkapnya, lihat Kebijakan Kata Sandi.

az sql server create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name $AZ_DATABASE_NAME \
    --location $AZ_LOCATION \
    --admin-user $AZ_SQL_SERVER_ADMIN_USERNAME \
    --admin-password $AZ_SQL_SERVER_ADMIN_PASSWORD \
    --output tsv

Mengonfigurasi aturan firewall untuk server Azure SQL Database Anda

Instans Azure SQL Database diamankan secara default. Mereka memiliki firewall yang tidak mengizinkan koneksi masuk. Agar bisa menggunakan database Anda, Anda perlu menambahkan aturan firewall yang akan memungkinkan alamat IP lokal mengakses server database.

Karena Anda mengonfigurasi alamat IP lokal kami di awal artikel ini, Anda dapat membuka firewall server dengan menjalankan perintah berikut:

az sql server firewall-rule create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name $AZ_DATABASE_NAME-database-allow-local-ip \
    --server $AZ_DATABASE_NAME \
    --start-ip-address $AZ_LOCAL_IP_ADDRESS \
    --end-ip-address $AZ_LOCAL_IP_ADDRESS \
    --output tsv

Jika Anda menyambungkan ke server Azure SQL Database dari Subsistem Windows untuk Linux (WSL) di komputer Windows, Anda perlu menambahkan ID host WSL ke firewall Anda.

Dapatkan alamat IP komputer host Anda dengan menjalankan perintah berikut di WSL:

cat /etc/resolv.conf

Salin alamat IP dengan mengikuti istilah nameserver, lalu gunakan perintah berikut untuk mengatur variabel lingkungan untuk Alamat IP WSL:

export AZ_WSL_IP_ADDRESS=<the-copied-IP-address>

Kemudian, gunakan perintah berikut untuk membuka firewall server ke aplikasi berbasis WSL Anda:


az sql server firewall-rule create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name $AZ_DATABASE_NAME-database-allow-local-ip-wsl \
    --server $AZ_DATABASE_NAME \
    --start-ip-address $AZ_WSL_IP_ADDRESS \
    --end-ip-address $AZ_WSL_IP_ADDRESS \
    --output tsv

Mengonfigurasi database Azure SQL

Server Azure SQL Database yang Anda buat sebelumnya kosong. Server tersebut tidak memiliki database yang dapat Anda gunakan dengan aplikasi Spring Boot. Buat database baru yang dipanggil demo dengan menjalankan perintah berikut ini:

az sql db create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name demo \
    --server $AZ_DATABASE_NAME \
    --output tsv

Membuat pengguna non-admin database SQL dan memberikan izin

Langkah ini akan membuat pengguna non-admin dan memberikan semua izin pada database ke demo dalamnya.

Buat skrip SQL yang disebut create_user.sql untuk membuat pengguna non-admin. Tambahkan konten berikut dan simpan secara lokal:

cat << EOF > create_user.sql
USE demo;
GO
CREATE USER $AZ_SQL_SERVER_NON_ADMIN_USERNAME WITH PASSWORD='$AZ_SQL_SERVER_NON_ADMIN_PASSWORD'
GO
GRANT CONTROL ON DATABASE::demo TO $AZ_SQL_SERVER_NON_ADMIN_USERNAME;
GO
EOF

Kemudian, gunakan perintah berikut untuk menjalankan skrip SQL untuk membuat pengguna non-admin:

sqlcmd -S $AZ_DATABASE_NAME.database.windows.net,1433  -d demo -U $AZ_SQL_SERVER_ADMIN_USERNAME -P $AZ_SQL_SERVER_ADMIN_PASSWORD  -i create_user.sql

Catatan

Untuk informasi selengkapnya tentang membuat pengguna database SQL, lihat MEMBUAT PENGGUNA (Transact-SQL).

Buat aplikasi Spring Boot reaktif

Untuk membuat aplikasi Spring Boot reaktif, kita akan menggunakan Spring Initializr. Aplikasi yang akan kita buat akan menggunakan:

Spring Boot 2.7.11.
Dependensi berikut: Spring Reactive Web (juga dikenal sebagai Spring WebFlux) dan Spring Data R2DBC.

Hasilkan aplikasi dengan menggunakan Spring Initializr

Buat aplikasi pada baris perintah dengan menjalankan perintah berikut:

curl https://start.spring.io/starter.tgz -d dependencies=webflux,data-r2dbc -d baseDir=azure-database-workshop -d bootVersion=2.7.11 -d javaVersion=17 | tar -xzvf -

Tambahkan implementasi driver Azure SQL Database reaktif

Buka file pom.xml proyek yang dihasilkan untuk menambahkan driver Azure SQL Database reaktif dari repositori GitHub r2dbc-mssql.

Setelah dependensi spring-boot-starter-webflux, tambahkan teks berikut:

<dependency>
    <groupId>io.r2dbc</groupId>
    <artifactId>r2dbc-mssql</artifactId>
    <scope>runtime</scope>
</dependency>

Mengonfigurasi Spring Boot untuk menggunakan Azure SQL Database

Buka file src/main/resources/application.properties, dan tambahkan teks berikut ini:

logging.level.org.springframework.data.r2dbc=DEBUG

spring.r2dbc.url=r2dbc:pool:mssql://$AZ_DATABASE_NAME.database.windows.net:1433/demo
spring.r2dbc.username=nonspring@$AZ_DATABASE_NAME
spring.r2dbc.password=$AZ_SQL_SERVER_NON_ADMIN_PASSWORD

Ganti dua variabel $AZ_DATABASE_NAME dan variabel $AZ_SQL_SERVER_NON_ADMIN_PASSWORD dengan nilai yang Anda konfigurasikan di awal artikel ini.

Catatan

Untuk kinerja yang lebih baik, properti spring.r2dbc.url dikonfigurasi untuk menggunakan kumpulan koneksi menggunakan r2dbc-pool.

Kini Anda dapat memulai aplikasi dengan menggunakan wrapper Maven yang telah disediakan sebagai berikut:

./mvnw spring-boot:run

Berikut adalah cuplikan layar aplikasi yang berjalan untuk pertama kalinya:

Buat skema database

Di dalam kelas DemoApplication utama, konfigurasikan bean Spring baru yang akan membuat skema database, menggunakan kode berikut:

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.core.io.ClassPathResource;
import org.springframework.data.r2dbc.connectionfactory.init.ConnectionFactoryInitializer;
import org.springframework.data.r2dbc.connectionfactory.init.ResourceDatabasePopulator;

import io.r2dbc.spi.ConnectionFactory;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Bean
    public ConnectionFactoryInitializer initializer(ConnectionFactory connectionFactory) {
        ConnectionFactoryInitializer initializer = new ConnectionFactoryInitializer();
        initializer.setConnectionFactory(connectionFactory);
        ResourceDatabasePopulator populator = new ResourceDatabasePopulator(new ClassPathResource("schema.sql"));
        initializer.setDatabasePopulator(populator);
        return initializer;
    }
}

Bean Spring ini menggunakan file yang disebut schema.sql, maka buatlah file tersebut di folder src/main/resources, dan tambahkan teks berikut:

DROP TABLE IF EXISTS todo;
CREATE TABLE todo (id INT IDENTITY PRIMARY KEY, description VARCHAR(255), details VARCHAR(4096), done BIT);

Hentikan aplikasi yang berjalan, lalu mulai kembali menggunakan perintah berikut. Aplikasi sekarang akan menggunakan database demo yang Anda buat sebelumnya, dan membuat tabel todo di dalamnya.

./mvnw spring-boot:run

Berikut adalah tangkapan layar tabel database saat sedang dibuat:

Kodekan aplikasi

Selanjutnya, tambahkan kode Java yang akan menggunakan R2DBC untuk menyimpan dan mengambil data dari server Azure SQL Database Anda.

Tambahkan kelas Java Todo baru, di samping kelas DemoApplication, menggunakan kode berikut:

package com.example.demo;

import org.springframework.data.annotation.Id;

public class Todo {

    public Todo() {
    }

    public Todo(String description, String details, boolean done) {
        this.description = description;
        this.details = details;
        this.done = done;
    }

    @Id
    private Long id;

    private String description;

    private String details;

    private boolean done;

    public Long getId() {
        return id;
    }

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

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getDetails() {
        return details;
    }

    public void setDetails(String details) {
        this.details = details;
    }

    public boolean isDone() {
        return done;
    }

    public void setDone(boolean done) {
        this.done = done;
    }
}

Kelas ini adalah model domain yang dipetakan pada tabel todo yang Anda buat sebelumnya.

Untuk mengelola kelas itu, Anda memerlukan repositori. Tentukan antarmuka TodoRepository baru dalam paket yang sama, menggunakan kode berikut:

package com.example.demo;

import org.springframework.data.repository.reactive.ReactiveCrudRepository;

public interface TodoRepository extends ReactiveCrudRepository<Todo, Long> {
}

Repositori ini adalah repositori reaktif yang dikelola Spring Data R2DBC.

Selesaikan aplikasi dengan membuat pengontrol yang dapat menyimpan dan mengambil data. Terapkan kelas TodoController dalam paket yang sama, dan tambahkan kode berikut:

package com.example.demo;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

@RestController
@RequestMapping("/")
public class TodoController {

    private final TodoRepository todoRepository;

    public TodoController(TodoRepository todoRepository) {
        this.todoRepository = todoRepository;
    }

    @PostMapping("/")
    @ResponseStatus(HttpStatus.CREATED)
    public Mono<Todo> createTodo(@RequestBody Todo todo) {
        return todoRepository.save(todo);
    }

    @GetMapping("/")
    public Flux<Todo> getTodos() {
        return todoRepository.findAll();
    }
}

Terakhir, hentikan aplikasi lalu mulai kembali menggunakan perintah berikut:

./mvnw spring-boot:run

Uji aplikasi

Untuk menguji aplikasi, Anda dapat menggunakan cURL.

Pertama, buat item "todo" baru dalam database menggunakan perintah berikut:

curl --header "Content-Type: application/json" \
    --request POST \
    --data '{"description":"configuration","details":"congratulations, you have set up R2DBC correctly!","done": "true"}' \
    http://127.0.0.1:8080

Perintah ini harus menghasilkan item yang dibuat, seperti yang ditampilkan di sini:

{"id":1,"description":"configuration","details":"congratulations, you have set up R2DBC correctly!","done":true}

Selanjutnya, ambil data menggunakan permintaan cURL baru dengan perintah berikut:

curl http://127.0.0.1:8080

Perintah ini akan menghasilkan daftar item "todo", termasuk item yang telah Anda buat, seperti yang ditampilkan berikut ini:

[{"id":1,"description":"configuration","details":"congratulations, you have set up R2DBC correctly!","done":true}]

Berikut adalah tangkapan layar beberapa permintaan cURL:

Selamat! Anda telah menciptakan aplikasi Spring Boot yang sepenuhnya reaktif, yang menggunakan R2DBC untuk menyimpan dan mengambil data dari Azure SQL Database.

Membersihkan sumber daya

Untuk membersihkan semua sumber daya yang digunakan selama mulai cepat ini, hapus grup sumber daya dengan menggunakan perintah berikut:

az group delete \
    --name $AZ_RESOURCE_GROUP \
    --yes

Langkah berikutnya

Untuk mempelajari selengkapnya tentang menyebarkan aplikasi Spring Data ke Azure Spring Apps dan menggunakan identitas terkelola, lihat Tutorial: Menyebarkan aplikasi Spring ke Azure Spring Apps dengan koneksi tanpa kata sandi ke database Azure.

Untuk mempelajari selengkapnya tentang Spring dan Azure, lanjutkan ke pusat dokumentasi Spring di Azure.

Spring di Azure

Share via

Gunakan Spring Data R2DBC dengan Azure SQL Database

Prasyarat

Lihat aplikasi sampel

Menyiapkan lingkungan kerja

Membuat contoh Azure SQL Database

Mengonfigurasi aturan firewall untuk server Azure SQL Database Anda

Mengonfigurasi database Azure SQL

Membuat pengguna non-admin database SQL dan memberikan izin

Buat aplikasi Spring Boot reaktif

Hasilkan aplikasi dengan menggunakan Spring Initializr

Tambahkan implementasi driver Azure SQL Database reaktif

Mengonfigurasi Spring Boot untuk menggunakan Azure SQL Database

Buat skema database

Kodekan aplikasi

Uji aplikasi

Membersihkan sumber daya

Langkah berikutnya

Baca juga

Saran dan Komentar

Saran dan Komentar

Sumber Daya Tambahan: