Gunakan Spring Data dengan Azure Database for PostgreSQL

Artikel
10/26/2023

Tutorial ini menunjukkan cara menyimpan data dalam database Azure Database for PostgreSQL menggunakan Spring Data JDBC.

JDBC adalah Java API standar untuk terhubung ke database hubungan tradisional.

Dalam tutorial ini, kami menyertakan dua metode autentikasi: autentikasi Microsoft Entra dan autentikasi PostgreSQL. Tab Tanpa Kata Sandi memperlihatkan autentikasi Microsoft Entra dan tab Kata Sandi memperlihatkan autentikasi PostgreSQL.

Autentikasi Microsoft Entra adalah mekanisme untuk menyambungkan ke Azure Database for PostgreSQL menggunakan identitas yang ditentukan dalam ID Microsoft Entra. Dengan autentikasi Microsoft Entra, Anda dapat mengelola identitas pengguna database dan layanan Microsoft lain di lokasi pusat, yang menyederhanakan manajemen izin.

Autentikasi PostgreSQL menggunakan akun yang disimpan di PostgreSQL. Jika Anda memilih untuk menggunakan kata sandi sebagai kredensial untuk akun, kredensial ini akan disimpan dalam user tabel. Karena kata sandi ini disimpan di PostgreSQL, Anda perlu mengelola rotasi kata sandi sendiri.

Prasyarat

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

Klien baris perintah PostgreSQL.
Jika Anda tidak memiliki aplikasi Spring Boot, buat proyek Maven dengan Spring Initializr. Pastikan untuk memilih Proyek Maven dan, di bawah Dependensi, tambahkan dependensi Spring Web, Spring Data JDBC, dan PostgreSQL Driver , lalu pilih Java versi 8 atau yang lebih tinggi.

Jika Anda tidak memilikinya, buat instans Azure Database for PostgreSQL Flexible Server bernama postgresqlflexibletest dan database bernama demo. Untuk petunjuknya, lihat Mulai Cepat: Membuat Azure Database for PostgreSQL - Server Fleksibel di portal Azure.

Lihat aplikasi sampel

Dalam tutorial 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-jdbc-postgresql.

Mengonfigurasi aturan firewall untuk server PostgreSQL Anda

Instans Azure Database for PostgreSQL diamankan secara default. Mereka memiliki firewall yang tidak mengizinkan koneksi masuk.

Agar dapat menggunakan database Anda, buka firewall server untuk mengizinkan alamat IP lokal mengakses server database. Untuk informasi selengkapnya, lihat Aturan firewall di Azure Database for PostgreSQL - Server Fleksibel.

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

Membuat pengguna non-admin PostgreSQL dan memberikan izin

Selanjutnya, buat pengguna non-admin dan berikan semua izin ke database.

Tanpa Kata Sandi (Disarankan)
Password

Anda dapat menggunakan metode berikut untuk membuat pengguna non-admin yang menggunakan koneksi tanpa kata sandi.

Service Koneksi or (Disarankan)
Konfigurasi manual

Gunakan perintah berikut untuk menginstal ekstensi Service Koneksi or passwordless untuk Azure CLI:
```
 az extension add --name serviceconnector-passwordless --upgrade
```

Gunakan perintah berikut untuk membuat pengguna non-admin Microsoft Entra:

  az connection create postgres-flexible \
       --resource-group <your_resource_group_name> \
       --connection postgres_conn \
       --target-resource-group <your_resource_group_name> \
       --server postgresqlflexibletest \
       --database demo \
       --user-account \
       --query authInfo.userName \
       --output tsv

Setelah perintah selesai, perhatikan nama pengguna di output konsol.

Penting

Untuk menggunakan koneksi tanpa kata sandi, konfigurasikan pengguna admin Microsoft Entra untuk instans Server Fleksibel Azure Database for PostgreSQL Anda. Untuk informasi selengkapnya, lihat Mengelola peran Microsoft Entra di Azure Database for PostgreSQL - Server Fleksibel.

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

cat << EOF > create_ad_user.sql
select * from pgaadauth_create_principal('<your_postgresql_ad_non_admin_username>', false, false);
EOF

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

psql "host=postgresqlflexibletest.postgres.database.azure.com user=<your_postgresql_ad_admin_username> dbname=postgres port=5432 password=$(az account get-access-token --resource-type oss-rdbms --output tsv --query accessToken) sslmode=require" < create_ad_user.sql

Tip

Untuk menggunakan autentikasi Microsoft Entra untuk menyambungkan ke Azure Database for PostgreSQL, Anda perlu masuk dengan pengguna admin Microsoft Entra yang Anda siapkan, lalu mendapatkan token akses sebagai kata sandi. Untuk informasi selengkapnya, lihat Menggunakan ID Microsoft Entra untuk autentikasi dengan Azure Database for PostgreSQL - Server Fleksibel.

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
CREATE ROLE "<your_postgresql_non_admin_username>" WITH LOGIN PASSWORD '<your_postgresql_non_admin_password>';
GRANT ALL PRIVILEGES ON DATABASE demo TO "<your_postgresql_non_admin_username>";
EOF

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

