Laravel 11.x 中文文档

简体中文

English

简体中文

English

主题

本地化 ​

介绍 ​

lightbulb

默认情况下，Laravel 应用程序骨架不包括 lang 目录。如果您想自定义 Laravel 的语言文件，可以通过 lang:publish Artisan 命令发布它们。

Laravel 的本地化功能提供了一种方便的方式来检索各种语言的字符串，使您能够轻松支持应用程序中的多种语言。

Laravel 提供两种管理翻译字符串的方法。首先，语言字符串可以存储在应用程序的 lang 目录中的文件中。在此目录中，可能会有每种受支持语言的子目录。这是 Laravel 用于管理内置 Laravel 功能（如验证错误消息）的翻译字符串的方法：

php
/lang
    /en
        messages.php
    /es
        messages.php

或者，翻译字符串可以在放置在 lang 目录中的 JSON 文件中定义。当采用这种方法时，您应用程序支持的每种语言将在此目录中有一个相应的 JSON 文件。这种方法推荐用于具有大量可翻译字符串的应用程序：

php
/lang
    en.json
    es.json

我们将在本文件中讨论管理翻译字符串的每种方法。

发布语言文件 ​

默认情况下，Laravel 应用程序骨架不包括 lang 目录。如果您想自定义 Laravel 的语言文件或创建自己的文件，您应该通过 lang:publish Artisan 命令构建 lang 目录。lang:publish 命令将在您的应用程序中创建 lang 目录并发布 Laravel 使用的默认语言文件集：

shell
php artisan lang:publish

配置区域 ​

应用程序的默认语言存储在 config/app.php 配置文件的 locale 配置选项中，通常使用 APP_LOCALE 环境变量设置。您可以自由修改此值以满足应用程序的需求。

您还可以配置“后备语言”，当默认语言不包含给定的翻译字符串时，将使用该语言。与默认语言一样，后备语言也在 config/app.php 配置文件中配置，其值通常使用 APP_FALLBACK_LOCALE 环境变量设置。

您可以在运行时使用 App facade 提供的 setLocale 方法修改单个 HTTP 请求的默认语言：

php
use Illuminate\Support\Facades\App;

Route::get('/greeting/{locale}', function (string $locale) {
    if (! in_array($locale, ['en', 'es', 'fr'])) {
        abort(400);
    }

    App::setLocale($locale);

    // ...
});

确定当前区域 ​

您可以使用 App facade 上的 currentLocale 和 isLocale 方法来确定当前区域或检查区域是否为给定值：

php
use Illuminate\Support\Facades\App;

$locale = App::currentLocale();

if (App::isLocale('en')) {
    // ...
}

复数语言 ​

您可以指示 Laravel 的“复数化器”，它被 Eloquent 和框架的其他部分用于将单数字符串转换为复数字符串，使用除英语以外的语言。这可以通过在应用程序的一个服务提供者的 boot 方法中调用 useLanguage 方法来实现。复数化器当前支持的语言有：french、norwegian-bokmal、portuguese、spanish 和 turkish：

php
use Illuminate\Support\Pluralizer;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Pluralizer::useLanguage('spanish');

    // ...
}
exclamation

如果您自定义复数化器的语言，您应该明确地定义您的 Eloquent 模型的 表名。

定义翻译字符串 ​

使用短键 ​

通常，翻译字符串存储在 lang 目录中的文件中。在此目录中，应该为应用程序支持的每种语言创建一个子目录。这是 Laravel 用于管理内置 Laravel 功能（如验证错误消息）的翻译字符串的方法：

php
/lang
    /en
        messages.php
    /es
        messages.php

所有语言文件返回一个键值字符串的数组。例如：

php
<?php

// lang/en/messages.php

return [
    'welcome' => '欢迎来到我们的应用程序！',
];
exclamation

对于因地区而异的语言，您应该根据 ISO 15897 命名语言目录。例如，"en_GB" 应用于英国英语，而不是 "en-gb"。

将翻译字符串作为键使用 ​

对于具有大量可翻译字符串的应用程序，使用“短键”定义每个字符串在视图中引用键时可能会变得混乱，并且不断为应用程序支持的每个翻译字符串发明键是繁琐的。

因此，Laravel 还支持使用字符串的“默认”翻译作为键来定义翻译字符串。使用翻译字符串作为键的语言文件存储为 JSON 文件在 lang 目录中。例如，如果您的应用程序有西班牙语翻译，您应该创建一个 lang/es.json 文件：

json
{
    "I love programming.": "Me encanta programar."
}

键/文件冲突 ​

