Laravel Sail について

Laravel Sail は、Laravel フレームワークの公式開発環(huán)境です。 Sail は、Docker を使用して Laravel アプリケーション開発環(huán)境を簡(jiǎn)単にセットアップおよび管理するための軽量のコマンドライン インターフェイス (CLI) を提供します。以下では、Laravel Sail の主な機(jī)能と使い方を説明します。

Laravel Sail を使用する利點(diǎn)

1. OSに依存しない開発環(huán)境を構(gòu)築
   • Sail は Docker を使用して、Laravel アプリケーションの開発環(huán)境をコンテナ化します。これにより、OSに依存しない開発環(huán)境を構(gòu)築できます。
2. 開発環(huán)境のセットアップが簡(jiǎn)単
   • Sail を使用すると、いくつかのコマンドだけで Laravel 開発環(huán)境をセットアップできます。 MySQL、Redis、MailHogなどを使用した複雑な開発環(huán)境も簡(jiǎn)単に構(gòu)築できます。
3. 異なるバージョンのプロジェクトを簡(jiǎn)単に管理
   • 例えば、Laravel のバージョンは PHP のバージョンに依存しますが、docker-compose.yml ファイルでプロジェクトごとに環(huán)境を設(shè)定することで、簡(jiǎn)単にバージョンを切り替えることができます。

Laravel Sail で Docker を使用してプロジェクトを作成すると、上の図のような構(gòu)造になります。

使用法

開発環(huán)境

• マック
• PHP v8.3
• Laravel v11
• ドッカー

前提條件

Laravel プロジェクトを作成する前に、Docker Desktop をダウンロードして起動(dòng)します。
https://www.docker.com/products/docker-desktop/

1.Laravelプロジェクトの作成

次のコマンドを?qū)g行して、新しい Laravel プロジェクトを作成し、Laravel Sail をセットアップします。

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

これにより、Laravel プロジェクト ファイルが作成されます。開発環(huán)境は、生成された docker-compose.yml ファイルに記述されています。

with クエリでサービスを指定する

PHP のバージョンを指定する場(chǎng)合、または MySQL の代わりに PostgreSQL を使用する場(chǎng)合は、プロジェクト生成時(shí)にコマンドで with=,,... を指定できます。

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

2. 出航

プロジェクト ディレクトリに移動(dòng)し、Sail を開始します。

./vendor/bin/sail up -d

このコマンドは Docker コンテナを起動(dòng)し、Laravel アプリケーションを?qū)g行します。

※別名を登録する

./vendor/bin/sail と入力するのは面倒なので、シェルの設(shè)定ファイルにエイリアス Sail として保存してください。

次のコマンドで使用しているシェルのパスを確認(rèn)してください

echo $SHELL

例: /bin/zsh

シェル構(gòu)成ファイルの編集

• zsh の場(chǎng)合

シェル構(gòu)成ファイルは ~/.zshrc です。
エイリアスを追加するには、次のコマンドを?qū)g行します

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

• bash の場(chǎng)合

シェル設(shè)定ファイルは ~/.bash_profile または ~/.bashrc です。
エイリアスを追加するには、次のコマンドを?qū)g行します:

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

上記の設(shè)定により、sail コマンドを短縮形式で実行できます。

./vendor/bin/sail up -d

3. セイルコマンドの使用

Sail を使用してさまざまな開発タスクを?qū)g行できます。以下にいくつかの例を示します。

• アプリケーションの起動(dòng):

echo $SHELL

• アプリケーションを停止します:

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

• アーティザン コマンドの実行:

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 構(gòu)成ファイルである docker-compose.yml ファイルを変更することでサービスを変更できます。ここでは、PHPのバージョンと使用するデータベースを変更します。

PHPのバージョンを変更する

まず、現(xiàn)在の PHP バージョンを確認(rèn)します

sail down

次に、docker-compose.yml ファイルに記述されている開発環(huán)境の情報(bào)を変更します。

sail artisan migrate

ビルド コンテキストとイメージを 8.1 に変更します。

sail composer install

docker-compose.yml を変更した後、アプリケーションを停止します。

sail npm install

次に、Docker コンテナを再構(gòu)築して変更を反映します。

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

アプリケーションを再起動(dòng)します。

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

PHP のバージョンが変更されているかどうかを確認(rèn)します。

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 インストール コマンドを?qū)g行します

sail down

pgsql を選択

sail build --no-cache

docker-compose.yml ファイルをチェックし、pgsql エントリが追加されていることを確認(rèn)します。

sail up -d

次に、プロジェクト ディレクトリ內(nèi)の .env ファイルを開き、DB_CONNECTION=pgsql および DB_HOST=pgsql が設(shè)定されていることを確認(rèn)します。
そうでない場(chǎng)合は、手動(dòng)で変更してください。

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

docker-compose.yml と .env の変更を確認(rèn)したら、アプリケーションを停止します。

sail php artisan sail:install

次に、Docker コンテナを再構(gòu)築して変更を反映します。

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

アプリケーションを再起動(dòng)します。

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

移行ファイルを?qū)g行します。

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

Docker でシェルを起動(dòng)し、pgsql を確認(rèn)します

現(xiàn)在実行中の 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

アプリケーションのコンテナ名を確認(rèn)し、Docker 內(nèi)でアプリケーションの 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 でテーブルを確認(rèn)します

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

このようにして、プロジェクト作成後でも MySQL から PostgreSQL に変更することができます。

結(jié)論

この記事を通じて、Laravel Sail を使用して開発環(huán)境を効率的にセットアップおよび管理する方法を理解します。プロジェクトの要件に応じて適切なサービスを選択し、設(shè)定をカスタマイズすることで、より柔軟で強(qiáng)力な開発環(huán)境を?qū)g現(xiàn)できます。

以上が[Laravel vx Docker] Laravel Sail を使用して Laravel アプリ開発環(huán)境を効率的にセットアップするの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國語 Web サイトの他の関連記事を參照してください。