psql "host=postgresqlflexibletest.postgres.database.azure.com user=<your_postgresql_admin_username> dbname=demo port=5432 password=<your_postgresql_admin_password> sslmode=require" < create_user.sql

Catatan

Untuk informasi selengkapnya, lihat Membuat pengguna di Azure Database for PostgreSQL - Server Fleksibel.

Menyimpan data dari Azure Database for PostgreSQL

Sekarang setelah Anda memiliki instans Server Fleksibel Azure Database for PostgreSQL, Anda dapat menyimpan data dengan menggunakan Spring Cloud Azure.

Untuk menginstal modul Spring Cloud Azure Starter JDBC PostgreSQL, tambahkan dependensi berikut ke file pom.xml Anda:

Spring Cloud Azure Bill of Materials (BOM):
```
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.12.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
Catatan

Jika Anda menggunakan Spring Boot 2.x, pastikan untuk mengatur versi ke spring-cloud-azure-dependencies4.18.0. Bill of Material (BOM) ini harus dikonfigurasi di bagian <dependencyManagement> file pom.xml Anda. Ini memastikan bahwa semua dependensi Spring Cloud Azure menggunakan versi yang sama. Untuk informasi selengkapnya tentang versi yang digunakan untuk BOM ini, lihat Versi Spring Cloud Azure mana yang Harus Saya Gunakan.

Artefak JDBC PostgreSQL Spring Cloud Azure Starter:

<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter-jdbc-postgresql</artifactId>
</dependency>

Catatan

Koneksi tanpa kata sandi telah didukung sejak versi 4.5.0.

Konfigurasikan Spring Boot untuk menggunakan Azure Database for PostgreSQL

Untuk menyimpan data dari Azure Database for PostgreSQL menggunakan Spring Data JDBC, ikuti langkah-langkah berikut untuk mengonfigurasi aplikasi:

Konfigurasikan kredensial Azure Database for PostgreSQL dengan menambahkan properti berikut ke file konfigurasi application.properties Anda.

Tanpa Kata Sandi (Disarankan)
Password

logging.level.org.springframework.jdbc.core=DEBUG

spring.datasource.url=jdbc:postgresql://postgresqlflexibletest.postgres.database.azure.com:5432/demo?sslmode=require
spring.datasource.username=<your_postgresql_ad_non_admin_username>
spring.datasource.azure.passwordless-enabled=true

spring.sql.init.mode=always

logging.level.org.springframework.jdbc.core=DEBUG

spring.datasource.url=jdbc:postgresql://postgresqlflexibletest.postgres.database.azure.com:5432/demo?sslmode=require
spring.datasource.username=<your_postgresql_non_admin_username>
spring.datasource.password=<your_postgresql_non_admin_password>

spring.sql.init.mode=always

Peringatan

Properti spring.sql.init.mode=always konfigurasi berarti bahwa Spring Boot akan secara otomatis menghasilkan skema database, menggunakan file schema.sql yang akan Anda buat berikutnya, setiap kali server dimulai. Fitur ini sangat bagus untuk pengujian, tetapi ingat bahwa fitur ini akan menghapus data Anda di setiap restart, sehingga Anda tidak boleh menggunakannya dalam produksi.

Jika Anda tidak memilikinya, buat instans Server Tunggal Azure Database for PostgreSQL bernama postgresqlsingletest dan database bernama demo. Untuk petunjuknya, lihat Mulai Cepat: Membuat server Azure Database for PostgreSQL dengan menggunakan portal Azure.

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-jdbc-postgresql.

Mengonfigurasi aturan firewall untuk server PostgreSQL Anda

Instans Azure Database for PostgreSQL diamankan secara default. Mereka memiliki firewall yang tidak mengizinkan koneksi masuk.

Agar dapat menggunakan database Anda, buka firewall server untuk mengizinkan alamat IP lokal mengakses server database. Untuk informasi selengkapnya, lihat Membuat dan mengelola aturan firewall untuk Azure Database for PostgreSQL - Server Tunggal menggunakan portal Azure.

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

Membuat pengguna non-admin PostgreSQL dan memberikan izin

Selanjutnya, buat pengguna non-admin dan berikan semua izin ke database.

Tanpa Kata Sandi (Disarankan)
Password

Anda dapat menggunakan metode berikut untuk membuat pengguna non-admin yang menggunakan koneksi tanpa kata sandi.

Service Koneksi or (Disarankan)
Konfigurasi manual

Gunakan perintah berikut untuk menginstal ekstensi Service Koneksi or passwordless untuk Azure CLI:
```
 az extension add --name serviceconnector-passwordless --upgrade
