Skip to content

配置

介绍

Laravel 框架的所有配置文件都存储在 config 目录中。每个选项都有文档说明,因此可以随意浏览这些文件并熟悉可用的选项。

这些配置文件允许您配置数据库连接信息、邮件服务器信息以及其他各种核心配置值,例如应用程序时区和加密密钥。

环境配置

根据应用程序运行的环境使用不同的配置值通常是有帮助的。例如,您可能希望在本地使用不同的缓存驱动,而不是在生产服务器上使用的缓存驱动。

为了简化这一过程,Laravel 使用了 DotEnv PHP 库。在全新的 Laravel 安装中,应用程序的根目录将包含一个 .env.example 文件,该文件定义了许多常见的环境变量。在 Laravel 安装过程中,该文件将自动复制到 .env

Laravel 的默认 .env 文件包含一些常见的配置值,这些值可能会根据应用程序是在本地运行还是在生产 Web 服务器上运行而有所不同。这些值随后会通过 Laravel 的 env 函数从 config 目录中的各种 Laravel 配置文件中检索。

如果您与团队一起开发,您可能希望继续在应用程序中包含一个 .env.example 文件。通过在示例配置文件中放置占位符值,团队中的其他开发人员可以清楚地看到运行应用程序所需的环境变量。

lightbulb

.env 文件中的任何变量都可以被外部环境变量(如服务器级或系统级环境变量)覆盖。

环境文件安全性

您的 .env 文件不应提交到应用程序的源代码控制中,因为使用您的应用程序的每个开发人员/服务器可能需要不同的环境配置。此外,如果入侵者获得了对您的源代码控制库的访问权限,这将是一个安全风险,因为任何敏感凭据都会被暴露。

附加环境文件

在加载应用程序的环境变量之前,Laravel 会确定是否已外部提供 APP_ENV 环境变量或是否指定了 --env CLI 参数。如果是这样,Laravel 将尝试加载 .env.[APP_ENV] 文件(如果存在)。如果不存在,将加载默认的 .env 文件。

环境变量类型

.env 文件中的所有变量通常会被解析为字符串,因此创建了一些保留值以允许您从 env() 函数返回更广泛的类型:

.envenv()
true(bool) true
(true)(bool) true
false(bool) false
(false)(bool) false
empty(string) ''
(empty)(string) ''
null(null) null
(null)(null) null

如果您需要定义一个包含空格的环境变量值,可以通过将值用双引号括起来来实现:

php
APP_NAME="My Application"

检索环境配置

当应用程序接收到请求时,文件中列出的所有变量将被加载到 $_ENV PHP 超全局变量中。但是,您可以使用 env 助手在配置文件中检索这些变量的值。实际上,如果您查看 Laravel 配置文件,您会注意到许多选项已经在使用此助手:

php
'debug' => env('APP_DEBUG', false),

传递给 env 函数的第二个值是“默认值”。如果给定键没有环境变量存在,则返回此值。

确定当前环境

当前应用程序环境是通过 .env 文件中的 APP_ENV 变量确定的。您可以通过 App facade 上的 environment 方法访问此值:

php
use Illuminate\Support\Facades\App;

$environment = App::environment();

您还可以向 environment 方法传递参数,以确定环境是否与给定值匹配。如果环境与任何给定值匹配,该方法将返回 true

php
if (App::environment('local')) {
    // 环境是本地的
}

if (App::environment(['local', 'staging'])) {
    // 环境是本地或暂存...
}
lightbulb

当前应用程序环境检测可以通过定义服务器级 APP_ENV 环境变量来覆盖。

访问配置值

您可以使用全局 config 助手函数从应用程序的任何地方轻松访问配置值。可以使用“点”语法访问配置值,其中包括您希望访问的文件和选项的名称。还可以指定默认值,如果配置选项不存在,将返回该默认值:

php
$value = config('app.timezone');

// 如果配置值不存在,则检索默认值...
$value = config('app.timezone', 'Asia/Seoul');

要在运行时设置配置值,请将数组传递给 config 助手:

php
config(['app.timezone' => 'America/Chicago']);

