本地化

• 简介
  • 发布语言文件
  • 配置语言环境
  • 复数化语言
• 定义翻译字符串
  • 使用短键
  • 使用翻译字符串作为键
• 获取翻译字符串
  • 在翻译字符串中替换参数
  • 复数化
• 覆盖扩展包语言文件

简介

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

Laravel 的本地化功能提供了一种便捷的方式来获取不同语言的字符串，使你能够轻松地在应用程序中支持多种语言。

Laravel 提供了两种方式来管理翻译字符串。首先，语言字符串可以存储在应用程序的 lang 目录中的文件里。在该目录中，可以为应用程序支持的每种语言创建一个子目录。Laravel 使用这种方式来管理内置功能（如验证错误消息）的翻译字符串：

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

或者，翻译字符串也可以定义在 lang 目录中的 JSON 文件里。采用这种方式时，应用程序支持的每种语言在该目录中都会有一个对应的 JSON 文件。对于拥有大量可翻译字符串的应用程序，推荐采用这种方式：

/lang
    en.json
    es.json

我们将在本文档中讨论这两种管理翻译字符串的方式。

发布语言文件

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

php artisan lang:publish

配置语言环境

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

你还可以配置一个「备用语言」，当默认语言中没有某个翻译字符串时，就会使用该备用语言。与默认语言一样，备用语言也在 config/app.php 配置文件中配置，其值通常通过 APP_FALLBACK_LOCALE 环境变量设置。

你可以在运行时使用 App 门面提供的 setLocale 方法，为单个 HTTP 请求修改默认语言：

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 门面上的 currentLocale 和 isLocale 方法来确定当前语言环境，或检查语言环境是否为指定值：

use Illuminate\Support\Facades\App;

$locale = App::currentLocale();

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

复数化语言

use Illuminate\Support\Pluralizer;

/**
 * 引导应用程序服务。
 */
public function boot(): void
{
    Pluralizer::useLanguage('spanish');

    // ...
}

[!WARNING]
如果你自定义了复数化器的语言，应该显式定义 Eloquent 模型的数据表名称。

定义翻译字符串

使用短键

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

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

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

<?php

// lang/en/messages.php

return [
    'welcome' => 'Welcome to our application!',
];

[!WARNING]
对于因地区不同而有所差异的语言，应该按照 ISO 15897 标准命名语言目录。例如，英国英语应该使用「en_GB」而不是「en-gb」。

使用翻译字符串作为键

对于拥有大量可翻译字符串的应用程序，为每个字符串定义一个「短键」会让在视图中引用这些键变得混乱，而且不断为应用程序支持的每个翻译字符串构思新的键也很繁琐。

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

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

键 / 文件冲突

你不应该定义与其他翻译文件名冲突的翻译字符串键。例如，在「NL」语言环境中翻译 __('Action') 时，如果存在 nl/action.php 文件但不存在 nl.json 文件，翻译器就会返回 nl/action.php 文件的全部内容。

获取翻译字符串

你可以使用 __ 辅助函数从语言文件中获取翻译字符串。如果使用「短键」来定义翻译字符串，应该通过「点」语法将包含该键的文件名和键本身传递给 __ 函数。例如，从 lang/en/messages.php 语言文件中获取 welcome 翻译字符串：

echo __('messages.welcome');

如果指定的翻译字符串不存在，__ 函数会返回翻译字符串的键。因此，在上面的例子中，如果翻译字符串不存在，__ 函数就会返回 messages.welcome。

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

echo __('I love programming.');

同样，如果翻译字符串不存在，__ 函数会返回传入的翻译字符串键。

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

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

在翻译字符串中替换参数

你可以在翻译字符串中定义占位符。所有占位符都以 : 为前缀。例如，你可以定义一条包含姓名占位符的欢迎消息：

'welcome' => 'Welcome, :name',

在获取翻译字符串时，可以将替换值数组作为 __ 函数的第二个参数传入，以替换占位符：

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

如果占位符全部使用大写字母，或只有首字母大写，替换后的值也会相应地转换为全部大写或首字母大写：

'welcome' => 'Welcome, :NAME', // Welcome, DAYLE
'goodbye' => 'Goodbye, :Name', // Goodbye, Dayle

对象占位符的格式化

如果你尝试将对象作为翻译占位符的值，Laravel 会调用该对象的 __toString 方法。__toString 方法是 PHP 内置的「魔术方法」之一。不过，有时你可能无法控制某个类的 __toString 方法，例如，该类属于第三方库时。

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

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

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

复数化

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

'apples' => 'There is one apple|There are many apples',

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

{
    "There is one apple|There are many apples": "Hay una manzana|Hay muchas manzanas"
}

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

'apples' => '{0} There are none|[1,19] There are some|[20,*] There are many',

定义带有复数选项的翻译字符串后，可以使用 trans_choice 函数，根据给定的「数量」获取对应的翻译字符串。在这个例子中，由于数量大于 1，返回的是翻译字符串的复数形式：

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

你也可以在复数字符串中定义占位符。将数组作为 trans_choice 函数的第三个参数传入，即可替换这些占位符：

'minutes_ago' => '{1} :value minute ago|[2,*] :value minutes ago',

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

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

'apples' => '{0} There are none|{1} There is one|[2,*] There are :count',

覆盖扩展包语言文件

有些扩展包可能会自带语言文件。你无需修改扩展包的核心文件来调整这些翻译字符串，而是可以将文件放置在 lang/vendor/{package}/{locale} 目录中来覆盖它们。

例如，如果需要覆盖名为 skyrim/hearthfire 的扩展包中 messages.php 文件的英文翻译字符串，应该将语言文件放置在 lang/vendor/hearthfire/en/messages.php。在这个文件中，只需定义你想覆盖的翻译字符串。未被覆盖的翻译字符串仍会从扩展包原始的语言文件中加载。

本译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。

原文地址：https://learnku.com/docs/laravel/13.x/lo...

译文地址：https://learnku.com/docs/laravel/13.x/lo...