```

Gunakan perintah berikut untuk membuat pengguna non-admin Microsoft Entra:

  az connection create postgres \
       --resource-group <your_resource_group_name> \
       --connection postgres_conn \
       --target-resource-group <your_resource_group_name> \
       --server postgresqlsingletest \
       --database demo \
       --user-account \
       --query authInfo.userName \
       --output tsv

Setelah perintah selesai, perhatikan nama pengguna di output konsol.

Penting

Untuk menggunakan koneksi tanpa kata sandi, konfigurasikan pengguna admin Microsoft Entra untuk instans Server Tunggal Azure Database for PostgreSQL Anda. Untuk informasi selengkapnya, lihat Menggunakan ID Microsoft Entra untuk autentikasi dengan PostgreSQL.

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

cat << EOF > create_ad_user.sql
SET aad_validate_oids_in_tenant = off;
CREATE ROLE "<your_postgresql_ad_non_admin_username>" WITH LOGIN IN ROLE azure_ad_user;
GRANT ALL PRIVILEGES ON DATABASE demo TO "<your_postgresql_ad_non_admin_username>";
EOF

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

psql "host=postgresqlsingletest.postgres.database.azure.com user=<your_postgresql_ad_admin_username>@postgresqlsingletest dbname=postgres port=5432 password=$(az account get-access-token --resource-type oss-rdbms --output tsv --query accessToken) sslmode=require" < create_ad_user.sql

Tip

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
CREATE ROLE "<your_postgresql_non_admin_username>" WITH LOGIN PASSWORD '<your_postgresql_non_admin_password>';
GRANT ALL PRIVILEGES ON DATABASE demo TO "<your_postgresql_non_admin_username>";
EOF

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

psql "host=postgresqlsingletest.postgres.database.azure.com user=<your_postgresql_admin_username>@postgresqlsingletest dbname=demo port=5432 password=<your_postgresql_admin_password> sslmode=require" < create_user.sql

Catatan

Anda dapat membaca informasi selengkapnya tentang membuat pengguna PostgreSQL di Membuat pengguna di Azure Database for PostgreSQL.

Menyimpan data dari Azure Database for PostgreSQL

Sekarang setelah Anda memiliki instans server Tunggal Azure Database for PostgreSQL, Anda dapat menyimpan data dengan menggunakan Spring Cloud Azure.

Untuk menginstal modul Spring Cloud Azure Starter JDBC PostgreSQL, tambahkan dependensi berikut ke file pom.xml Anda:

Spring Cloud Azure Bill of Materials (BOM):
```
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.12.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
Catatan

Jika Anda menggunakan Spring Boot 2.x, pastikan untuk mengatur versi ke spring-cloud-azure-dependencies4.18.0. Bill of Material (BOM) ini harus dikonfigurasi di bagian <dependencyManagement> file pom.xml Anda. Ini memastikan bahwa semua dependensi Spring Cloud Azure menggunakan versi yang sama. Untuk informasi selengkapnya tentang versi yang digunakan untuk BOM ini, lihat Versi Spring Cloud Azure mana yang Harus Saya Gunakan.

Artefak JDBC PostgreSQL Spring Cloud Azure Starter:

<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter-jdbc-postgresql</artifactId>
</dependency>

Catatan

Koneksi tanpa kata sandi telah didukung sejak versi 4.5.0.

Konfigurasikan Spring Boot untuk menggunakan Azure Database for PostgreSQL

Untuk menyimpan data dari Azure Database for PostgreSQL menggunakan Spring Data JDBC, ikuti langkah-langkah berikut untuk mengonfigurasi aplikasi:

Konfigurasikan kredensial Azure Database for PostgreSQL dengan menambahkan properti berikut ke file konfigurasi application.properties Anda.

Tanpa Kata Sandi (Disarankan)
Password

logging.level.org.springframework.jdbc.core=DEBUG

spring.datasource.url=jdbc:postgresql://postgresqlsingletest.postgres.database.azure.com:5432/demo?sslmode=require
spring.datasource.username=<your_postgresql_ad_non_admin_username>@postgresqlsingletest
spring.datasource.azure.passwordless-enabled=true

spring.sql.init.mode=always

logging.level.org.springframework.jdbc.core=DEBUG

spring.datasource.url=jdbc:postgresql://postgresqlsingletest.postgres.database.azure.com:5432/demo?sslmode=require
spring.datasource.username=<your_postgresql_non_admin_username>@postgresqlsingletest
spring.datasource.password=<your_postgresql_non_admin_password>

spring.sql.init.mode=always

Peringatan

Buat file konfigurasi src/main/resources/schema.sql untuk mengonfigurasi skema database, lalu tambahkan konten berikut.

