【Laravel vx Docker】利用 Laravel Sail 高效搭建 Laravel 应用开发环境

关于 Laravel Sail

Laravel Sail 是 Laravel 框架的官方开发环境。 Sail 提供了一个轻量级的命令行界面 (CLI)，可以使用 Docker 轻松设置和管理 Laravel 应用程序开发环境。下面，我们讲解一下 Laravel Sail 的主要特性和使用方法。

使用 Laravel Sail 的好处

1. 构建独立于操作系统的开发环境
   • Sail 使用 Docker 来容器化 Laravel 应用程序的开发环境。这使您可以构建独立于操作系统的开发环境。
2. 轻松设置开发环境
   • 使用 Sail，只需几条命令即可搭建 Laravel 开发环境。即使使用 MySQL、Redis、MailHog 等复杂的开发环境，也可以轻松构建。
3. 轻松管理不同版本的项目
   • 例如，Laravel 的版本取决于 PHP 的版本，但通过在 docker-compose.yml 文件中设置每个项目的环境，可以轻松切换版本。

当您使用 Docker 和 Laravel Sail 创建项目时，结构将如上图所示。

用法

开发环境

• Mac
• PHP v8.3
• Laravel v11
• Docker

先决条件

在创建 Laravel 项目之前，请下载并启动 Docker Desktop。
https://www.docker.com/products/docker-desktop/

1. 创建 Laravel 项目

运行以下命令创建一个新的 Laravel 项目并设置 Laravel Sail。

curl -s "https://laravel.build/example-app" | bash
cd example-app

这将创建 Laravel 项目文件。生成的 docker-compose.yml 文件中描述了开发环境。

使用 with 查询指定服务

如果要指定PHP版本或者使用PostgreSQL而不是MySQL，可以在生成项目时在命令中用=,,...指定

curl -s "https://laravel.build/example-app?php=81&with=pgsql,redis" | bash

2. 起航

移动到项目目录并启动 Sail。

./vendor/bin/sail up -d

此命令启动 Docker 容器并运行 Laravel 应用程序。

※注册别名

输入 ./vendor/bin/sail 很麻烦，因此请将其保存为 shell 配置文件中的别名 sail。

使用以下命令检查您正在使用的 shell 的路径

echo $SHELL

示例：/bin/zsh

编辑 Shell 配置文件

• 对于 zsh

Shell 配置文件是 ~/.zshrc。
要添加别名，请运行以下命令

curl -s "https://laravel.build/example-app" | bash
cd example-app

• 对于 bash

shell 配置文件是 ~/.bash_profile 或 ~/.bashrc。
要添加别名，请运行以下命令：

curl -s "https://laravel.build/example-app?php=81&with=pgsql,redis" | bash

通过上述设置，您可以以缩写形式运行 sail 命令。

./vendor/bin/sail up -d

3. 使用 Sail 命令

您可以使用Sail执行各种开发任务。以下是一些示例。

• 启动应用程序：

echo $SHELL

• 停止应用程序：

echo "alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'" >> ~/.zshrc
source ~/.zshrc

• 运行 Artisan 命令：

echo "alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'" >> ~/.bash_profile
source ~/.bash_profile

• 运行 Composer 命令：

sail up -d

• 运行 npm 命令：

sail up -d

4. 改变服务

即使在创建项目后，您也可以通过修改 docker-compose.yml 文件（即 Docker 配置文件）来更改服务。在这里，我们将更改 PHP 版本和使用的数据库。

更改 PHP 版本

首先检查当前PHP版本

sail down

接下来修改docker-compose.yml文件中描述的开发环境信息。

sail artisan migrate

将构建上下文和镜像更改为 8.1 .

sail composer install

修改 docker-compose.yml 后，停止应用。

sail npm install

接下来，重建 Docker 容器以反映更改。

sail php -v
PHP 8.3.12 (cli) (built: Sep 27 2024 03:53:05) (NTS)

重新启动应用程序。

