I18N 组件
I18N
国际多语言,允许让您的项目支持多种语言
组件要求
- easyswoole/component: ^2.2
安装方法
composer require easyswoole/i18n
仓库地址
基本使用
在 swoole 中单独使用
<?php
require_once __DIR__ . '/vendor/autoload.php';
use EasySwoole\I18N\AbstractDictionary;
use EasySwoole\I18N\I18N;
// 定义一个词典。const 值请务必于 const 变量名一致,这样是避免用户手敲词条名称出错
class Dictionary extends AbstractDictionary
{
const HELLO = 'HELLO';
const GOOD_MORNING = 'GOOD_MORNING';
const HOME = 'HOME';
}
// 定义一个中文语言包
class Chinese extends Dictionary
{
const HELLO = '你好';
const HOME = '主页';
}
// 定义一个英文语言包
class English extends Dictionary
{
const HELLO = 'hello';
const GOOD_MORNING = 'Hi,good morning';
const HOME = 'home page';
}
// 注册语言包
I18N::getInstance()->addLanguage(new Chinese(), 'Cn');
I18N::getInstance()->addLanguage(new English(), 'En');
// 设置默认语言包
I18N::getInstance()->setDefaultLanguage('Cn');
$http = new swoole_http_server('0.0.0.0', 9501);
$http->on('request', function (\Swoole\Http\Request $request, \Swoole\Http\Response $response) {
// 使用
$res = [];
$ret = I18N::getInstance()->translate(Dictionary::HELLO);
$res[] = $ret;
var_dump($ret); // string(6) "你好"
$ret = I18N::getInstance()->translate(Dictionary::GOOD_MORNING);
$res[] = $ret;
var_dump($ret); // string(12) "GOOD_MORNING"
$ret = I18N::getInstance()->sprintf('%s ! 欢迎到 %s !!!!',Dictionary::HELLO,Dictionary::HOME);
$res[] = $ret;
var_dump($ret); // string(30) "你好 ! 欢迎到 主页 !!!!"
// setLanguage 仅仅会影响当前协程的语言
$ret = I18N::getInstance()->setLanguage('En')->translate(Dictionary::GOOD_MORNING);
$res[] = $ret;
var_dump($ret); // string(15) "Hi,good morning"
$response->header('Content-Type', 'text/html;charset=utf-8');
$response->end(json_encode($res, JSON_UNESCAPED_UNICODE));
});
$http->start();
访问 http://localhost:9501/
(示例访问请求地址) 即可看到如下结果:["你好","GOOD_MORNING","你好 ! 欢迎到 主页 !!!!","Hi,good morning"]
在 EasySwoole 中使用
1. 定义语言包
新增如下文件:App\Languages\Dictionary.php
、App\Languages\Chinese.php
、App\Languages\English.php
内容如下:
<?php
namespace App\Languages;
use EasySwoole\I18N\AbstractDictionary;
// 定义一个词典。
// const 值请务必于 const 变量名一致,这样是避免用户手敲词条名称出错
class Dictionary extends AbstractDictionary
{
const HELLO = 'HELLO';
const GOOD_MORNING = 'GOOD_MORNING';
const HOME = 'HOME';
}
<?php
namespace App\Languages;
// 定义一个中文语言包
class Chinese extends Dictionary
{
const HELLO = '你好';
const GOOD_MORNING = '早上好';
const HOME = '主页';
}
<?php
namespace App\Languages;
// 定义一个英文语言包
class English extends Dictionary
{
const HELLO = 'hello';
const GOOD_MORNING = 'Hi,good morning';
const HOME = 'home page';
}
2. 注册语言包和注册默认语言
在项目根目录的 EasySwooleEvent.php
的 initialize
事件函数中进行注册。
调用示例代码如下:
<?php
namespace EasySwoole\EasySwoole;
use App\Languages\Chinese;
use App\Languages\English;
use EasySwoole\EasySwoole\AbstractInterface\Event;
use EasySwoole\EasySwoole\Swoole\EventRegister;
use EasySwoole\Http\Request;
use EasySwoole\Http\Response;
use EasySwoole\I18N\I18N;
class EasySwooleEvent implements Event
{
public static function initialize()
{
date_default_timezone_set('Asia/Shanghai');
// 注册语言包
I18N::getInstance()->addLanguage(new Chinese(), 'Cn');
I18N::getInstance()->addLanguage(new English(), 'En');
\EasySwoole\Component\Di::getInstance()->set(\EasySwoole\EasySwoole\SysConst::HTTP_GLOBAL_ON_REQUEST, function (Request $request, Response $response) {
// 获取 header 中 language 参数
$lang = $request->getHeader('language');
if (empty($lang)) {
$lang = 'Cn';
}
// 设置默认语言包
I18N::getInstance()->setDefaultLanguage($lang);
return true;
});
}
public static function mainServerCreate(EventRegister $register)
{
}
}
3. 在控制器中进行调用
<?php
namespace App\HttpController;
use App\Languages\Dictionary;
use EasySwoole\Http\AbstractInterface\Controller;
use EasySwoole\I18N\I18N;
class Index extends Controller
{
function index()
{
// 使用
$rets = [];
$ret = I18N::getInstance()->translate(Dictionary::HELLO);
$rets[] = $ret;
var_dump($ret); // 你好
$ret = I18N::getInstance()->translate(Dictionary::GOOD_MORNING);
$rets[] = $ret;
var_dump($ret); // GOOD_MORNING
$ret = I18N::getInstance()->sprintf('%s ! 欢迎到 %s !!!!', Dictionary::HELLO, Dictionary::HOME);
$rets[] = $ret;
var_dump($ret); // "你好 ! 欢迎到 主页 !!!!
// setLanguage 仅仅会影响当前协程的语言
$ret = I18N::getInstance()->setLanguage('En')->translate(Dictionary::GOOD_MORNING);
$rets[] = $ret;
var_dump($ret); // Hi,good morning
$this->writeJson(200, $rets, 'success!');
}
}
运行结果:访问 http://localhost:9501/
(示例访问地址) 即可看到如下结果:{"code":200,"result":["你好","早上好","你好 ! 欢迎到 主页 !!!!","Hi,good morning"],"msg":"success!"}
提示
- 可以在
EasySwoole
的 initialize 初始化事件 中做好语言包的注册和默认语言的注册。 - 可以在全局的 onRequest 事件,根据
header
或者是其他参数,调用setLanguage
方法修改当次请求的语言