Mulai Cepat: Menggunakan Java dan JDBC dengan Azure Database for PostgreSQL - Server Fleksibel

  • Artikel

BERLAKU UNTUK: Azure Database for PostgreSQL - Server Fleksibel

Artikel ini menunjukkan pembuatan aplikasi sampel yang menggunakan Java dan JDBC untuk menyimpan dan mengambil informasi di server fleksibel Azure Database for PostgreSQL.

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

Dalam artikel ini, kami akan 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 harus mengelola rotasi kata sandi sendiri.

Prasyarat

Menyiapkan lingkungan kerja

Pertama, gunakan perintah berikut untuk menyiapkan beberapa variabel lingkungan.

export AZ_RESOURCE_GROUP=database-workshop
export AZ_DATABASE_SERVER_NAME=<YOUR_DATABASE_SERVER_NAME>
export AZ_DATABASE_NAME=<YOUR_DATABASE_NAME>
export AZ_LOCATION=<YOUR_AZURE_REGION>
export AZ_POSTGRESQL_AD_NON_ADMIN_USERNAME=<YOUR_POSTGRESQL_AD_NON_ADMIN_USERNAME>
export AZ_LOCAL_IP_ADDRESS=<YOUR_LOCAL_IP_ADDRESS>
export CURRENT_USERNAME=$(az ad signed-in-user show --query userPrincipalName -o tsv)

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

  • <YOUR_DATABASE_SERVER_NAME>: Nama instans server fleksibel Azure Database for PostgreSQL Anda, yang harus unik di seluruh Azure.
  • <YOUR_DATABASE_NAME>: Nama database instans server fleksibel Azure Database for PostgreSQL, yang harus unik dalam Azure.
  • <YOUR_AZURE_REGION>: Wilayah Azure yang akan digunakan. 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 memasukkan az account list-locations.
  • <YOUR_POSTGRESQL_AD_NON_ADMIN_USERNAME>: Nama pengguna instans server fleksibel Azure Database for PostgreSQL Anda. Pastikan nama pengguna adalah pengguna yang valid di penyewa Microsoft Entra Anda.
  • <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.

Penting

Saat mengatur <YOUR_POSTGRESQL_AD_NON_ADMIN_USERNAME>, nama pengguna harus sudah ada di penyewa Microsoft Entra Anda atau Anda tidak akan dapat membuat pengguna Microsoft Entra di database Anda.

Berikutnya, buat grup sumber daya menggunakan perintah berikut:

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

Membuat instans server fleksibel Azure Database for PostgreSQL

Bagian berikut menjelaskan cara membuat dan mengonfigurasi instans database Anda.

Membuat instans server fleksibel Azure Database for PostgreSQL dan menyiapkan pengguna admin

Hal pertama yang Anda buat adalah instans server fleksibel Azure Database for PostgreSQL terkelola.

Catatan

Anda dapat membaca informasi lebih rinci tentang membuat instans server fleksibel Azure Database for PostgreSQL di Membuat instans server fleksibel Azure Database for PostgreSQL dengan menggunakan portal Azure.

Jika Anda menggunakan Azure CLI, jalankan perintah berikut untuk memastikannya memiliki izin yang memadai:

az login --scope https://graph.microsoft.com/.default

Jalankan perintah berikut untuk membuat server:

az postgres flexible-server create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name $AZ_DATABASE_SERVER_NAME \
    --location $AZ_LOCATION \
    --yes \
    --output tsv

Untuk menyiapkan administrator Microsoft Entra setelah membuat server, ikuti langkah-langkah dalam Mengelola peran Microsoft Entra di Azure Database for PostgreSQL - Server Fleksibel.

Penting

Saat menyiapkan administrator, pengguna baru dengan hak istimewa administrator penuh ditambahkan ke database Azure instans server fleksibel Azure Database for PostgreSQL. Anda dapat membuat beberapa administrator Microsoft Entra per instans server fleksibel Azure Database for PostgreSQL.

Memiliki masalah? Beri tahu kami.

Mengonfigurasi aturan firewall untuk instans server fleksibel Azure Database for PostgreSQL Anda

Instans server fleksibel Azure Database for PostgreSQL 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 postgres flexible-server firewall-rule create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name $AZ_DATABASE_SERVER_NAME \
    --rule-name $AZ_DATABASE_SERVER_NAME-database-allow-local-ip \
    --start-ip-address $AZ_LOCAL_IP_ADDRESS \
    --end-ip-address $AZ_LOCAL_IP_ADDRESS \
    --output tsv