services:
    laravel.test:
        build:
            context: "./vendor/laravel/sail/runtimes/8.3"
            dockerfile: Dockerfile
            args:
                WWWGROUP: "${WWWGROUP}"
        image: "sail-8.3/app"

检查PHP版本是否有变化。

services:
    laravel.test:
        build:
            context: "./vendor/laravel/sail/runtimes/8.1"
            dockerfile: Dockerfile
            args:
                WWWGROUP: "${WWWGROUP}"
        image: "sail-8.1/app"

PHP 版本已从 PHP 8.3 更改为 PHP 8.1。

更改使用的数据库

将使用 MySQL 创建的项目更改为 PostgreSQL。

运行 Sail 安装命令

sail down

选择 pgsql

sail build --no-cache

检查 docker-compose.yml 文件并确认 pgsql 条目已添加。

sail up -d

ext，打开项目目录下的.env文件，确认设置了DB_CONNECTION=pgsql和DB_HOST=pgsql。
如果没有，请手动更改它们。

sail php -v
PHP 8.1.30 (cli) (built: Sep 27 2024 04:07:29) (NTS)

确认 docker-compose.yml 和 .env 中的更改后，停止应用程序。

sail php artisan sail:install

接下来，重建 Docker 容器以反映更改。

 ┌ Which services would you like to install? ───────────────────┐
 │   ◼ mysql                                                  ┃ │
 │ › ◻ pgsql                                                  │ │
 │   ◻ mariadb                                                │ │
 │   ◻ redis                                                  │ │
 │   ◻ memcached                                              │ │
 └────────────────────────────────────────────────── 1 selected ┘
  Use the space bar to select options.

重新启动应用程序。

services:
    laravel.test:
...
        depends_on:
            - mysql
            - redis
            - meilisearch
            - mailpit
            - selenium
            - pgsql
...
        pgsql:
            image: 'postgres:17'
            ports:
                - '${FORWARD_DB_PORT:-5432}:5432'
            environment:
                PGPASSWORD: '${DB_PASSWORD:-secret}'
                POSTGRES_DB: '${DB_DATABASE}'
                POSTGRES_USER: '${DB_USERNAME}'
                POSTGRES_PASSWORD: '${DB_PASSWORD:-secret}'
            volumes:
                - 'sail-pgsql:/var/lib/postgresql/data'
                - './vendor/laravel/sail/database/pgsql/create-testing-database.sql:/docker-entrypoint-initdb.d/10-create-testing-database.sql'
            networks:
                - sail
            healthcheck:
                test:
                    - CMD
                    - pg_isready
                    - '-q'
                    - '-d'
                    - '${DB_DATABASE}'
                    - '-U'
                    - '${DB_USERNAME}'
                retries: 3
                timeout: 5s

运行迁移文件。

DB_CONNECTION=pgsql
DB_HOST=pgsql
DB_PORT=5432
DB_DATABASE=laravel
DB_USERNAME=sail
DB_PASSWORD=******

在 Docker 中启动 shell 并检查 pgsql

显示当前正在运行的 Docker 容器的列表。

curl -s "https://laravel.build/example-app" | bash
cd example-app

curl -s "https://laravel.build/example-app?php=81&with=pgsql,redis" | bash

检查应用程序的容器名称并在 Docker 内启动应用程序的 bash。

./vendor/bin/sail up -d

连接到 pgsql。

echo $SHELL

系统将提示您输入密码，因此请输入 .env 文件中指定的 DB_PASSWORD。

echo "alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'" >> ~/.zshrc
source ~/.zshrc

检查pgsql中的表

echo "alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'" >> ~/.bash_profile
source ~/.bash_profile

这样，即使创建了项目，也可以从 MySQL 更改为 PostgreSQL。

结论

通过本文，您将了解如何使用 Laravel Sail 高效地设置和管理开发环境。通过根据项目的需求选择合适的服务并自定义设置，您可以实现更灵活、更强大的开发环境。

以上是【Laravel vx Docker】利用 Laravel Sail 高效搭建 Laravel 应用开发环境的详细内容。更多信息请关注PHP中文网其他相关文章！