Laravel 文档

Appearance

配置 ​

简介 ​

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 服务器上运行而有所不同。然后，config 目录中的配置文件使用 Laravel 的 env 函数读取这些值。

如果你与团队一起开发，你可能希望继续将 .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')) {
    // The environment is local
}

if (App::environment(['local', 'staging'])) {
    // The environment is either local OR 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 个字符的密钥。你可以自由使用 Laravel 加密器支持的任何密码，方法是在调用命令时传递 --cipher 选项。

如果你的应用程序有多个环境文件，例如 .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');

// Retrieve a default value if the configuration value does not exist...
$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 命令。在本地开发期间不应运行此命令，因为在应用程序开发过程中配置选项需要频繁更改。

一旦配置被缓存，应用程序的 .env 文件将不会在请求或 Artisan 命令期间被框架加载；因此，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 选项决定实际向用户显示多少错误信息。默认情况下，此选项设置为 respect APP_DEBUG 环境变量的值，该值存储在你的 .env 文件中。

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 选项。密钥将在应用程序进入维护模式时显示给你。

访问此隐藏路由后，你将被重定向到应用程序的 / 路由。一旦 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 等完全托管的平台上运行你的应用程序，以实现零停机部署。

基于 MIT 协议发布

Copyright © Laravel 中文文档贡献者