Jika Anda menyambungkan ke instans server fleksibel Azure Database for PostgreSQL dari Subsistem Windows untuk Linux (WSL) di komputer Windows, Anda harus 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:

AZ_WSL_IP_ADDRESS=<the-copied-IP-address>

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

az postgres flexible-server firewall-rule create \
    --resource-group $AZ_RESOURCE_GROUP \
    --name $AZ_DATABASE_SERVER_NAME \
    --rule-name $AZ_DATABASE_SERVER_NAME-database-allow-local-ip \
    --start-ip-address $AZ_WSL_IP_ADDRESS \
    --end-ip-address $AZ_WSL_IP_ADDRESS \
    --output tsv

Mengonfigurasi database server fleksibel Azure Database for PostgreSQL

Buat database baru menggunakan perintah berikut:

az postgres flexible-server db create \
    --resource-group $AZ_RESOURCE_GROUP \
    --database-name $AZ_DATABASE_NAME \
    --server-name $AZ_DATABASE_SERVER_NAME \
    --output tsv

Membuat pengguna non-admin server fleksibel Azure Database for PostgreSQL dan memberikan izin

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

Catatan

Anda dapat membaca informasi lebih rinci tentang mengelola pengguna server fleksibel Azure Database for PostgreSQL di Mengelola pengguna Microsoft Entra - 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('$AZ_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=$AZ_DATABASE_SERVER_NAME.postgres.database.azure.com user=$CURRENT_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

Sekarang gunakan perintah berikut untuk menghapus file skrip SQL sementara:

rm create_ad_user.sql

Membuat proyek Java baru

Menggunakan IDE favorit Anda, buat proyek Java baru menggunakan Java 8 atau lebih tinggi, dan tambahkan file pom.xml di direktori akarnya dengan konten berikut:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>

    <properties>
        <java.version>1.8</java.version>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <dependencies>
      <dependency>
        <groupId>org.postgresql</groupId>
        <artifactId>postgresql</artifactId>
        <version>42.3.6</version>
      </dependency>
      <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-identity-extensions</artifactId>
        <version>1.0.0</version>
      </dependency>
    </dependencies>
</project>

File ini adalah Apache Maven yang mengonfigurasi proyek yang akan digunakan:

  • Java 8
  • Driver PostgreSQL terbaru untuk Java

Menyiapkan file konfigurasi untuk menyambungkan ke server fleksibel Azure Database for PostgreSQL

Buat file src/main/resources/application.properties , lalu tambahkan konten berikut:

cat << EOF > src/main/resources/application.properties
url=jdbc:postgresql://${AZ_DATABASE_SERVER_NAME}.postgres.database.azure.com:5432/${AZ_DATABASE_NAME}?sslmode=require&authenticationPluginClassName=com.azure.identity.extensions.jdbc.postgresql.AzurePostgresqlAuthenticationPlugin
user=${AZ_POSTGRESQL_AD_NON_ADMIN_USERNAME}
EOF

Catatan

Properti url konfigurasi telah ?serverTimezone=UTC ditambahkan memberi tahu driver JDBC untuk menggunakan TLS (Keamanan Lapisan Transportasi) saat menyambungkan ke database. Anda harus menggunakan TLS dengan server fleksibel Azure Database for PostgreSQL, dan ini adalah praktik keamanan yang baik.

Membuat file SQL untuk menghasilkan skema database

Anda akan menggunakan file src/main/resources/schema.sql untuk membuat skema database. Buat file tersebut dengan konten berikut:

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

Kodekan aplikasi

Sambungkan ke database

Selanjutnya, tambahkan kode Java yang akan menggunakan JDBC untuk menyimpan dan mengambil data dari instans server fleksibel Azure Database for PostgreSQL Anda.

Buat file src/main/java/DemoApplication.java dan tambahkan konten berikut:

package com.example.demo;

import java.sql.*;
import java.util.*;
import java.util.logging.Logger;

public class DemoApplication {

    private static final Logger log;

    static {
        System.setProperty("java.util.logging.SimpleFormatter.format", "[%4$-7s] %5$s %n");
        log =Logger.getLogger(DemoApplication.class.getName());
    }

    public static void main(String[] args) throws Exception {
        log.info("Loading application properties");
        Properties properties = new Properties();
        properties.load(DemoApplication.class.getClassLoader().getResourceAsStream("application.properties"));

        log.info("Connecting to the database");
        Connection connection = DriverManager.getConnection(properties.getProperty("url"), properties);
        log.info("Database connection test: " + connection.getCatalog());

        log.info("Create database schema");
        Scanner scanner = new Scanner(DemoApplication.class.getClassLoader().getResourceAsStream("schema.sql"));
        Statement statement = connection.createStatement();
        while (scanner.hasNextLine()) {
            statement.execute(scanner.nextLine());
        }

		/*
		Todo todo = new Todo(1L, "configuration", "congratulations, you have set up JDBC correctly!", true);
        insertData(todo, connection);
        todo = readData(connection);
        todo.setDetails("congratulations, you have updated data!");
        updateData(todo, connection);
        deleteData(todo, connection);
		*/

        log.info("Closing database connection");
        connection.close();
    }
}

Memiliki masalah? Beri tahu kami.

Kode Java ini akan menggunakan file application.properties dan schema.sql yang kami buat sebelumnya, untuk menyambungkan ke instans server fleksibel Azure Database for PostgreSQL dan membuat skema yang akan menyimpan data kami.

Dalam file ini, Anda dapat melihat bahwa kami berkomentar tentang metode untuk menyisipkan, membaca, memperbarui dan menghapus data: kami akan mengkode metode tersebut di sisa artikel ini, dan Anda akan dapat menghapus komentar satu demi satu.

Catatan

Informasi masuk database disimpan dalam properti pengguna dan kata sandi dari file application.properties. Informasi masuk tersebut digunakan saat mengeksekusi DriverManager.getConnection(properties.getProperty("url"), properties);, karena file properti diberikan sebagai argumen.

Anda sekarang dapat menjalankan kelas utama ini dengan alat favorit Anda:

  • Menggunakan IDE Anda, Anda akan dapat mengklik kanan pada kelas DemoApplication dan menjalankannya.
  • Menggunakan Maven, Anda dapat menjalankan aplikasi dengan mengeksekusi: mvn exec:java -Dexec.mainClass="com.example.demo.DemoApplication".

Aplikasi harus terhubung ke instans server fleksibel Azure Database for PostgreSQL, membuat skema database, lalu menutup koneksi, seperti yang akan Anda lihat di log konsol:

[INFO   ] Loading application properties
[INFO   ] Connecting to the database
[INFO   ] Database connection test: demo
[INFO   ] Create database schema
[INFO   ] Closing database connection

Membuat kelas domain

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

package com.example.demo;

public class Todo {

    private Long id;
    private String description;
    private String details;
    private boolean done;

    public Todo() {
    }

    public Todo(Long id, String description, String details, boolean done) {
        this.id = id;
        this.description = description;
        this.details = details;
        this.done = 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;
    }

    @Override
    public String toString() {
        return "Todo{" +
                "id=" + id +
                ", description='" + description + '\'' +
                ", details='" + details + '\'' +
                ", done=" + done +
                '}';
    }
}

Kelas ini adalah model domain yang dipetakan pada tabel todo yang Anda buat saat menjalankan skrip schema.sql.

Menyisipkan data ke server fleksibel Azure Database for PostgreSQL

Dalam file src/main/java/DemoApplication.java, setelah metode utama, tambahkan metode berikut untuk menyisipkan data ke dalam database:

private static void insertData(Todo todo, Connection connection) throws SQLException {
    log.info("Insert data");
    PreparedStatement insertStatement = connection
            .prepareStatement("INSERT INTO todo (id, description, details, done) VALUES (?, ?, ?, ?);");

    insertStatement.setLong(1, todo.getId());
    insertStatement.setString(2, todo.getDescription());
    insertStatement.setString(3, todo.getDetails());
    insertStatement.setBoolean(4, todo.isDone());
    insertStatement.executeUpdate();
}

Anda sekarang dapat membatalkan penguraian dua baris berikut di dalam metode main:

Todo todo = new Todo(1L, "configuration", "congratulations, you have set up JDBC correctly!", true);
insertData(todo, connection);

Menjalankan kelas utama sekarang harus menghasilkan keluaran berikut:

[INFO   ] Loading application properties
[INFO   ] Connecting to the database
[INFO   ] Database connection test: demo
[INFO   ] Create database schema
[INFO   ] Insert data
[INFO   ] Closing database connection

Membaca data dari server fleksibel Azure Database for PostgreSQL

Mari kita baca data yang sebelumnya disisipkan, untuk memvalidasi bahwa kode kami berfungsi dengan benar.

Dalam file src/main/java/DemoApplication.java, setelah metode insertData, tambahkan metode berikut untuk membaca data dari database:

private static Todo readData(Connection connection) throws SQLException {
    log.info("Read data");
    PreparedStatement readStatement = connection.prepareStatement("SELECT * FROM todo;");
    ResultSet resultSet = readStatement.executeQuery();
    if (!resultSet.next()) {
        log.info("There is no data in the database!");
        return null;
    }
    Todo todo = new Todo();
    todo.setId(resultSet.getLong("id"));
    todo.setDescription(resultSet.getString("description"));
    todo.setDetails(resultSet.getString("details"));
    todo.setDone(resultSet.getBoolean("done"));
    log.info("Data read from the database: " + todo.toString());
    return todo;
}

Anda sekarang dapat menghapus komentar pada dua baris berikut di dalam metode main:

todo = readData(connection);

Menjalankan kelas utama sekarang harus menghasilkan keluaran berikut:

[INFO   ] Loading application properties
[INFO   ] Connecting to the database
[INFO   ] Database connection test: demo
[INFO   ] Create database schema
[INFO   ] Insert data
[INFO   ] Read data
[INFO   ] Data read from the database: Todo{id=1, description='configuration', details='congratulations, you have set up JDBC correctly!', done=true}
[INFO   ] Closing database connection

Memperbarui data di server fleksibel Azure Database for PostgreSQL

Mari kita perbarui data yang sebelumnya kita sisipkan.

Masih dalam file src/main/java/DemoApplication.java, setelah metode readData, tambahkan metode berikut untuk memperbarui data di dalam database:

private static void updateData(Todo todo, Connection connection) throws SQLException {
    log.info("Update data");
    PreparedStatement updateStatement = connection
            .prepareStatement("UPDATE todo SET description = ?, details = ?, done = ? WHERE id = ?;");

    updateStatement.setString(1, todo.getDescription());
    updateStatement.setString(2, todo.getDetails());
    updateStatement.setBoolean(3, todo.isDone());
    updateStatement.setLong(4, todo.getId());
    updateStatement.executeUpdate();
    readData(connection);
}

Anda sekarang dapat membatalkan penguraian dua baris berikut di dalam metode main:

todo.setDetails("congratulations, you have updated data!");
updateData(todo, connection);

Menjalankan kelas utama sekarang harus menghasilkan keluaran berikut:

[INFO   ] Loading application properties
[INFO   ] Connecting to the database
[INFO   ] Database connection test: demo
[INFO   ] Create database schema
[INFO   ] Insert data
[INFO   ] Read data
[INFO   ] Data read from the database: Todo{id=1, description='configuration', details='congratulations, you have set up JDBC correctly!', done=true}
[INFO   ] Update data
[INFO   ] Read data
[INFO   ] Data read from the database: Todo{id=1, description='configuration', details='congratulations, you have updated data!', done=true}
[INFO   ] Closing database connection

Menghapus data di server fleksibel Azure Database for PostgreSQL

Terakhir, mari kita hapus data yang sebelumnya kita sisipkan.

Masih dalam file src/main/java/DemoApplication.java, setelah metode updateData, tambahkan metode berikut untuk memperbarui data di dalam database:

private static void deleteData(Todo todo, Connection connection) throws SQLException {
    log.info("Delete data");
    PreparedStatement deleteStatement = connection.prepareStatement("DELETE FROM todo WHERE id = ?;");
    deleteStatement.setLong(1, todo.getId());
    deleteStatement.executeUpdate();
    readData(connection);
}

Anda sekarang dapat menghapus komentar pada dua baris berikut di dalam metode main:

deleteData(todo, connection);

Menjalankan kelas utama sekarang harus menghasilkan keluaran berikut:

[INFO   ] Loading application properties
[INFO   ] Connecting to the database
[INFO   ] Database connection test: demo
[INFO   ] Create database schema
[INFO   ] Insert data
[INFO   ] Read data
[INFO   ] Data read from the database: Todo{id=1, description='configuration', details='congratulations, you have set up JDBC correctly!', done=true}
[INFO   ] Update data
[INFO   ] Read data
[INFO   ] Data read from the database: Todo{id=1, description='configuration', details='congratulations, you have updated data!', done=true}
[INFO   ] Delete data
[INFO   ] Read data
[INFO   ] There is no data in the database!
[INFO   ] Closing database connection

Membersihkan sumber daya

Selamat! Anda telah membuat aplikasi Java yang menggunakan JDBC untuk menyimpan dan mengambil data dari server fleksibel Azure Database for PostgreSQL.

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

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

Langkah berikutnya

Memigrasikan database Anda menggunakan Ekspor dan Impor