DROP TABLE IF EXISTS todo;
CREATE TABLE todo (id SERIAL PRIMARY KEY, description VARCHAR(255), details VARCHAR(4096), done BOOLEAN);

Buat kelas Java baru Todo . Kelas ini adalah model domain yang dipetakan ke todo tabel yang akan dibuat secara otomatis oleh Spring Boot. Kode berikut mengabaikan getters metode dan setters .

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;

}

Edit file kelas startup untuk menampilkan konten berikut.
```
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Bean;
import org.springframework.data.repository.CrudRepository;

import java.util.stream.Stream;

@SpringBootApplication
public class DemoApplication {

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

    @Bean
    ApplicationListener<ApplicationReadyEvent> basicsApplicationListener(TodoRepository repository) {
        return event->repository
            .saveAll(Stream.of("A", "B", "C").map(name->new Todo("configuration", "congratulations, you have set up correctly!", true)).toList())
            .forEach(System.out::println);
    }

}

interface TodoRepository extends CrudRepository<Todo, Long> {

}
```
Tip

Dalam tutorial ini, tidak ada operasi autentikasi dalam konfigurasi atau kode. Namun, menyambungkan ke layanan Azure memerlukan autentikasi. Untuk menyelesaikan autentikasi, Anda perlu menggunakan Azure Identity. Spring Cloud Azure menggunakan DefaultAzureCredential, yang disediakan pustaka Azure Identity untuk membantu Anda mendapatkan kredensial tanpa perubahan kode apa pun.

DefaultAzureCredential mendukung beberapa metode autentikasi dan menentukan metode mana yang akan digunakan saat runtime. Pendekatan ini memungkinkan aplikasi Anda menggunakan metode autentikasi yang berbeda di lingkungan yang berbeda (seperti lingkungan lokal dan produksi) tanpa menerapkan kode khusus lingkungan. Untuk informasi selengkapnya, lihat DefaultAzureCredential.

Untuk menyelesaikan autentikasi di lingkungan pengembangan lokal, Anda dapat menggunakan Azure CLI, Visual Studio Code, PowerShell, atau metode lainnya. Untuk informasi selengkapnya, lihat Autentikasi Azure di lingkungan pengembangan Java. Untuk menyelesaikan autentikasi di lingkungan hosting Azure, sebaiknya gunakan identitas terkelola yang ditetapkan pengguna. Untuk informasi selengkapnya, lihat Apa yang dimaksud dengan identitas terkelola untuk sumber daya Azure?

Mulai aplikasi. Aplikasi menyimpan data ke dalam database. Anda akan melihat log yang mirip dengan contoh berikut:

2023-02-01 10:22:36.701 DEBUG 7948 --- [main] o.s.jdbc.core.JdbcTemplate : Executing prepared SQL statement [INSERT INTO todo (description, details, done) VALUES (?, ?, ?)]    
com.example.demo.Todo@4bdb04c8

Sebarkan ke Azure Spring Apps

Sekarang setelah Anda memiliki aplikasi Spring Boot yang berjalan secara lokal, saatnya untuk memindahkannya ke produksi. Azure Spring Apps memudahkan penyebaran aplikasi Spring Boot ke Azure tanpa perubahan kode apa pun. Layanan ini mengelola infrastruktur aplikasi Spring sehingga pengembang dapat fokus pada kode mereka. Azure Spring Apps menyediakan manajemen siklus hidup menggunakan pemantauan dan diagnostik yang komprehensif, manajemen konfigurasi, penemuan layanan, integrasi CI/CD, penyebaran biru-hijau, dan banyak lagi. Untuk menyebarkan aplikasi Anda ke Azure Spring Apps, lihat Menyebarkan aplikasi pertama Anda ke Azure Spring Apps.

Langkah berikutnya

Azure untuk pengembang Spring Sampel Spring Cloud Azure PostgreSQL

Share via

Gunakan Spring Data dengan Azure Database for PostgreSQL

Prasyarat

Lihat aplikasi sampel

Mengonfigurasi aturan firewall untuk server PostgreSQL Anda

Membuat pengguna non-admin PostgreSQL dan memberikan izin

Menyimpan data dari Azure Database for PostgreSQL

Konfigurasikan Spring Boot untuk menggunakan Azure Database for PostgreSQL

Lihat aplikasi sampel

Mengonfigurasi aturan firewall untuk server PostgreSQL Anda

Membuat pengguna non-admin PostgreSQL dan memberikan izin

Menyimpan data dari Azure Database for PostgreSQL

Konfigurasikan Spring Boot untuk menggunakan Azure Database for PostgreSQL

Sebarkan ke Azure Spring Apps

Langkah berikutnya

Saran dan Komentar

Saran dan Komentar

Sumber Daya Tambahan: