關于 Laravel Sail

Laravel Sail 是 Laravel 框架的官方開發(fā)環(huán)境。 Sail 提供了一個輕量級的命令行界面 (CLI)，可以使用 Docker 輕松設置和管理 Laravel 應用程序開發(fā)環(huán)境。下面，我們講解一下 Laravel Sail 的主要特性和使用方法。

使用 Laravel Sail 的好處

1. 構建獨立于操作系統的開發(fā)環(huán)境
   • Sail 使用 Docker 來容器化 Laravel 應用程序的開發(fā)環(huán)境。這使您可以構建獨立于操作系統的開發(fā)環(huán)境。
2. 輕松設置開發(fā)環(huán)境
   • 使用 Sail，只需幾條命令即可搭建 Laravel 開發(fā)環(huán)境。即使使用 MySQL、Redis、MailHog 等復雜的開發(fā)環(huán)境，也可以輕松構建。
3. 輕松管理不同版本的項目
   • 例如，Laravel 的版本取決于 PHP 的版本，但通過在 docker-compose.yml 文件中設置每個項目的環(huán)境，可以輕松切換版本。

當您使用 Docker 和 Laravel Sail 創(chuàng)建項目時，結構將如上圖所示。

用法

開發(fā)環(huán)境

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

先決條件

在創(chuàng)建 Laravel 項目之前，請下載并啟動 Docker Desktop。
https://www.docker.com/products/docker-desktop/

1. 創(chuàng)建 Laravel 項目

運行以下命令創(chuàng)建一個新的 Laravel 項目并設置 Laravel Sail。

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

這將創(chuàng)建 Laravel 項目文件。生成的 docker-compose.yml 文件中描述了開發(fā)環(huán)境。

使用 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執(zhí)行各種開發(fā)任務。以下是一些示例。

• 啟動應用程序：

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. 改變服務

即使在創(chuàng)建項目后，您也可以通過修改 docker-compose.yml 文件（即 Docker 配置文件）來更改服務。在這里，我們將更改 PHP 版本和使用的數據庫。

更改 PHP 版本

首先檢查當前PHP版本

sail down

接下來修改docker-compose.yml文件中描述的開發(fā)環(huán)境信息。

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 創(chuàng)建的項目更改為 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

這樣，即使創(chuàng)建了項目，也可以從 MySQL 更改為 PostgreSQL。

結論

通過本文，您將了解如何使用 Laravel Sail 高效地設置和管理開發(fā)環(huán)境。通過根據項目的需求選擇合適的服務并自定義設置，您可以實現更靈活、更強大的開發(fā)環(huán)境。

以上是【Laravel vx Docker】利用 Laravel Sail 高效搭建 Laravel 應用開發(fā)環(huán)境的詳細內容。更多信息請關注PHP中文網其他相關文章！