Laravel 中文文档

主题

部署 ​

简介 ​

当你准备将 Laravel 应用程序部署到生产环境时，有一些重要的事项可以帮助确保应用程序尽可能高效地运行。在本文档中，我们将介绍一些确保 Laravel 应用程序正确部署的良好起点。

服务器要求 ​

Laravel 框架有一些系统要求。你应该确保你的 Web 服务器满足以下最低 PHP 版本和扩展要求：

  • PHP >= 8.2
  • Ctype PHP 扩展
  • cURL PHP 扩展
  • DOM PHP 扩展
  • Fileinfo PHP 扩展
  • Filter PHP 扩展
  • Hash PHP 扩展
  • Mbstring PHP 扩展
  • OpenSSL PHP 扩展
  • PCRE PHP 扩展
  • PDO PHP 扩展
  • Session PHP 扩展
  • Tokenizer PHP 扩展
  • XML PHP 扩展

服务器配置 ​

Nginx ​

如果你将应用程序部署到运行 Nginx 的服务器上，可以使用以下配置文件作为配置 Web 服务器的起点。大多数情况下，此文件需要根据你的服务器配置进行自定义。如果你希望获得服务器管理方面的帮助，请考虑使用像 Laravel Cloud 这样的全托管 Laravel 平台。

请确保（如以下配置所示）你的 Web 服务器将所有请求定向到应用程序的 public/index.php 文件。你永远不应尝试将 index.php 文件移动到项目根目录，因为从项目根目录提供应用程序会将许多敏感配置文件暴露在公共互联网上：

nginx
server {
    listen 80;
    listen [::]:80;
    server_name example.com;
    root /srv/example.com/public;

    add_header X-Frame-Options "SAMEORIGIN";
    add_header X-Content-Type-Options "nosniff";

    index index.php;

    charset utf-8;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location = /favicon.ico { access_log off; log_not_found off; }
    location = /robots.txt  { access_log off; log_not_found off; }

    error_page 404 /index.php;

    location ~ ^/index\.php(/|$) {
        fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
        include fastcgi_params;
        fastcgi_hide_header X-Powered-By;
    }

    location ~ /\.(?!well-known).* {
        deny all;
    }
}

FrankenPHP ​

FrankenPHP 也可用于服务你的 Laravel 应用程序。FrankenPHP 是一个用 Go 编写的现代 PHP 应用服务器。要使用 FrankenPHP 服务 Laravel PHP 应用程序，只需调用其 php-server 命令：

shell
frankenphp php-server -r public/

要利用 FrankenPHP 支持的更强大功能，例如其 Laravel Octane 集成、HTTP/3、现代压缩或将 Laravel 应用程序打包为独立二进制文件的能力，请查阅 FrankenPHP 的 Laravel 文档。

目录权限 ​

Laravel 需要写入 bootstrap/cache 和 storage 目录，因此你应该确保 Web 服务器进程所有者具有写入这些目录的权限。

优化 ​

将应用程序部署到生产环境时，有多种文件应该被缓存，包括配置、事件、路由和视图。Laravel 提供了一个方便的 optimize Artisan 命令，可以缓存所有这些文件。此命令通常应作为应用程序部署过程的一部分来调用：

shell
php artisan optimize

optimize:clear 方法可用于删除 optimize 命令生成的所有缓存文件以及默认缓存驱动中的所有键：

shell
php artisan optimize:clear

在以下文档中，我们将讨论由 optimize 命令执行的每个细粒度优化命令。

缓存配置 ​

将应用程序部署到生产环境时，你应该确保在部署过程中运行 config:cache Artisan 命令：

shell
php artisan config:cache

此命令会将 Laravel 的所有配置文件合并为一个缓存文件，大大减少了框架在加载配置值时访问文件系统的次数。

WARNING

如果你在部署过程中执行 config:cache 命令，应确保只在配置文件中调用 env 函数。一旦配置被缓存，.env 文件将不会被加载，所有对 .env 变量调用 env 函数都将返回 null。

