Laravel 13.x 中文文档

主题

配置 ​

简介 ​

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

这些配置文件允许您配置数据库连接信息、邮件服务器信息，以及应用程序 URL 和加密密钥等各种核心配置值。

about 命令 ​

Laravel 可以通过 about Artisan 命令显示应用程序配置、驱动程序和环境的概览。

shell
php artisan about

如果您只对应用程序概览输出的特定部分感兴趣，可以使用 --only 选项筛选该部分：

shell
php artisan about --only=environment

或者，要详细探索特定配置文件的值，您可以使用 config:show Artisan 命令：

shell
php artisan config:show database

环境配置 ​

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

为了使这变得轻而易举，Laravel 使用了 DotEnv PHP 库。在全新的 Laravel 安装中，应用程序的根目录将包含一个 .env.example 文件，其中定义了许多常见环境变量。在 Laravel 安装过程中，此文件将自动复制为 .env。

Laravel 的默认 .env 文件包含一些常见配置值，这些值可能根据您的应用程序是在本地运行还是在生产 Web 服务器上运行而有所不同。然后，这些值通过 Laravel 的 env 函数被 config 目录中的配置文件读取。

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

NOTE

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

环境文件安全性 ​

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

但是，可以使用 Laravel 内置的 环境加密 功能加密您的环境文件。加密的环境文件可以安全地放置在源代码控制中。

额外的环境文件 ​

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

环境变量类型 ​

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

.env 值env() 值
true(bool) true
(true)(bool) true
false(bool) false
(false)(bool) false
empty(string) ''
(empty)(string) ''
null(null) null
(null)(null) null

如果您需要定义一个值包含空格的环境变量，可以通过将值括在双引号中来实现：

ini
APP_NAME="My Application"

获取环境配置 ​

当您的应用程序收到请求时，.env 文件中列出的所有变量将被加载到 $_ENV PHP 超全局变量中。但是，您可以在配置文件中使用 env 函数从这些变量中获取值。事实上，如果您查看 Laravel 配置文件，您会注意到许多选项已经在使用此函数：

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

传递给 env 函数的第二个值是"默认值"。如果给定键不存在环境变量，则返回此值。

确定当前环境 ​

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

php
use Illuminate\Support\Facades\App;

$environment = App::environment();

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

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

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

NOTE

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

加密环境文件 ​

未加密的环境文件不应存储在源代码控制中。但是，Laravel 允许您加密环境文件，以便它们可以安全地与应用程序的其余部分一起添加到源代码控制中。

加密 ​

要加密环境文件，您可以使用 env:encrypt 命令：

shell
php artisan env:encrypt

运行 env:encrypt 命令将加密您的 .env 文件，并将加密内容放入 .env.encrypted 文件中。解密密钥在命令输出中显示，应存储在安全的密码管理器中。如果您想提供自己的加密密钥，可以在调用命令时使用 --key 选项：

shell
php artisan env:encrypt --key=3UVsEgGVK36XN82KKeyLFMhvosbZN1aF

NOTE

提供的密钥长度应与所使用的加密密码所需的密钥长度匹配。默认情况下，Laravel 将使用 AES-256-CBC 密码，它需要 32 个字符的密钥。您可以在调用命令时通过传递 --cipher 选项来使用 Laravel 加密器 支持的任何密码。

如果您的应用程序有多个环境文件，例如 .env 和 .env.staging，您可以通过 --env 选项提供环境名称来指定应加密的环境文件：

shell
php artisan env:encrypt --env=staging

可读变量名 ​

加密环境文件时，您可以使用 --readable 选项在加密值的同时保留可见的变量名：

shell
php artisan env:encrypt --readable

这将生成以下格式的加密文件：

ini
APP_NAME=eyJpdiI6...
APP_ENV=eyJpdiI6...
APP_KEY=eyJpdiI6...
APP_DEBUG=eyJpdiI6...
APP_URL=eyJpdiI6...

使用可读格式允许您查看存在哪些环境变量而不暴露敏感数据。这也使审查拉取请求变得更加容易，因为您可以看到添加、删除或重命名了哪些变量，而无需解密文件。

解密环境文件时，Laravel 会自动检测使用了哪种格式，因此 env:decrypt 命令不需要额外的选项。

NOTE

使用 --readable 选项时，原始环境文件中的注释和空行不会包含在加密输出中。

解密 ​

要解密环境文件，您可以使用 env:decrypt 命令。此命令需要解密密钥，Laravel 将从 LARAVEL_ENV_ENCRYPTION_KEY 环境变量中检索：

shell
php artisan env:decrypt

或者，可以通过 --key 选项直接向命令提供密钥：

