使用容器进行 Ruby on Rails 开发

目录

先决条件

完成 容器化 Ruby on Rails 应用程序.

概述

在本节中，您将学习如何为您的容器化应用程序设置开发环境。这包括

  • 添加本地数据库并持久化数据
  • 配置 Compose 以在您编辑和保存代码时自动更新运行的 Compose 服务

添加本地数据库并持久化数据

您可以使用容器来设置本地服务，例如数据库。在本节中，您将更新 `compose.yaml` 文件以定义数据库服务和卷以持久化数据。

在克隆的仓库目录中，在 IDE 或文本编辑器中打开 `compose.yaml` 文件。您需要将数据库密码文件作为环境变量添加到服务器服务中，并指定要使用的密钥文件。

以下是更新后的 `compose.yaml` 文件。

services:
  web:
    build: .
    command: bundle exec rails s -b '0.0.0.0'
    ports:
      - "3000:3000"
    depends_on:
      - db
    environment:
      - RAILS_ENV=test
    env_file: "webapp.env"
  db:
    image: postgres:latest
    secrets:
      - db-password
    environment:
      - POSTGRES_PASSWORD_FILE=/run/secrets/db-password
    volumes:
      - postgres_data:/var/lib/postgresql/data

volumes:
  postgres_data:
secrets:
  db-password:
    file: db/password.txt

注意

要了解有关 Compose 文件中指令的更多信息，请参见 Compose 文件参考.

在您使用 Compose 运行应用程序之前，请注意此 Compose 文件指定了一个 `password.txt` 文件来保存数据库的密码。您必须创建此文件，因为它不包含在源仓库中。

在克隆的仓库目录中，创建一个名为 `db` 的新目录，并在该目录中创建一个名为 `password.txt` 的文件，其中包含数据库的密码。使用您喜欢的 IDE 或文本编辑器，将以下内容添加到 `password.txt` 文件中。

mysecretpassword

保存并关闭 `password.txt` 文件。此外，在 `webapp.env` 文件中，您可以更改连接到数据库的密码。

您现在应该在 `docker-ruby-on-rails` 目录中具有以下内容。

.
├── Dockerfile
├── Gemfile
├── Gemfile.lock
├── README.md
├── Rakefile
├── app/
├── bin/
├── compose.yaml
├── config/
├── config.ru
├── db/
│   ├── development.sqlite3
│   ├── migrate
│   ├── password.txt
│   ├── schema.rb
│   └── seeds.rb
├── lib/
├── log/
├── public/
├── storage/
├── test/
├── tmp/
└── vendor

现在，运行以下 `docker compose up` 命令以启动您的应用程序。

$ docker compose up --build

在 Ruby on Rails 中，`db:migrate` 是一个 Rake 任务，用于在数据库上运行迁移。迁移是在一致且简便的方式下随时间推移更改数据库模式结构的方法。

$ docker exec -it docker-ruby-on-rails-web-1 rake db:migrate RAILS_ENV=test

您将看到类似以下的提示

console == 20240710193146 CreateWhales: migrating ===================================== -- create_table(:whales) -> 0.0126s == 20240710193146 CreateWhales: migrated (0.0127s) ============================

刷新您浏览器中的 https://127.0.0.1:3000 并添加鲸鱼。

在终端中按 `ctrl+c` 停止您的应用程序并再次运行 `docker compose up`，鲸鱼将被持久化。

自动更新服务

使用 Compose Watch 在您编辑和保存代码时自动更新运行的 Compose 服务。有关 Compose Watch 的更多详细信息，请参见 使用 Compose Watch.

在 IDE 或文本编辑器中打开您的 `compose.yaml` 文件，然后添加 Compose Watch 指令。以下是更新后的 `compose.yaml` 文件。

services:
  web:
    build: .
    command: bundle exec rails s -b '0.0.0.0'
    ports:
      - "3000:3000"
    depends_on:
      - db
    environment:
      - RAILS_ENV=test
    env_file: "webapp.env"

    develop:
      watch:
        - action: rebuild
          path: .
  db:
    image: postgres:latest
    secrets:
      - db-password
    environment:
      - POSTGRES_PASSWORD_FILE=/run/secrets/db-password
    volumes:
      - postgres_data:/var/lib/postgresql/data

volumes:
  postgres_data:
secrets:
  db-password:
    file: db/password.txt

运行以下命令以使用 Compose Watch 运行您的应用程序。

$ docker compose watch

对本地计算机上应用程序源文件的任何更改现在都将立即反映在运行的容器中。

在 IDE 或文本编辑器中打开 `docker-ruby-on-rails/app/views/whales/index.html.erb` 并更新 `Whales` 字符串，添加感叹号。

-    <h1>Whales</h1>
+    <h1>Whales!</h1>

保存对 `index.html.erb` 的更改，然后等待几秒钟以重建应用程序。再次转到应用程序并验证更新后的文本是否显示。

在终端中按 `ctrl+c` 停止您的应用程序。

总结

在本节中，您了解了如何设置 Compose 文件以添加本地数据库并持久化数据。您还了解了如何使用 Compose Watch 在更新代码时自动重建和运行容器。

相关信息

下一步

在下一节中，您将了解如何使用 GitHub Actions 设置 CI/CD 管道。

配置 CI/CD