laravel
2. 入门
部署

简介

当您准备将 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 的第一方服务器管理和部署服务,例如Laravel Forge (opens in a new tab)

请确保,与以下配置一样,您的 Web 服务器将所有请求定向到应用程序的public/index.php文件。您永远不应尝试将index.php文件移动到项目的根目录,因为从项目根目录提供应用程序会将许多敏感的配置文件暴露给公共互联网:

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 ~ \.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 (opens in a new tab) 也可用于为您的 Laravel 应用程序提供服务。FrankenPHP 是一个用 Go 编写的现代 PHP 应用服务器。要使用 FrankenPHP 为 Laravel PHP 应用程序提供服务,您可以简单地调用其 php-server 命令:

frankenphp php-server -r public/

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

目录权限

Laravel 需要对 bootstrap/cachestorage 目录进行写入操作,因此您应该确保 Web 服务器进程所有者有权限写入这些目录。

优化

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

php artisan optimize

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

php artisan optimize:clear

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

缓存配置

当将您的应用程序部署到生产环境时,您应该确保在部署过程中运行 config:cache Artisan 命令:

php artisan config:cache

此命令将把 Laravel 的所有配置文件合并到一个单独的缓存文件中,这大大减少了框架在加载配置值时必须对文件系统进行的访问次数。

[!WARNING]
如果您在部署过程中执行 config:cache 命令,您应该确保仅在配置文件中调用 env 函数。一旦配置被缓存,.env 文件将不会被加载,并且对 .env 变量的所有 env 函数调用都将返回 null

缓存事件

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

php artisan event:cache

缓存路由

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

php artisan route:cache

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

缓存视图

当将您的应用程序部署到生产环境时,您应该确保在部署过程中运行 view:cache Artisan 命令:

php artisan view:cache

此命令会预编译您的所有 Blade 视图,以便它们不会按需编译,提高了每个返回视图的请求的性能。

调试模式

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

[!警告]
在您的生产环境中,此值应始终为 false。如果在生产环境中将 APP_DEBUG 变量设置为 true,您可能会将敏感的配置值暴露给您的应用程序的最终用户。

健康检查路由

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

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

->withRouting(
    web: __DIR__.'/../routes/web.php',
    commands: __DIR__.'/../routes/console.php',
    health: '/up', // [tl! 移除]
    health: '/status', // [tl! 添加]
)

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

使用 Forge / Vapor 轻松部署

Laravel Forge

如果您还没有准备好管理自己的服务器配置,或者对配置运行强大的 Laravel 应用程序所需的各种服务不太熟悉,Laravel Forge (opens in a new tab) 是一个很好的选择。

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

[!注意]
想要一个使用 Laravel Forge 进行部署的完整指南吗?查看 Laravel 训练营 (opens in a new tab) 和在 Laracasts 上可用的 Forge 视频系列 (opens in a new tab)

Laravel Vapor

如果您想要一个完全无服务器、自动扩展的部署平台,专为 Laravel 调整,查看 Laravel Vapor (opens in a new tab)。Laravel Vapor 是一个由 AWS 提供支持的 Laravel 无服务器部署平台。在 Vapor 上启动您的 Laravel 基础设施,并爱上无服务器的可扩展简单性。Laravel Vapor 由 Laravel 的创建者进行了微调,以便与框架无缝协作,因此您可以继续像往常一样编写您的 Laravel 应用程序。