shell
php artisan env:decrypt --key=3UVsEgGVK36XN82KKeyLFMhvosbZN1aF

调用 env:decrypt 命令时，Laravel 将解密 .env.encrypted 文件的内容，并将解密的内容放入 .env 文件中。

可以向 env:decrypt 命令提供 --cipher 选项以使用自定义加密密码：

shell
php artisan env:decrypt --key=qUWuNRdfuImXcKxZ --cipher=AES-128-CBC

如果您的应用程序有多个环境文件，例如 .env 和 .env.staging，您可以通过 --env 选项提供环境名称来指定应解密的环境文件：

shell
php artisan env:decrypt --env=staging

要覆盖现有环境文件，您可以向 env:decrypt 命令提供 --force 选项：

shell
php artisan env:decrypt --force

访问配置值 ​

您可以在应用程序的任何位置使用 Config 门面或全局 config 函数轻松访问配置值。可以使用"点"语法访问配置值，其中包括您希望访问的文件名和选项。也可以指定默认值，如果配置选项不存在，则返回该值：

php
use Illuminate\Support\Facades\Config;

$value = Config::get('app.timezone');

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

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

要在运行时设置配置值，您可以调用 Config 门面的 set 方法或将数组传递给 config 函数：

php
Config::set('app.timezone', 'America/Chicago');

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

为了帮助静态分析，Config 门面还提供了类型化配置检索方法。如果检索到的配置值与预期类型不匹配，将抛出异常：

php
Config::string('config-key');
Config::integer('config-key');
Config::float('config-key');
Config::boolean('config-key');
Config::array('config-key');
Config::collection('config-key');

配置缓存 ​

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

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

配置缓存后，框架在请求或 Artisan 命令期间不会加载应用程序的 .env 文件；因此，env 函数只会返回外部的系统级环境变量。

因此，您应该确保只从应用程序配置（config）文件中调用 env 函数。您可以通过查看 Laravel 的默认配置文件看到许多这样的示例。可以使用 上文描述 的 config 函数从应用程序的任何位置访问配置值。

可以使用 config:clear 命令清除缓存的配置：

shell
php artisan config:clear

WARNING

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

配置发布 ​

Laravel 的大多数配置文件已经发布在应用程序的 config 目录中；但是，某些配置文件（如 cors.php 和 view.php）默认不发布，因为大多数应用程序永远不需要修改它们。

但是，您可以使用 config:publish Artisan 命令发布任何默认未发布的配置文件：

shell
php artisan config:publish

php artisan config:publish --all

调试模式 ​

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

WARNING

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

维护模式 ​

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

要启用维护模式，请执行 down Artisan 命令：

shell
php artisan down

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

shell
php artisan down --refresh=15

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

shell
php artisan down --retry=60

绕过维护模式 ​

要允许使用秘密令牌绕过维护模式，您可以使用 secret 选项指定维护模式绕过令牌：

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

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

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

如果您希望 Laravel 为您生成秘密令牌，可以使用 with-secret 选项。应用程序进入维护模式后将显示秘密：

shell
php artisan down --with-secret

访问此隐藏路由后，您将被重定向到应用程序的 / 路由。一旦向您的浏览器颁发了 cookie，您将能够正常浏览应用程序，就像它没有处于维护模式一样。

NOTE

您的维护模式秘密通常应由字母数字字符和可选的破折号组成。您应避免使用在 URL 中具有特殊含义的字符，如 ? 或 &。

多服务器上的维护模式 ​

默认情况下，Laravel 使用基于文件的系统确定您的应用程序是否处于维护模式。这意味着要激活维护模式，必须在托管应用程序的每台服务器上执行 php artisan down 命令。

或者，Laravel 提供了一种基于缓存的方法来处理维护模式。此方法只需在一台服务器上运行 php artisan down 命令。要使用此方法，请修改应用程序 .env 文件中的维护模式变量。您应该选择所有服务器都可以访问的缓存 store。这确保维护模式状态在每台服务器上保持一致：

ini
APP_MAINTENANCE_DRIVER=cache
APP_MAINTENANCE_STORE=database

预渲染维护模式视图 ​

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

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

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

重定向维护模式请求 ​

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

shell
php artisan down --redirect=/

禁用维护模式 ​

要禁用维护模式，请使用 up 命令：

shell
php artisan up

NOTE

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

维护模式和队列 ​

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

维护模式的替代方案 ​

由于维护模式需要您的应用程序有几秒钟的停机时间，请考虑在像 Laravel Cloud 这样的完全托管平台上运行您的应用程序，以实现 Laravel 的零停机部署。