将 Spring Data JDBC 与 Azure Database for PostgreSQL 配合使用

项目
10/04/2024

本教程演示如何使用 Spring Data JDBC 将数据存储在 Azure Database for PostgreSQL 数据库中。

JDBC 是标准的 Java API，用于连接到传统的关系数据库。

在本教程中，我们介绍了两种身份验证方法：Microsoft Entra 身份验证和 PostgreSQL 身份验证。 “无密码”选项卡可显示 Microsoft Entra 身份验证，“密码”选项卡则显示 PostgreSQL 身份验证。

Microsoft Entra 身份验证是一种使用 Microsoft Entra ID 中定义的标识连接到 Azure Database for PostgreSQL 的机制。通过 Microsoft Entra 身份验证，可以在一个中心位置集中管理数据库用户标识和其他 Microsoft 服务，从而简化权限管理。

PostgreSQL 身份验证使用存储在 PostgreSQL 中的帐户。如果你选择使用密码作为帐户的凭据，这些凭据将存储在 user 表中。由于这些密码存储在 PostgreSQL 中，因此你需要自行管理密码的轮换。

先决条件

Azure 订阅 - 免费创建订阅。
Java 开发工具包 (JDK) 版本 8 或更高版本。
Apache Maven。
Azure CLI。

PostgreSQL 命令行客户端。
如果你没有 Spring Boot 应用程序，请使用 Spring Initializr 创建一个 Maven 项目。请务必选择 Maven 项目，并在依赖项下添加 Spring Web、 Spring Data JDBC 和 PostgreSQL 驱动程序依赖项，然后选择 Java 版本 8 或更高版本。

如果没有，请创建一个名为 postgresqlflexibletest 的 Azure Database for PostgreSQL 灵活服务器实例，并创建一个名为 demo 的数据库。有关说明，请参阅快速入门：在 Azure 门户中创建 Azure Database for PostgreSQL 灵活服务器。

请参阅示例应用程序

在本教程中，你将编写一个示例应用程序。如果希望加快进程，可通过 https://github.com/Azure-Samples/quickstart-spring-data-jdbc-postgresql 获得已编码的应用程序。

为 PostgreSQL 服务器配置防火墙规则

Azure Database for PostgreSQL 实例在默认情况下受保护。它们有不允许任何传入连接的防火墙。

为了能够使用你的数据库，请打开服务器的防火墙，以允许本地 IP 地址访问数据库服务器。有关详细信息，请参阅 Azure Database for PostgreSQL 灵活服务器中的防火墙规则。

如果要在 Windows 计算机上从适用于 Linux 的 Windows 子系统连接到 PostgreSQL 服务器，则需要将 WSL 主机 ID 添加到防火墙。

创建 PostgreSQL 非管理员用户并授予权限

接下来创建一个非管理员用户，并为其授予对数据库的所有权限。

无密码（推荐）
密码

可以使用以下方法创建使用无密码连接的非管理员用户。

服务连接器（建议）
手动配置

使用以下命令为 Azure CLI 安装服务连接器无密码扩展：
```
 az extension add --name serviceconnector-passwordless --upgrade
```

使用以下命令创建 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

命令完成后，记下控制台输出中的用户名。

重要

若要使用无密码连接，请为 Azure Database for PostgreSQL 灵活服务器实例配置 Microsoft Entra 管理员用户。有关详细信息，请参阅在 Azure Database for PostgreSQL 灵活服务器中管理 Microsoft Entra 角色。

创建一个名为 create_ad_user.sql 的 SQL 脚本用于创建非管理员用户。添加以下内容，在本地保存该脚本：

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

然后，使用以下命令运行该 SQL 脚本以创建 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

提示

若要使用 Microsoft Entra 身份验证连接到 Azure Database for PostgreSQL，需要使用设置的 Microsoft Entra 管理员用户登录，然后获取访问令牌作为密码。有关详细信息，请参阅使用 Microsoft Entra ID 对 Azure Database for PostgreSQL 灵活服务器进行身份验证。

创建一个名为 create_user.sql 的 SQL 脚本用于创建非管理员用户。添加以下内容，在本地保存该脚本：

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

然后，使用以下命令运行该 SQL 脚本以创建 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

注意

