OpenTable otj-pg-embedded 安装与配置指南

OpenTable otj-pg-embedded 安装与配置指南

otj-pg-embedded Java embedded PostgreSQL component for testing 项目地址: https://gitcode.com/gh_mirrors/ot/otj-pg-embedded

1. 项目基础介绍

OpenTable otj-pg-embedded 是一个Java嵌入式PostgreSQL组件，主要用于测试目的。它允许在Java应用程序代码中使用Docker容器嵌入PostgreSQL，这样可以在不需要最终用户安装和配置数据库集群的情况下进行单元测试。

主要编程语言：Java

2. 关键技术和框架

• Docker: 用于容器化PostgreSQL数据库。
• JUnit: 用于Java的单元测试框架。
• Flyway 或 Liquibase: 用于数据库模式迁移的框架。
• JDBI: 一个用于Java的SQL查询和数据库操作的轻量级库。

3. 安装和配置准备工作

准备工作

• 安装Java 11或更高版本。
• 安装Docker并确保其正在运行。
• 确认操作系统兼容性（本项目主要支持Mac和Ubuntu Linux，Windows和其他平台依赖于社区支持）。

安装步骤

1. 克隆项目仓库

   打开终端或命令提示符，运行以下命令克隆项目：

   git clone https://github.com/opentable/otj-pg-embedded.git
   cd otj-pg-embedded
   

2. 构建项目

   在项目根目录下，使用Maven构建项目：

   mvn clean install
   

3. 配置项目

   在项目中使用Maven或Gradle配置依赖项，确保将项目依赖的otj-pg-embedded版本添加到你的项目中。

4. 在Java项目中使用otj-pg-embedded

   在JUnit测试类中，添加以下代码来管理PostgreSQL实例的生命周期：

   @Rule
   public SingleInstancePostgresRule pg = EmbeddedPostgresRules.singleInstance();
   
   // 使用pg.getEmbeddedPostgres().getPostgresDatabase()获取数据源
   

   或者直接使用EmbeddedPostgres类：

   public void testDatabaseName() throws IOException, SQLException {
       EmbeddedPostgres db = EmbeddedPostgres.builder().start();
       Datasource dataSource = db.getPostgresDatabase();
       // 使用数据源
       db.close();
   }
   

5. 配置数据库迁移

   如果需要使用Flyway或Liquibase进行数据库迁移，可以按照以下示例配置：

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

   或

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

6. 设置PostgreSQL版本

   如果需要使用特定的PostgreSQL版本，可以通过环境变量或构建器设置图像和标签。

   环境变量示例：

   export PG_FULL_IMAGE="docker.otenv.com/postgres:mytag"
   

   或在代码中：

   EmbeddedPostgres.builder()
       .setTag("10")
       .start();
   

   或者使用自定义图像：

   EmbeddedPostgres.builder()
       .setImage(DockerImageName.parse("docker.otenv.com/super-postgres"))
       .start();
   

完成以上步骤后，你的项目应该已经成功集成了otj-pg-embedded，并可以开始进行与PostgreSQL相关的测试了。

otj-pg-embedded Java embedded PostgreSQL component for testing 项目地址: https://gitcode.com/gh_mirrors/ot/otj-pg-embedded