cocos2d-x android 解析XML出错

在使用 cocos2d-x 进行 Android 开发时，解析 XML 可能会遇到问题。下面将分享我在项目中遇到该问题时的解决办法。

解决方案概述

有两种可行的解决方案：

1. 使用 iconv 库：cocos2d-x 引擎提供了 iconv 库，但仅支持 win32 平台。若要在 Android 上使用，需要自行下载并编译 iconv 库。
2. 将字符串写入 XML 文件并解析：按照 Android 中的 strings.xml 格式编写 XML 文件，然后进行解析。这种方法在需要提供国际化支持时尤为适用。

我个人更倾向于第二种方法，原因在于我之前开发 Android app 时学习过 SAX 解析 XML，对这种方式比较熟悉。

SAX 解析 XML 简介

SAX（Simple API for XML）是一种高效且快速的 XML 解析方法。它逐行扫描文档，并在扫描过程中进行解析。cocos2d-x 引擎提供了 SAXParser 类来实现 XML 解析。

SAXParser 类

以下是 SAXParser 类的定义：

class CC_DLL SAXParser
{
SAXDelegator*    _delegator;
public:
SAXParser();
~SAXParser(void);
bool init(const char *encoding);
// 解析 xml
bool parse(const char* xmlData, size_t dataLength);
bool parse(const std::string& filename);
// 需要设置 setDelegator
void setDelegator(SAXDelegator* delegator);

// 解析的方法，需要重写下面三个方法
// 开始一个节点
static void startElement(void *ctx, const CC_XML_CHAR *name, const CC_XML_CHAR **atts);
// 结束一个节点
static void endElement(void *ctx, const CC_XML_CHAR *name);
// 节点之间的文本
static void textHandler(void *ctx, const CC_XML_CHAR *name, int len);
};

SAXDelegator 类

在使用 SAXParser 时，需要设置 Delegator。SAXDelegator 类的定义如下，需要重写其中的三个方法：

class CC_DLL SAXDelegator
{
public:
virtual ~SAXDelegator() {}
virtual void startElement(void *ctx, const char *name, const char **atts) = 0;
virtual void endElement(void *ctx, const char *name) = 0;
virtual void textHandler(void *ctx, const char *s, int len) = 0;
};

自定义 XMLParser 类

接下来，我们根据 XML 的格式封装一个自定义的 XMLParser 类。假设要解析的 strings.xml 文件内容如下：

<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="app_name">小黄人大作战</string>
<string name="exit_dialog_title">提醒</string>
<string name="exit_dialog_text">你确定退出吗？</string>
<string name="exit_dialog_btn_yes">确定</string>
<string name="exit_dialog_text_no">返回</string>
</resources>

XMLParser 类的定义

#pragma once

#include <string>
#include "cocos2d.h"

class XMLParser : public cocos2d::Ref, public cocos2d::SAXDelegator
{
public:
static XMLParser* parseWithFile(const char *xmlFileName);
static XMLParser* parseWithString(const char *content);

XMLParser();
virtual ~XMLParser();

// 从本地 xml 文件读取
bool initWithFile(const char *xmlFileName);
// 从字符中读取，可用于读取网络中的 xml 数据
bool initWithString(const char *content);

// 对应 xml 标签开始,如：<string name="app_name">
virtual void startElement(void *ctx, const char *name, const char **atts);
// 对应 xml 标签结束,如：</string>
virtual void endElement(void *ctx, const char *name);
// 对应 xml 标签文本
virtual void textHandler(void *ctx, const char *s, int len);

cocos2d::CCString* getString(const char *key);

private:
cocos2d::CCDictionary *m_pDictionary;
std::string m_key;
std::string startXMLElement;
std::string endXMLElement;
};

XMLParser 类的实现

#include "XMLParser.h"
using namespace std;
using namespace cocos2d;

// 字符 ascii 码
// 空格
const static int SPACE = 32;
// 换行
const static int NEXTLINE = 10;
// tab 横向制表符
const static int TAB = 9;

XMLParser* XMLParser::parseWithFile(const char *xmlFileName)
{
XMLParser *pXMLParser = new XMLParser();
if (pXMLParser->initWithFile(xmlFileName))
{
pXMLParser->autorelease();
return pXMLParser;
}
CC_SAFE_DELETE(pXMLParser);
return NULL;
}

bool XMLParser::initWithFile(const char *xmlFileName)
{
m_pDictionary = new CCDictionary();
SAXParser _parser;
_parser.setDelegator(this);
// 获取文件全路径
string fullPath = FileUtils::getInstance()->fullPathForFilename(xmlFileName);
CCLog("xml parser full path : %s", fullPath.c_str());
return _parser.parse(fullPath);
}

XMLParser* XMLParser::parseWithString(const char *content)
{
XMLParser *pXMLParser = new XMLParser();
if (pXMLParser->initWithString(content))
{
pXMLParser->autorelease();
return pXMLParser;
}
CC_SAFE_DELETE(pXMLParser);
return NULL;
}

bool XMLParser::initWithString(const char *content)
{
m_pDictionary = new CCDictionary();
SAXParser _parse;
_parse.setDelegator(this);
return _parse.parse(content, strlen(content));
}

// 开始一个节点
// 比如<string name="app_name">小黄人大作战</string>
// name    为     :string
// atts[0] 为属性   : name
// atts[1] 为值       : app_name
// atts[2] 以此类推
void XMLParser::startElement(void *ctx, const char *name, const char **atts)
{
this->startXMLElement = (char *)name;
CCLog("start=%s", startXMLElement.c_str());// name

if (this->startXMLElement == "string")
{
while (atts && *atts)
{
CCLog("attrs0=%s", atts[0]);    // atts[0] : name
CCLog("attrs1=%s", atts[1]);    // atts[1] : app_name

const char *attsKey = *atts;
if (0 == strcmp(attsKey, "name"))
{
++atts;
const char *attsValue = *atts;
m_key = attsValue;          // key
break;
}
++atts;
}
}
}

void XMLParser::endElement(void *ctx, const char *name)
{
this->endXMLElement = (char *)name;
CCLog("end=%s", endXMLElement.c_str());
}

void XMLParser::textHandler(void *ctx, const char *s, int len)
{
string value((char *)s, 0, len);

// 是否全是非正常字符
bool noValue = true;
for (int i = 0; i < len; ++i)
{
if (s[i] != SPACE && s[i] != NEXTLINE && s[i] != TAB)
{
noValue = false;
break;
}
}
if (noValue) return;
String *pString = String::create(value);
CCLog("key=%s value=%s", m_key.c_str(), pString->getCString());
this->m_pDictionary->setObject(pString, this->m_key);
}

String* XMLParser::getString(const char *key)
{
string strKey(key);
return (String *)this->m_pDictionary->objectForKey(strKey);
}

XMLParser::XMLParser()
{
}

XMLParser::~XMLParser()
{
CC_SAFE_DELETE(this->m_pDictionary);
}

使用示例

使用自定义的 XMLParser 类进行 XML 解析非常简单，示例代码如下：

XMLParser *pXmlParser = XMLParser::parseWithFile("strings.xml");
String *pTitle = pXmlParser->getString("exit_dialog_title");

通过以上步骤，cocos2d-x Android 解析 XML 出错的问题就可以得到解决，大家可以参考此方法进行开发。