有关详细信息，请参阅在 Azure Database for PostgreSQL 灵活服务器中创建用户。

存储来自 Azure Database for PostgreSQL 的数据

有了 Azure Database for PostgreSQL 灵活服务器实例后，即可使用 Spring Cloud Azure 存储数据。

要安装 Spring Cloud Azure Starter JDBC PostgreSQL 模块，请将以下依赖项添加到 pom.xml 文件：

Spring Cloud Azure 物料清单 (BOM)：
```
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.18.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
注意

如果使用 Spring Boot 2.x，请确保将 spring-cloud-azure-dependencies 版本设置为 4.19.0。此物料清单 (BOM) 应在 pom.xml 文件的 <dependencyManagement> 部分进行配置。这可确保所有 Spring Cloud Azure 依赖项都使用相同的版本。有关用于此 BOM 的版本的详细信息，请参阅应使用哪个版本的 Spring Cloud Azure。

Spring Cloud Azure Starter JDBC PostgreSQL 项目：

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

注意

自版本 4.5.0 以来，支持无密码连接。

将 Spring Boot 配置为使用 Azure Database for PostgreSQL

若要使用 Spring Data JDBC 存储来自 Azure Database for PostgreSQL 的数据，请执行以下步骤来配置应用程序：

通过将以下属性添加到 application.properties 配置文件中，配置 Azure Database for PostgreSQL 凭据。

无密码（推荐）
密码

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

警告

配置属性 spring.sql.init.mode=always 意味着 Spring Boot 将在每次服务器启动时使用我们接下来将创建的 schema.sql 文件来自动生成数据库架构。此功能非常适合测试，但请记住，这会在每次重启时删除数据，因此不应在生产中使用。

如果没有，请创建一个名为 postgresqlsingletest 的 Azure Database for PostgreSQL 单一服务器实例，并创建一个名为 demo 的数据库。有关说明，请参阅快速入门：使用 Azure 门户创建 Azure Database for PostgreSQL 服务器。

请参阅示例应用程序

在本文中，你将编写一个示例应用程序。如果希望加快进程，可通过 https://github.com/Azure-Samples/quickstart-spring-data-jdbc-postgresql 获得已编码的应用程序。

为 PostgreSQL 服务器配置防火墙规则

Azure Database for PostgreSQL 实例在默认情况下受保护。它们有不允许任何传入连接的防火墙。

为了能够使用你的数据库，请打开服务器的防火墙，以允许本地 IP 地址访问数据库服务器。有关详细信息，请参阅使用 Azure 门户为 Azure Database for PostgreSQL 单一服务器创建和管理防火墙规则。

如果要在 Windows 计算机上从适用于 Linux 的 Windows 子系统连接到 PostgreSQL 服务器，则需要将 WSL 主机 ID 添加到防火墙。

创建 PostgreSQL 非管理员用户并授予权限

接下来创建一个非管理员用户，并为其授予对数据库的所有权限。

无密码（推荐）
密码

可以使用以下方法创建使用无密码连接的非管理员用户。

服务连接器（建议）
手动配置

使用以下命令为 Azure CLI 安装服务连接器无密码扩展：
```
 az extension add --name serviceconnector-passwordless --upgrade
```

使用以下命令创建 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

命令完成后，记下控制台输出中的用户名。

重要

若要使用无密码连接，请为 Azure Database for PostgreSQL 单一服务器实例配置 Microsoft Entra 管理员用户。有关详细信息，请参阅使用 Microsoft Entra ID 对 PostgreSQL 进行身份验证。

创建一个名为 create_ad_user.sql 的 SQL 脚本用于创建非管理员用户。添加以下内容，在本地保存该脚本：

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

然后，使用以下命令运行该 SQL 脚本以创建 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

提示

若要使用 Microsoft Entra 身份验证连接到 Azure Database for PostgreSQL，需要使用设置的 Microsoft Entra 管理员用户登录，然后获取访问令牌作为密码。有关详细信息，请参阅使用 Microsoft Entra ID 对 PostgreSQL 进行身份验证。

创建一个名为 create_user.sql 的 SQL 脚本用于创建非管理员用户。添加以下内容，在本地保存该脚本：

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

然后，使用以下命令运行该 SQL 脚本以创建 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

注意

可以阅读在 Azure Database for PostgreSQL 中创建用户来获取有关创建 PostgreSQL 用户的更详细信息。

存储来自 Azure Database for PostgreSQL 的数据

有了 Azure Database for PostgreSQL 单一服务器实例后，即可使用 Spring Cloud Azure 存储数据。

要安装 Spring Cloud Azure Starter JDBC PostgreSQL 模块，请将以下依赖项添加到 pom.xml 文件：

Spring Cloud Azure 物料清单 (BOM)：
```
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.18.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
注意

