作为一名PHP开发者,尤其是在构建面向全球用户的Laravel应用时,多语言支持(国际化I18n)是不可避免的需求。曾几何时,我被手动提取、管理和更新应用程序中的所有可翻译字符串所困扰。这不仅繁琐且容易出错,更是在项目迭代中成为一个巨大的维护负担。我渴望一种更智能、更自动化的方式来解决这个问题。
遭遇多语言管理的“噩梦”
我的Laravel应用需要支持多种语言,这意味着我必须将所有用户界面上的文本(例如
__('Welcome')
或
@lang('Dashboard')
)都转化为可翻译的字符串。起初,这似乎很简单:创建一个
lang/en.json
和
lang/es.json
文件,然后手动将字符串复制进去。
然而,随着项目功能的不断增加,新的视图、新的控制器、新的邮件模板层出不穷,其中包含了大量的可翻译文本。我很快就陷入了以下困境:
- 遗漏与不一致: 每次新增或修改功能,我都需要手动检查所有代码,找出新的
__('')
或
@lang('')
调用,然后逐一复制到
lang/*.json
文件中。稍有不慎,就会遗漏一些字符串,导致在某些语言环境下显示英文原文,极大地影响用户体验。
- 维护成本高昂: 当需要修改某个已有的字符串时,我不仅要修改代码中的文本,还要确保所有语言的JSON文件中都同步更新,这在大型项目中简直是灾难。
- 难以追踪未翻译内容: 我无法直观地知道哪些字符串在某个语言文件中还没有被翻译。我只能通过运行应用、切换语言,然后肉眼检查,效率低下且容易出错。
- 动态字符串的挑战: 有些字符串是动态生成的,例如
sprintf('Dear customer, your order has been %s', $orderStatus)
。这些字符串无法直接被扫描工具识别,手动添加后,又担心下次导出时会被覆盖或移除。
这些问题让我感到非常头疼,我意识到传统的“人肉”管理方式已经无法满足项目的需求,我需要一个强大的工具来将我从这场多语言管理的噩梦中解救出来。
拥抱 Composer:
kkomelin/laravel-translatable-string-exporter
kkomelin/laravel-translatable-string-exporter
登场
幸好,在PHP的生态系统中,我们有Composer这个强大的包管理器,它让引入第三方库变得前所未有的简单。正是通过Composer,我发现了
kkomelin/laravel-translatable-string-exporter
这个宝藏!
kkomelin/laravel-translatable-string-exporter
是一个专为Laravel设计的Composer包,它的核心目标是自动化地收集应用程序中所有可翻译的字符串(通过
__('')
或
@lang('')
定义),并将它们导出到JSON格式的语言文件中,从而极大地简化了多语言翻译的流程。
它的工作原理与实际应用
安装这个包非常简单,因为它主要用于开发环境,所以我们将其作为开发依赖安装:
<pre class="brush:php;toolbar:false">composer require kkomelin/laravel-translatable-string-exporter --dev
安装完成后,你可能需要发布其配置文件,以便根据自己的需求进行更细致的配置(例如,指定扫描的目录、排除的目录等):
<pre class="brush:php;toolbar:false">php artisan vendor:publish --provider="KKomelinTranslatableStringExporterProvidersExporterServiceProvider"
现在,我们来看看它是如何解决我之前遇到的那些痛点的。
1. 自动化字符串导出
这是这个包最核心的功能。告别手动复制粘贴,现在只需一条命令:
<pre class="brush:php;toolbar:false">php artisan translatable:export es,de,fr
这条命令会:
- 扫描你的整个Laravel项目(包括Blade模板、PHP文件等),找出所有使用
__('')
或
@lang('')
定义的可翻译字符串。
- 为
es.json
、
de.json
、
fr.json
等语言文件创建或更新相应的JSON文件,这些文件通常位于
lang/
目录下。
- 如果文件已存在,它会保留已有的翻译,只添加新的或更新的字符串。
例如,运行后你的
lang/es.json
可能会是这样:
<pre class="brush:php;toolbar:false">{ "Welcome": "Bienvenido", "Dashboard": "Panel de control", "New Feature": "Nueva característica" }
这彻底解决了字符串遗漏和手动维护的难题,每次代码更新后,只需运行一次命令,所有新的可翻译字符串就会自动进入翻译文件,等待翻译人员处理。
2. 轻松发现未翻译的字符串
我曾经最大的困扰之一就是不知道哪些字符串还没有被翻译。现在,
inspect-translations
命令完美解决了这个问题:
<pre class="brush:php;toolbar:false">php artisan translatable:inspect-translations fr
这条命令会检查
lang/fr.json
文件,并列出所有值与键相同的条目(即尚未被翻译的字符串),或者直接指出缺失的字符串。这让我可以迅速定位到需要翻译的内容,大大提升了翻译工作的效率。
你甚至可以结合导出功能:
<pre class="brush:php;toolbar:false">php artisan translatable:inspect-translations fr --export-first
这会先导出所有字符串到
fr.json
,然后再检查其中未翻译的部分。
此外,这个包还提供了一个小技巧:在IDE(如PhpStorm或VSCode)中,你可以使用正则表达式
"([^"]*)": "1"
来搜索JSON文件,快速找到那些键和值相同的未翻译条目。
3. 优雅处理动态字符串(Persistent Strings)
对于那些像
sprintf('Dear customer, your order has been %s', $orderStatus)
这样动态生成的字符串,它们无法被扫描工具直接识别。如果手动将它们添加到
lang/*.json
文件中,又担心下次导出时会被覆盖。
kkomelin/laravel-translatable-string-exporter
提供了一个优雅的解决方案:
persistent-strings.json
文件。你可以在
lang/
目录下创建一个
persistent-strings.json
文件,将这些动态生成的字符串添加到其中:
<pre class="brush:php;toolbar:false">[ "Dear customer, your order has been approved", "Dear customer, your order has been paid", "Dear customer, your order has been cancelled" ]
这样,每次运行
translatable:export
命令时,这些字符串就不会被移除,确保了动态内容的翻译也能得到妥善管理。
总结与展望
自从引入
kkomelin/laravel-translatable-string-exporter
后,我的Laravel多语言管理工作从一场“噩梦”变成了“轻而易举”。它的优势显而易见:
- 自动化与效率: 告别手动复制粘贴,大幅提升多语言开发的效率。
- 减少错误: 确保所有可翻译字符串都被捕获,降低遗漏和不一致的风险。
- 简化维护: 项目迭代时,只需简单命令即可更新翻译文件,维护成本大大降低。
- 清晰的翻译进度: 轻松识别未翻译内容,让翻译工作更有条理。
- 更好的团队协作: 开发者可以专注于业务逻辑,翻译人员可以专注于翻译本身,分工明确。
如果你也正在为Laravel应用的多语言管理而烦恼,我强烈推荐你尝试
kkomelin/laravel-translatable-string-exporter
。它将是你开发全球化应用过程中不可或缺的利器!
评论(已关闭)
评论已关闭