配置缓存

为了提高应用程序的速度,您应该使用 config:cache Artisan 命令将所有配置文件缓存到一个文件中。这将把应用程序的所有配置选项组合到一个文件中,框架可以快速加载该文件。

您通常应该在生产部署过程中运行 php artisan config:cache 命令。该命令不应在本地开发期间运行,因为在应用程序开发过程中,配置选项通常需要更改。

exclamation

如果在部署过程中执行 config:cache 命令,您应该确保仅在配置文件中调用 env 函数。配置缓存后,将不再加载 .env 文件;因此,env 函数将仅返回外部的系统级环境变量。

调试模式

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

对于本地开发,您应该将 APP_DEBUG 环境变量设置为 true在生产环境中,此值应始终为 false。如果在生产中将变量设置为 true,则可能会将敏感的配置值暴露给应用程序的最终用户。

维护模式

当应用程序处于维护模式时,将为应用程序的所有请求显示自定义视图。这使得在更新或执行维护时“禁用”应用程序变得容易。维护模式检查包含在应用程序的默认中间件堆栈中。如果应用程序处于维护模式,将抛出一个状态码为 503 的 Symfony\Component\HttpKernel\Exception\HttpException 实例。

要启用维护模式,请执行 down Artisan 命令:

php
php artisan down

如果您希望在所有维护模式响应中发送 Refresh HTTP 头,可以在调用 down 命令时提供 refresh 选项。Refresh 头将指示浏览器在指定的秒数后自动刷新页面:

php
php artisan down --refresh=15

您还可以为 down 命令提供 retry 选项,该选项将设置为 Retry-After HTTP 头的值,尽管浏览器通常会忽略此头:

php
php artisan down --retry=60

绕过维护模式

即使在维护模式下,您也可以使用 secret 选项指定维护模式绕过令牌:

php
php artisan down --secret="1630542a-246b-4b66-afa1-dd72a4c43515"

在将应用程序置于维护模式后,您可以导航到与此令牌匹配的应用程序 URL,Laravel 将向您的浏览器发出维护模式绕过 cookie:

php
https://example.com/1630542a-246b-4b66-afa1-dd72a4c43515

访问此隐藏路由时,您将被重定向到应用程序的 / 路由。一旦 cookie 已发出到您的浏览器,您将能够正常浏览应用程序,就像它不在维护模式下一样。

lightbulb

您的维护模式密钥通常应由字母数字字符组成,并且可以选择使用破折号。您应避免使用在 URL 中具有特殊含义的字符,例如 ?&

预渲染维护模式视图

如果您在部署期间使用 php artisan down 命令,用户在访问应用程序时可能仍会偶尔遇到错误,因为您的 Composer 依赖项或其他基础设施组件正在更新。这是因为为了确定您的应用程序处于维护模式并使用模板引擎渲染维护模式视图,必须启动 Laravel 框架的很大一部分。

因此,Laravel 允许您预渲染将在请求周期的最开始返回的维护模式视图。此视图在加载应用程序的任何依赖项之前渲染。您可以使用 down 命令的 render 选项预渲染您选择的模板:

php
php artisan down --render="errors::503"

重定向维护模式请求

在维护模式下,Laravel 将为用户尝试访问的所有应用程序 URL 显示维护模式视图。如果您愿意,可以指示 Laravel 将所有请求重定向到特定 URL。这可以通过使用 redirect 选项来实现。例如,您可能希望将所有请求重定向到 / URI:

php
php artisan down --redirect=/

禁用维护模式

要禁用维护模式,请使用 up 命令:

php
php artisan up
lightbulb

您可以通过在 resources/views/errors/503.blade.php 中定义自己的模板来自定义默认的维护模式模板。

维护模式与队列

当应用程序处于维护模式时,不会处理任何队列任务。一旦应用程序退出维护模式,任务将继续正常处理。

维护模式的替代方案

由于维护模式需要应用程序有几秒钟的停机时间,请考虑使用 Laravel VaporEnvoyer 等替代方案,以实现 Laravel 的零停机时间部署。