如果使用 Spring Boot 2.x，请确保将 spring-cloud-azure-dependencies 版本设置为 4.19.0。此物料清单 (BOM) 应在 pom.xml 文件的 <dependencyManagement> 部分进行配置。这可确保所有 Spring Cloud Azure 依赖项都使用相同的版本。有关用于此 BOM 的版本的详细信息，请参阅应使用哪个版本的 Spring Cloud Azure。

Spring Cloud Azure Starter JDBC PostgreSQL 项目：

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

注意

自版本 4.5.0 以来，支持无密码连接。

将 Spring Boot 配置为使用 Azure Database for PostgreSQL

若要使用 Spring Data JDBC 存储来自 Azure Database for PostgreSQL 的数据，请执行以下步骤来配置应用程序：

通过将以下属性添加到 application.properties 配置文件中，配置 Azure Database for PostgreSQL 凭据。

无密码（推荐）
密码

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

警告

创建 src/main/resources/schema.sql 配置文件以配置数据库架构，然后添加以下内容。

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

新建一个新 Todo Java 类。此类是映射到 Spring Boot 自动创建的 todo 表上的域模型。下面的代码忽略 getters 和 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;

}

编辑启动类文件以显示以下内容。
```
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> {

}
```
提示

在本教程中，配置或代码中没有身份验证操作。但连接到 Azure 服务需要进行身份验证。要完成身份验证，需要使用 Azure 标识。 Spring Cloud Azure 使用 Azure 标识库提供的 DefaultAzureCredential 来帮助获取凭据，而无需更改任何代码。

DefaultAzureCredential 支持多种身份验证方法，并确定应在运行时使用哪种方法。通过这种方法，你的应用可在不同环境（例如本地与生产环境）中使用不同的身份验证方法，而无需实现特定于环境的代码。有关详细信息，请参阅 DefaultAzureCredential。

若要在本地开发环境中完成身份验证，可以使用 Azure CLI、Visual Studio Code、PowerShell 或其他方法。有关详细信息，请参阅 Java 开发环境中的 Azure 身份验证。若要在 Azure 托管环境中完成身份验证，建议使用用户分配的托管标识。有关详细信息，请参阅什么是 Azure 资源的托管标识？

启动应用程序。应用程序将数据存储到数据库中。将会看到类似于以下示例的日志：

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

部署到 Azure Spring Apps

现在，你已在本地运行 Spring Boot 应用程序，是时候将其转移到生产环境了。借助 Azure Spring Apps，可以轻松地将 Spring Boot 应用程序部署到 Azure，不需更改任何代码。该服务管理 Spring 应用程序的基础结构，让开发人员可以专注于代码。 Azure Spring Apps 可以通过以下方法提供生命周期管理：综合性监视和诊断、配置管理、服务发现、CI/CD 集成、蓝绿部署等。若要将应用程序部署到 Azure Spring Apps，请参阅在 Azure Spring Apps 中部署你的第一个应用程序。

后续步骤

Azure for Spring 开发人员 Spring Cloud Azure PostgreSQL 示例

通过

将 Spring Data JDBC 与 Azure Database for PostgreSQL 配合使用

先决条件

请参阅示例应用程序

为 PostgreSQL 服务器配置防火墙规则

创建 PostgreSQL 非管理员用户并授予权限

存储来自 Azure Database for PostgreSQL 的数据

将 Spring Boot 配置为使用 Azure Database for PostgreSQL

请参阅示例应用程序

为 PostgreSQL 服务器配置防火墙规则

创建 PostgreSQL 非管理员用户并授予权限

存储来自 Azure Database for PostgreSQL 的数据

将 Spring Boot 配置为使用 Azure Database for PostgreSQL

部署到 Azure Spring Apps

后续步骤

反馈

其他资源