Cocos2d-x支持 i18n 国际化——概述及实现

Posted 2022-12-15 牧秦丶

【Cocos2d-x】支持 i18n 国际化（1）——概述及实现

---

转载请注明出处：http://blog.csdn.net/arnozhang12/article/details/49784277

1、概述

        使用过 Cocos2d-x 的同学都清楚，Cocos2d-x 内部字符串使用的是 UTF-8 编码格式。而我们在编写程序的时候，如果想要支持中文或韩文日文等其他语言文字的展示，就必须满足下面两个条件：

• 字符串的编码为 UTF-8；
• 所使用的 字体，必须能够显示该字符串。

        其中，第二条也是非常重要的，比如我们使用了一个英文字体去创建一个 Label 并展示一段中文，绘制出来的也是一堆乱码。

        在使用过程中，发现 Cocos2d-x 原生对于国际化的支持较弱，所以我结合以往的项目经验，吸收了其他平台的开发经验后，自己提出了一套解决方案，用于在自己的游戏项目中使用，觉得不错或者感兴趣的同学也可以拿去使用。

        一般来说，在一个正规项目中，要在 Cocos2d-x 中展示中文，有下面一些方法：

方法	优点	缺点	推荐程度
HardCode 在代码文件中 （代码文件必须保存为 UTF-8 格式）	书写方便	1、不提倡 HardCode 的代码编写风格； 2、无法支持多国语言的切换； 3、限制了源代码的文件保存格式。	极不提倡
通过函数转换为 UTF-8	可以将其他编码的字符串转换为 UTF-8	各种编码的转换函数需要自己编写，并且这些转换函数需要考虑到跨平台	不提倡
将字符串配置在 UTF-8 编码的资源文件中	1、灵活配置，改动字符串不需要改代码； 2、可以支持多国语言的灵活切换。	无	极其推荐

2、思路

        我同时也是一名 android 开发，在开发中通过对 Android 对于多语言支持的了解，我觉得 Android 开发提供的这种方式，很适合借鉴到 Cocos2d-x 中。

        其思路如下：

• 在 Cocos2d-x 的 Resources 文件夹下，建立 i18n 目录，用于存放游戏所支持的各个语言类别的字符串配置文件；
• 字符串资源文件按各个语言类别的 LanguageCode 进行区分，分别写在 UTF-8 编码的 strings-LanguageCode .xml 中；
• XML 文件中，每个字符串的组织形式为 <string name="key_xxx">content</string>；

        比如，我们的游戏同时支持简体中文和英文两种语言，那么资源文件的组织形式如下：

Resources
    |- i18n
    |    |- strings-ch.xml
    |    |- strings-en.xml
    |    |
    |
    |- ...
    |

        比如简体中文下，对应的 strings-ch.xml 文件内容如下：

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="app_name">射击场</string>
    <string name="start_game">开始游戏</string>
    <string name="exit_game">结束游戏</string>
    <string name="exit_comfirm_tips">确定要退出游戏吗？</string>
    <string name="cancel">取消</string>
    <string name="exit">结束</string>
    <string name="score">得分：</string>
</resources>

        而英文下，对应的 strings-en.xml 文件内容如下：

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="app_name">Shooting Range</string>
    <string name="start_game">Start Game</string>
    <string name="exit_game">Exit Game</string>
    <string name="exit_comfirm_tips">Exit Game Now?</string>
    <string name="cancel">Cancel</string>
    <string name="exit">Exit</string>
    <string name="score">Score : </string>
</resources>

3、XML 文件的选取

        既然我们已经有了这么多语种对应的配置文件了，我们必须能够让 Cocos2d-x 根据当前机器的语言类型，灵活选取到对应的 XML。比较幸运的是，Cocos2d-x 为我们提供了一个函数：Application::getInstance()->getCurrentLanguageCode() 来获取到当前的 LanguageCode，这样，我们就可以知道当前应该选取哪个配置文件了。

        关于 XML 的解析，Cocos2d-x 在 external 库中集成了 tinyxml2，通过这个库可以非常方便的进行 XML 的解析。我们知道，在 Android/PC/ios 上面，我们最终打包的资源文件在具体机器上存放的位置并不相同（Android 上是打包在 assets 里面，PC 上是放在 exe 相同的目录下），所以我们还需要使用 Cocos2d-x 提供的帮助方法：

• FileUtils::getInstance()->fullPathForFilename(name)： 来获取文件路径；
• FileUtils::getInstance()->isFileExist(path) ：判断文件是否存在；
• FileUtils::getInstance()->getDataFromFile(path)： 获取文件内容。

4、具体实现

        有了思路，那最后的实现也不过是分分钟的事情。具体代码片段如下：

//
// I18nInfo.cpp
//
void i18n::I18nInfo::loadInfo() 
    auto fileUtils = FileUtils::getInstance();
    auto fileName = StringUtils::format("i18n/strings-%s.xml", m_languageCode.c_str());
    auto file = fileUtils->fullPathForFilename(fileName);
    if (!fileUtils->isFileExist(file)) 
        return;
    

    Data data = fileUtils->getDataFromFile(file);
    if (data.isNull()) 
        return;
    

    tinyxml2::XMLDocument document;
    document.Parse(reinterpret_cast<const char*>(data.getBytes()), data.getSize());

    auto root = document.RootElement();
    if (!root) 
        return;
    

    auto node = root->FirstChildElement();
    while (node) 
        std::string name = node->Attribute("name");
        if (!name.empty()) 
            m_valueList[name] = node->GetText();
        

        node = node->NextSiblingElement();
    



//
// I18nManager.cpp
//
const std::string& i18n::I18nManager::getString(const std::string& name) 
    std::string code = Application::getInstance()->getCurrentLanguageCode();
    if (!m_pCurrI18nInfo || m_pCurrI18nInfo->isLanguage(code)) 
        auto iter = m_i18nList.find(code);
        if (iter != m_i18nList.end()) 
            m_pCurrI18nInfo = iter->second;
         else 
            I18nInfo* pInfo = new I18nInfo(code);
            m_i18nList[code] = pInfo;
            m_pCurrI18nInfo = pInfo;
        
    

    return m_pCurrI18nInfo->getString(name);


//
// i18n Utils
//
namespace i18n 

    const std::string& i18n::getString(const std::string& name) 
        return i18n::I18nManager::getInstance()->getString(name);
    

 // namespace i18n ends here.

5、具体的使用示例

        有了 i18n::getString() 这个全局帮助函数，我们就可以很方便的使用字符串了：

auto label = Label::create();
label->setString(i18n::getString("app_name"));
label->setTextColor(Color4b::RED);
label->setSystemFontSize(40);

// ...

layer->addChild(label);

        看起来这种使用方式极其简单。我们看到，获取一个字符串使用的是下面的方式：

i18n::getString(“app_name”)

        但是万一我们写错了 app_name 这个 key，岂不是拿不到具体的字符串了？并且我们万一改动了这个 key，岂不是代码里面的所有地方都需要修改？我们 下节 将通过一个 Python 脚本解析 strings-xx.xml，将所有的 key 解析出来组织在一个 .h 头文件中，这样就可以很方便的使用了。