您不应定义与其他翻译文件名冲突的翻译字符串键。例如，为 "NL" 区域翻译 __('Action') 时，如果存在 nl/action.php 文件而 nl.json 文件不存在，则翻译器将返回 nl/action.php 的全部内容。

检索翻译字符串 ​

您可以使用 __ 辅助函数从语言文件中检索翻译字符串。如果您使用“短键”定义翻译字符串，则应使用“点”语法将包含键的文件和键本身传递给 __ 函数。例如，让我们从 lang/en/messages.php 语言文件中检索 welcome 翻译字符串：

php
echo __('messages.welcome');

如果指定的翻译字符串不存在，__ 函数将返回翻译字符串键。因此，使用上面的示例，如果翻译字符串不存在，__ 函数将返回 messages.welcome。

如果您使用您的 默认翻译字符串作为翻译键，则应将字符串的默认翻译传递给 __ 函数；

php
echo __('I love programming.');

同样，如果翻译字符串不存在，__ 函数将返回它所给出的翻译字符串键。

如果您使用 Blade 模板引擎，您可以使用 {{ }} 输出语法来显示翻译字符串：

php
{{ __('messages.welcome') }}

替换翻译字符串中的参数 ​

如果您愿意，可以在翻译字符串中定义占位符。所有占位符都以 : 为前缀。例如，您可以定义一个带有占位符名称的欢迎消息：

php
'welcome' => '欢迎，:name',

要在检索翻译字符串时替换占位符，您可以将替换数组作为第二个参数传递给 __ 函数：

php
echo __('messages.welcome', ['name' => 'dayle']);

如果您的占位符包含所有大写字母，或者只有第一个字母大写，则翻译值将相应地大写：

php
'welcome' => '欢迎，:NAME', // 欢迎，DAYLE
'goodbye' => '再见，:Name', // 再见，Dayle

对象替换格式化 ​

如果您尝试提供一个对象作为翻译占位符，将调用该对象的 __toString 方法。__toString 方法是 PHP 的内置“魔术方法”之一。然而，有时您可能无法控制给定类的 __toString 方法，例如当您与属于第三方库的类交互时。

在这些情况下，Laravel 允许您为该特定类型的对象注册一个自定义格式化处理程序。要实现这一点，您应该调用翻译器的 stringable 方法。stringable 方法接受一个闭包，该闭包应类型提示它负责格式化的对象类型。通常，stringable 方法应在您的应用程序的 AppServiceProvider 类的 boot 方法中调用：

php
use Illuminate\Support\Facades\Lang;
use Money\Money;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Lang::stringable(function (Money $money) {
        return $money->formatTo('en_GB');
    });
}

复数化 ​

复数化是一个复杂的问题，因为不同语言有各种复杂的复数化规则；然而，Laravel 可以帮助您根据您定义的复数化规则翻译字符串。使用 | 字符，您可以区分字符串的单数和复数形式：

php
'apples' => '有一个苹果|有许多苹果',

当然，当使用 将翻译字符串作为键 时，复数化也是支持的：

json
{
    "有一个苹果|有许多苹果": "Hay una manzana|Hay muchas manzanas"
}

您甚至可以创建更复杂的复数化规则，指定多个值范围的翻译字符串：

php
'apples' => '{0} 没有|[1,19] 有一些|[20,*] 有很多',

在定义具有复数化选项的翻译字符串后，您可以使用 trans_choice 函数检索给定“计数”的行。在这个例子中，由于计数大于一，返回翻译字符串的复数形式：

php
echo trans_choice('messages.apples', 10);

您还可以在复数化字符串中定义占位符属性。这些占位符可以通过将数组作为第三个参数传递给 trans_choice 函数来替换：

php
'minutes_ago' => '{1} :value 分钟前|[2,*] :value 分钟前',

echo trans_choice('time.minutes_ago', 5, ['value' => 5]);

如果您想显示传递给 trans_choice 函数的整数值，可以使用内置的 :count 占位符：

php
'apples' => '{0} 没有|{1} 有一个|[2,*] 有 :count',

覆盖包语言文件 ​

某些包可能会附带自己的语言文件。您可以通过将文件放置在 lang/vendor/{package}/{locale} 目录中来覆盖它们，而不是更改包的核心文件以调整这些行。

因此，例如，如果您需要覆盖名为 skyrim/hearthfire 的包中的 messages.php 的英语翻译字符串，您应该在 lang/vendor/hearthfire/en/messages.php 放置一个语言文件。在此文件中，您只需定义您希望覆盖的翻译字符串。您没有覆盖的任何翻译字符串仍将从包的原始语言文件中加载。

版权所有 © 2024-2025 laravel.wiki