配置

• 介绍
• 环境配置
  • 环境变量类型
  • 检索环境配置
  • 确定当前环境
  • 加密环境文件
• 访问配置值
• 配置缓存
• 配置发布
• 调试模式
• 维护模式

介绍

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

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

about 命令

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

php artisan about

如果您只对应用程序概述输出的特定部分感兴趣，可以使用 --only 选项进行过滤：

php artisan about --only=environment

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

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

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

APP_NAME="My Application"

检索环境配置

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

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

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

确定当前环境

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

use Illuminate\Support\Facades\App;

$environment = App::environment();

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

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

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

NOTE

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

加密环境文件

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

加密

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

php artisan env:encrypt

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

php artisan env:encrypt --key=3UVsEgGVK36XN82KKeyLFMhvosbZN1aF

NOTE

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

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

php artisan env:encrypt --env=staging

解密

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

php artisan env:decrypt

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

php artisan env:decrypt --key=3UVsEgGVK36XN82KKeyLFMhvosbZN1aF

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

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

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

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

php artisan env:decrypt --env=staging

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

php artisan env:decrypt --force

访问配置值

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

use Illuminate\Support\Facades\Config;

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

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

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

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

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

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

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

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 命令。该命令不应在本地开发期间运行，因为在应用程序开发过程中，配置选项需要频繁更改。

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

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

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

php artisan config:clear

WARNING

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

配置发布

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

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

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 命令：

php artisan down

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

php artisan down --refresh=15

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

php artisan down --retry=60

绕过维护模式

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

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

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

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

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

php artisan down --with-secret

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

NOTE

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

多服务器上的维护模式

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

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

APP_MAINTENANCE_DRIVER=cache
APP_MAINTENANCE_STORE=database

预渲染维护模式视图

如果您在部署期间使用 php artisan down 命令，用户在访问应用程序时可能仍会偶尔遇到错误，因为在确定应用程序处于维护模式并使用模板引擎渲染维护模式视图之前，Laravel 框架的很大一部分必须启动。

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

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

重定向维护模式请求

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

php artisan down --redirect=/

禁用维护模式

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

php artisan up

NOTE

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

维护模式和队列

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

维护模式的替代方案

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