使用容器进行 PHP 开发

先决条件

完成容器化 PHP 应用程序.

概述

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

添加本地数据库并持久化数据
添加 phpMyAdmin 以与数据库交互
配置 Compose 以在您编辑和保存代码时自动更新正在运行的 Compose 服务
创建一个包含开发依赖项的开发容器

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

您可以使用容器来设置本地服务，例如数据库。要为示例应用程序执行此操作，您需要执行以下操作

更新 Dockerfile 以安装连接到数据库的扩展
更新 compose.yaml 文件以添加数据库服务和卷以持久化数据

更新 Dockerfile 以安装扩展

要安装 PHP 扩展，您需要更新 Dockerfile。在 IDE 或文本编辑器中打开您的 Dockerfile，然后更新其内容。以下 Dockerfile 包含一行新内容，用于安装 pdo 和 pdo_mysql 扩展。所有注释都已删除。

# syntax=docker/dockerfile:1

FROM composer:lts as deps
WORKDIR /app
RUN --mount=type=bind,source=composer.json,target=composer.json \
    --mount=type=bind,source=composer.lock,target=composer.lock \
    --mount=type=cache,target=/tmp/cache \
    composer install --no-dev --no-interaction

FROM php:8.2-apache as final
RUN docker-php-ext-install pdo pdo_mysql
RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
COPY --from=deps app/vendor/ /var/www/html/vendor
COPY ./src /var/www/html
USER www-data

有关安装 PHP 扩展的更多详细信息，请参见 PHP 官方 Docker 镜像.

更新 compose.yaml 文件以添加数据库和持久化数据

在 IDE 或文本编辑器中打开 compose.yaml 文件。您会注意到它已经包含了 PostgreSQL 数据库和卷的注释掉的说明。对于此应用程序，您将使用 MariaDB。有关 MariaDB 的更多详细信息，请参见 MariaDB 官方 Docker 镜像.

在 IDE 或文本编辑器中打开 src/database.php 文件。您会注意到它读取环境变量以连接到数据库。

在 compose.yaml 文件中，您需要更新以下内容

取消注释并更新 MariaDB 的数据库说明。
向服务器服务添加一个秘密以传入数据库密码。
向服务器服务添加数据库连接环境变量。
取消注释卷说明以持久化数据。

以下是更新后的 compose.yaml 文件。所有注释都已删除。

services:
  server:
    build:
      context: .
    ports:
      - 9000:80
    depends_on:
      db:
        condition: service_healthy
    secrets:
      - db-password
    environment:
      - PASSWORD_FILE_PATH=/run/secrets/db-password
      - DB_HOST=db
      - DB_NAME=example
      - DB_USER=root
  db:
    image: mariadb
    restart: always
    user: root
    secrets:
      - db-password
    volumes:
      - db-data:/var/lib/mysql
    environment:
      - MARIADB_ROOT_PASSWORD_FILE=/run/secrets/db-password
      - MARIADB_DATABASE=example
    expose:
      - 3306
    healthcheck:
      test:  ["CMD", "/usr/local/bin/healthcheck.sh", "--su-mysql", "--connect",  "--innodb_initialized"]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  db-data:
secrets:
  db-password:
    file: db/password.txt

注意
要详细了解 Compose 文件中的说明，请参见 Compose 文件参考.

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

在 docker-php-sample 目录中，创建一个名为 db 的新目录，并在该目录中创建一个名为 password.txt 的文件。在 IDE 或文本编辑器中打开 password.txt，然后添加以下密码。密码必须在一行上，文件中没有其他行。

example

保存并关闭 password.txt 文件。

您现在应该在 docker-php-sample 目录中拥有以下内容。

├── docker-php-sample/
│ ├── .git/
│ ├── db/
│ │ └── password.txt
│ ├── src/
│ ├── tests/
│ ├── .dockerignore
│ ├── .gitignore
│ ├── compose.yaml
│ ├── composer.json
│ ├── composer.lock
│ ├── Dockerfile
│ ├── README.Docker.md
│ └── README.md

运行以下命令以启动您的应用程序。

$ docker compose up --build

打开浏览器，并在 https://127.0.0.1:9000/database.php 上查看应用程序。您应该看到一个简单的 Web 应用程序，其中包含文本和一个计数器，每次刷新时都会递增。

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

验证数据是否持久化到数据库中

在终端中，运行 docker compose rm 以删除您的容器，然后运行 docker compose up 以再次运行您的应用程序。

$ docker compose rm
$ docker compose up --build

刷新浏览器中的 https://127.0.0.1:9000/database.php 并验证之前的计数是否仍然存在。如果没有卷，则在您删除容器后，数据库数据将不会持久化。

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

添加 phpMyAdmin 以与数据库交互

您可以通过更新 compose.yaml 文件轻松地向应用程序堆栈添加服务。

更新您的 compose.yaml 以添加 phpMyAdmin 的新服务。有关更多详细信息，请参见 phpMyAdmin 官方 Docker 镜像。以下是更新后的 compose.yaml 文件。

services:
  server:
    build:
      context: .
    ports:
      - 9000:80
    depends_on:
      db:
        condition: service_healthy
    secrets:
      - db-password
    environment:
      - PASSWORD_FILE_PATH=/run/secrets/db-password
      - DB_HOST=db
      - DB_NAME=example
      - DB_USER=root
  db:
    image: mariadb
    restart: always
    user: root
    secrets:
      - db-password
    volumes:
      - db-data:/var/lib/mysql
    environment:
      - MARIADB_ROOT_PASSWORD_FILE=/run/secrets/db-password
      - MARIADB_DATABASE=example
    expose:
      - 3306
    healthcheck:
      test:  ["CMD", "/usr/local/bin/healthcheck.sh", "--su-mysql", "--connect",  "--innodb_initialized"]
      interval: 10s
      timeout: 5s
      retries: 5
  phpmyadmin:
    image: phpmyadmin
    ports:
      - 8080:80
    depends_on:
      - db
    environment:
      - PMA_HOST=db