缓存事件 ​

你应该在部署过程中缓存应用程序自动发现的事件到监听器的映射。这可以通过在部署期间调用 event:cache Artisan 命令来完成：

shell
php artisan event:cache

缓存路由 ​

如果你正在构建一个具有许多路由的大型应用程序，应确保在部署过程中运行 route:cache Artisan 命令：

shell
php artisan route:cache

此命令将所有路由注册减少为缓存文件中的单个方法调用，在注册数百个路由时提高了路由注册的性能。

缓存视图 ​

将应用程序部署到生产环境时，你应该确保在部署过程中运行 view:cache Artisan 命令：

shell
php artisan view:cache

此命令会预编译所有 Blade 视图，使它们不会按需编译，从而提高每个返回视图的请求的性能。

重新加载服务 ​

NOTE

部署到 Laravel Cloud 时，不需要使用 reload 命令，因为所有服务的优雅重新加载会自动处理。

部署应用程序的新版本后，任何长时间运行的服务（如队列 worker、Laravel Reverb 或 Laravel Octane）都应重新加载/重启以使用新代码。Laravel 提供了一个 reload Artisan 命令来终止这些服务：

shell
php artisan reload

如果你没有使用 Laravel Cloud，你应该手动配置一个进程监控器，使其能够检测可重新加载的进程何时退出并自动重启它们。

调试模式 ​

config/app.php 配置文件中的 debug 选项决定了向用户实际显示多少错误信息。默认情况下，此选项设置为遵循 APP_DEBUG 环境变量的值，该变量存储在应用程序的 .env 文件中。

WARNING

在生产环境中，此值应始终为 false。如果在生产环境中将 APP_DEBUG 变量设置为 true，你将面临向应用程序最终用户暴露敏感配置值的风险。

健康检查路由 ​

Laravel 包含一个内置的健康检查路由，可用于监控应用程序的状态。在生产环境中，此路由可用于向正常运行时间监控器、负载均衡器或 Kubernetes 等编排系统报告应用程序的状态。

默认情况下，健康检查路由在 /up 上提供服务，如果应用程序启动时没有异常，将返回 200 HTTP 响应。否则，将返回 500 HTTP 响应。你可以在应用程序的 bootstrap/app 文件中配置此路由的 URI：

php
->withRouting(
    web: __DIR__.'/../routes/web.php',
    commands: __DIR__.'/../routes/console.php',
    health: '/up', // [tl! remove]
    health: '/status', // [tl! add]
)

当对此路由发出 HTTP 请求时，Laravel 还会分发 Illuminate\Foundation\Events\DiagnosingHealth 事件，允许你执行与应用程序相关的额外健康检查。在此事件的监听器中，你可以检查应用程序的数据库或缓存状态。如果你检测到应用程序存在问题，可以简单地从监听器中抛出异常。

使用 Laravel Cloud 或 Forge 部署 ​

Laravel Cloud ​

如果你想要一个为 Laravel 量身定制的全托管、自动扩展的部署平台，请查看 Laravel Cloud。Laravel Cloud 是一个强大的 Laravel 部署平台，提供托管计算、数据库、缓存和对象存储。

在 Cloud 上启动你的 Laravel 应用程序，享受可扩展的简洁体验。Laravel Cloud 由 Laravel 的创建者精心调优，与框架无缝协作，让你可以像往常一样编写 Laravel 应用程序。

Laravel Forge ​

如果你更喜欢管理自己的服务器，但不太熟悉配置运行强大 Laravel 应用程序所需的各种服务，Laravel Forge 是一个面向 Laravel 应用程序的 VPS 服务器管理平台。

Laravel Forge 可以在 DigitalOcean、Linode、AWS 等各种基础设施提供商上创建服务器。此外，Forge 还安装和管理构建强大 Laravel 应用程序所需的所有工具，如 Nginx、MySQL、Redis、Memcached、Beanstalk 等。