关于 laravel sail
laravel sail 是 laravel 框架的官方开发环境。 sail 提供了一个轻量级的命令行界面 (cli),可以使用 docker 轻松设置和管理 laravel 应用程序开发环境。下面,我们讲解一下 laravel sail 的主要特性和使用方法。
使用 laravel sail 的好处
构建独立于操作系统的开发环境sail 使用 docker 来容器化 laravel 应用程序的开发环境。这使您可以构建独立于操作系统的开发环境。轻松设置开发环境使用 sail,只需几条命令即可搭建 laravel 开发环境。即使使用 mysql、redis、mailhog 等复杂的开发环境,也可以轻松构建。轻松管理不同版本的项目例如,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" | bashcd example-app
登录后复制
这将创建 laravel 项目文件。生成的 docker-compose.yml 文件中描述了开发环境。
使用 with 查询指定服务
如果要指定php版本或者使用postgresql而不是mysql,可以在生成项目时的命令中指定with=,,…
- 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。
要添加别名,请运行以下命令
- echo "alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'" >> ~/.zshrcsource ~/.zshrc
登录后复制 对于 bash
shell 配置文件是 ~/.bash_profile 或 ~/.bashrc。
要添加别名,请运行以下命令:
- echo "alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'" >> ~/.bash_profilesource ~/.bash_profile
登录后复制
通过上述设置,您可以以缩写形式运行 sail 命令。
- sail up -d
登录后复制登录后复制登录后复制登录后复制
3. 使用 sail 命令
您可以使用sail执行各种开发任务。以下是一些示例。
启动应用程序:
- sail up -d
登录后复制登录后复制登录后复制登录后复制 停止应用程序:
- sail down
登录后复制登录后复制登录后复制 运行 artisan 命令:
- sail artisan migrate
登录后复制 运行 composer 命令:
- sail composer install
登录后复制 运行 npm 命令:
- sail npm install
登录后复制
4. 改变服务
即使在创建项目后,您也可以通过修改 docker-compose.yml 文件(即 docker 配置文件)来更改服务。在这里,我们将更改 php 版本和使用的数据库。
更改 php 版本
首先检查当前php版本
- sail php -vphp 8.3.12 (cli) (built: sep 27 2024 03:53:05) (nts)
登录后复制
接下来修改docker-compose.yml文件中描述的开发环境信息。
- services: laravel.test: build: context: "./vendor/laravel/sail/runtimes/8.3" dockerfile: dockerfile args: wwwgroup: "${wwwgroup}" image: "sail-8.3/app"
登录后复制
将构建上下文和镜像更改为 8.1 .
- services: laravel.test: build: context: "./vendor/laravel/sail/runtimes/8.1" dockerfile: dockerfile args: wwwgroup: "${wwwgroup}" image: "sail-8.1/app"
登录后复制
修改 docker-compose.yml 后,停止应用。
- sail down
登录后复制登录后复制登录后复制
接下来,重建 docker 容器以反映更改。
- sail build --no-cache
登录后复制登录后复制
重新启动应用程序。
- sail up -d
登录后复制登录后复制登录后复制登录后复制
检查php版本是否有变化。
- sail php -vphp 8.1.30 (cli) (built: sep 27 2024 04:07:29) (nts)
登录后复制
php 版本已从 php 8.3 更改为 php 8.1。
更改使用的数据库
将使用 mysql 创建的项目更改为 postgresql。
运行 sail 安装命令
- sail php artisan sail:install
登录后复制
选择 pgsql
- ┌ which services would you like to install? ───────────────────┐ │ ◼ mysql ┃ │ │ › ◻ pgsql │ │ │ ◻ mariadb │ │ │ ◻ redis │ │ │ ◻ memcached │ │ └────────────────────────────────────────────────── 1 selected ┘ use the space bar to select options.
登录后复制
检查 docker-compose.yml 文件并确认 pgsql 条目已添加。
- 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
登录后复制
ext,打开项目目录下的.env文件,确认设置了db_connection=pgsql和db_host=pgsql。
如果没有,请手动更改它们。
- db_connection=pgsqldb_host=pgsqldb_port=5432db_database=laraveldb_username=saildb_password=******
登录后复制
确认 docker-compose.yml 和 .env 中的更改后,停止应用程序。
- sail down
登录后复制登录后复制登录后复制
接下来,重建 docker 容器以反映更改。
- sail build --no-cache
登录后复制登录后复制
重新启动应用程序。
- sail up -d
登录后复制登录后复制登录后复制登录后复制
运行迁移文件。
- sail artisan migrateinfo preparing database.creating migration table ................................ 6.00ms doneinfo running migrations.0001_01_01_000000_create_users_table .................... 5.74ms done0001_01_01_000001_create_cache_table .................... 1.45ms done0001_01_01_000002_create_jobs_table ..................... 3.44ms done
登录后复制
在 docker 中启动 shell 并检查 pgsql
显示当前正在运行的 docker 容器的列表。
- sail ps
登录后复制
- name image command servicelaravel-sail-setup-laravel.test-1 sail-8.3/app "start-container" laravel.testlaravel-sail-setup-mailpit-1 axllent/mailpit:latest "/mailpit" mailpit
登录后复制
检查应用程序的容器名称并在 docker 内启动应用程序的 bash。
- docker exec -it laravel-sail-setup-laravel.test-1 bash
登录后复制
连接到 pgsql。
- psql -u sail -h pgsql laravel
登录后复制
系统将提示您输入密码,因此请输入 .env 文件中指定的 db_password。
- password for user sail:******
登录后复制
检查pgsql中的表
- laravel=# dt List of relations Schema | Name | Type | Owner--------+-----------------------+-------+------- public | cache | table | sail public | cache_locks | table | sail public | failed_jobs | table | sail public | job_batches | table | sail public | jobs | table | sail public | migrations | table | sail public | password_reset_tokens | table | sail public | sessions | table | sail public | users | table | sail(9 rows)
登录后复制
这样,即使创建了项目,也可以从 mysql 更改为 postgresql。
结论
通过本文,您将了解如何使用 laravel sail 高效地设置和管理开发环境。通过根据项目的需求选择合适的服务并自定义设置,您可以实现更灵活、更强大的开发环境。
以上就是【Laravel vx Docker】利用 Laravel Sail 高效搭建 Laravel 应用开发环境的详细内容,更多请关注【创想鸟】其它相关文章!