集成式 PostgreSQL 数据库 - Embedded Postgres

2024-05-21 08:51:58作者：牧宁李

项目地址：https://gitcode.com/gh_mirrors/emb/embedded-postgres

zonky

集成到你的 Java 应用中的 PostgreSQL 已经不再是难题。嵌入式 Postgres 是一个由 OpenTable 的 otj-pg-embedded 分支演变而来的活跃项目，它使你在无需用户安装数据库集群的情况下，能够轻松地在本地进行单元测试。

如果你是 Spring 或 Spring Boot 框架的用户，我们强烈推荐你尝试我们的另一个专门项目 embedded-database-spring-test，它将为你带来更佳的体验。

项目概述

这个库允许你在 Java 应用代码中内嵌 PostgreSQL，无额外依赖，非常适合用于单元测试。你不必再为设置真实的数据库环境而烦恼，只需简单配置，即可让测试与生产环境保持一致。

技术特性

基于 com.opentable:otj-pg-embedded:0.13.3 特性
可配置的 PostgreSQL 二进制版本
支持 PostgreSQL 11+，包括 Linux 平台
在 Docker 环境下运行的支持，包括 Alpine Linux

使用 Maven 配置

在你的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>io.zonky.test</groupId>
    <artifactId>embedded-postgres</artifactId>
    <version>2.0.6</version>
    <scope>test</scope>
</dependency>

默认使用的 PostgreSQL 版本为 14.10，但你可以通过指定 embedded-postgres-binaries-bom 来改变它。

快速上手

在 JUnit 测试中，如下面所示创建规则：

@Rule
public SingleInstancePostgresRule pg = EmbeddedPostgresRules.singleInstance();

这会启动并管理一个 EmbeddedPostgres 实例。然后你可以通过 pg.getEmbeddedPostgres().getPostgresDatabase() 获取数据源。

默认用户名/密码为：postgres/postgres，默认数据库名为 'postgres'。

集成 Flyway 和 Liquibase

你可以方便地集成 Flyway 或 Liquibase 进行数据库迁移：

Flyway

@Rule 
public PreparedDbRule db =
    EmbeddedPostgresRules.preparedDatabase(
        FlywayPreparer.forClasspathLocation("db/my-db-schema"));

Liquibase

@Rule
public PreparedDbRule db = 
    EmbeddedPostgresRules.preparedDatabase(
            LiquibasePreparer.forClasspathLocation("liqui/master.xml"));

这样，每个测试都将使用独立数据库，并加载指定路径下的模式文件，得益于模板数据库，即使加载时间短，也能保证高隔离度和测试独立性。

自定义 PostgreSQL 版本

默认版本为 14.10，要更改版本，可以在依赖管理部分引入 embedded-postgres-binaries-bom：

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>io.zonky.test.postgres</groupId>
            <artifactId>embedded-postgres-binaries-bom</artifactId>
            <version>16.1.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

Gradle 用户可以参考文档来导入 Maven BOM。

支持的架构和平台

默认支持 amd64 架构，通过增加 Maven 依赖可以支持其他架构，例如 Linux i386：

<dependency>
    <groupId>io.zonky.test.postgres</groupId>
    <artifactId>embedded-postgres-binaries-linux-i386</artifactId>
    <scope>test</scope>
</dependency>

支持的平台包括 Darwin（MacOS），Windows，Linux 和 Alpine Linux。支持的架构包括 amd64，i386，arm32v6，arm32v7，arm64v8，ppc64le。

解决问题

遇到问题时，请查看错误信息，例如 Process [/tmp/embedded-pg/PG-XYZ/bin/initdb, ...] failed 提示，确保非根用户执行。如果是在 Docker 容器中运行，确保使用非 root 用户，或者在某些情况下，使用 --privileged 标志启动容器。