volumes:
  db-data:
secrets:
  db-password:
    file: db/password.txt

在终端中，运行 docker compose up 以再次运行您的应用程序。

$ docker compose up --build

打开浏览器，并在 https://127.0.0.1:8080 上访问 phpMyAdmin。使用 root 作为用户名和 example 作为密码登录。您现在可以通过 phpMyAdmin 与数据库进行交互。

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

自动更新服务

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

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

services:
  server:
    build:
      context: .
    ports:
      - 9000:80
    depends_on:
      db:
        condition: service_healthy
    secrets:
      - db-password
    environment:
      - PASSWORD_FILE_PATH=/run/secrets/db-password
      - DB_HOST=db
      - DB_NAME=example
      - DB_USER=root
    develop:
      watch:
        - action: sync
          path: ./src
          target: /var/www/html
  db:
    image: mariadb
    restart: always
    user: root
    secrets:
      - db-password
    volumes:
      - db-data:/var/lib/mysql
    environment:
      - MARIADB_ROOT_PASSWORD_FILE=/run/secrets/db-password
      - MARIADB_DATABASE=example
    expose:
      - 3306
    healthcheck:
      test:  ["CMD", "/usr/local/bin/healthcheck.sh", "--su-mysql", "--connect",  "--innodb_initialized"]
      interval: 10s
      timeout: 5s
      retries: 5
  phpmyadmin:
    image: phpmyadmin
    ports:
      - 8080:80
    depends_on:
      - db
    environment:
      - PMA_HOST=db
volumes:
  db-data:
secrets:
  db-password:
    file: db/password.txt

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

$ docker compose watch

打开浏览器，并验证应用程序是否正在 https://127.0.0.1:9000/hello.php 上运行。

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

在 IDE 或文本编辑器中打开 hello.php，并将字符串 Hello, world! 更新为 Hello, Docker!。

将更改保存到 hello.php，然后等待几秒钟让应用程序同步。刷新 https://127.0.0.1:9000/hello.php 在浏览器中并验证更新后的文本是否出现。

在终端中按 ctrl+c 停止 Compose Watch。在终端中运行 docker compose down 以停止应用程序。

创建开发容器

此时，当你运行容器化应用程序时，Composer 不会安装开发依赖项。虽然这个小型镜像适合生产环境，但它缺少你在开发时可能需要的工具和依赖项，并且不包含 tests 目录。你可以使用多阶段构建来在同一个 Dockerfile 中构建开发和生产阶段。有关更多详细信息，请参阅多阶段构建。

在 Dockerfile 中，你需要更新以下内容。

将 deps 阶段拆分为两个阶段。一个阶段用于生产 (prod-deps)，另一个阶段 (dev-deps) 用于安装开发依赖项。
创建一个公共 base 阶段。
为开发创建一个新的 development 阶段。
更新 final 阶段以从新的 prod-deps 阶段复制依赖项。

以下是更改前后 Dockerfile 的内容。

# syntax=docker/dockerfile:1

FROM composer:lts as deps
WORKDIR /app
RUN --mount=type=bind,source=composer.json,target=composer.json \
    --mount=type=bind,source=composer.lock,target=composer.lock \
    --mount=type=cache,target=/tmp/cache \
    composer install --no-dev --no-interaction

FROM php:8.2-apache as final
RUN docker-php-ext-install pdo pdo_mysql
RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
COPY --from=deps app/vendor/ /var/www/html/vendor
COPY ./src /var/www/html
USER www-data

# syntax=docker/dockerfile:1

FROM composer:lts as prod-deps
WORKDIR /app
RUN --mount=type=bind,source=./composer.json,target=composer.json \
    --mount=type=bind,source=./composer.lock,target=composer.lock \
    --mount=type=cache,target=/tmp/cache \
    composer install --no-dev --no-interaction

FROM composer:lts as dev-deps
WORKDIR /app
RUN --mount=type=bind,source=./composer.json,target=composer.json \
    --mount=type=bind,source=./composer.lock,target=composer.lock \
    --mount=type=cache,target=/tmp/cache \
    composer install --no-interaction

FROM php:8.2-apache as base
RUN docker-php-ext-install pdo pdo_mysql
COPY ./src /var/www/html

FROM base as development
COPY ./tests /var/www/html/tests
RUN mv "$PHP_INI_DIR/php.ini-development" "$PHP_INI_DIR/php.ini"
COPY --from=dev-deps app/vendor/ /var/www/html/vendor

FROM base as final
RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
COPY --from=prod-deps app/vendor/ /var/www/html/vendor
USER www-data

通过添加一个指令来定位开发阶段，更新你的 compose.yaml 文件。

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

services:
  server:
    build:
      context: .
      target: development
      # ...

你的容器化应用程序现在将安装开发依赖项。

运行以下命令以启动您的应用程序。

$ docker compose up --build

打开浏览器，在 https://127.0.0.1:9000/hello.php 查看应用程序。你仍然应该看到简单的“Hello, Docker!”应用程序。

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

虽然应用程序看起来相同，但你现在可以使用开发依赖项。继续下一部分了解如何使用 Docker 运行测试。

总结

在本节中，你了解了如何设置 Compose 文件以添加本地数据库并持久化数据。你还了解了如何使用 Compose Watch 在更新代码时自动同步应用程序。最后，你了解了如何创建一个包含开发所需依赖项的开发容器。

下一步

在下一部分中，你将学习如何使用 Docker 运行单元测试。

运行您的测试