Android中使用SAX方式解析XML
在Android开发中,XML是一种常见的数据交换格式,常用于接口返回数据、本地配置文件等场景。解析XML的方式有很多种,其中SAX(Simple API for XML)是一种基于事件驱动的解析方式,解析速度快、内存占用低,非常适合处理大体积的XML文件。本文将详细介绍SAX解析XML的原理、使用步骤以及完整代码示例。
SAX解析的核心原理
SAX解析属于流式解析,它不会像DOM解析那样把整个XML文档加载到内存中构建树形结构,而是按照XML文档的顺序逐行读取内容,遇到不同的节点或事件时触发对应的回调方法,开发者只需要在回调方法中处理自己需要的数据即可。整个解析过程只会遍历一次XML文档,内存占用非常小,适合移动端资源受限的场景。
SAX解析的核心类是DefaultHandler,它是SAX解析的事件处理器基类,我们需要继承这个类并重写其中的关键回调方法,来实现自己的解析逻辑。
SAX解析的关键回调方法
继承DefaultHandler后,通常需要重写以下几个核心方法:
- startDocument():开始解析XML文档时触发,一般在这里做一些初始化工作,比如初始化存储解析结果的集合。
- startElement(String uri, String localName, String qName, Attributes attributes):遇到XML开始标签时触发,localName是标签的本地名称,attributes可以获取标签的属性值。
- characters(char[] ch, int start, int length):解析到标签内的文本内容时触发,ch是存放内容的字符数组,通过start和length可以截取对应的文本。
- endElement(String uri, String localName, String qName):遇到XML结束标签时触发,一般在这里完成一个完整节点的数据封装。
- endDocument():整个XML文档解析完成时触发,一般在这里做收尾工作,比如返回解析结果。
完整示例:解析本地XML文件
下面我们通过一个完整的示例来演示SAX解析的使用,假设我们要解析一个存放在Android项目assets目录下的学生信息XML文件,文件内容如下:
<?xml version="1.0" encoding="utf-8"?>
<students>
<student id="1">
<name>张三</name>
<age>20</age>
<major>计算机科学与技术</major>
</student>
<student id="2">
<name>李四</name>
<age>21</age>
<major>软件工程</major>
</student>
<student id="3">
<name>王五</name>
<age>19</age>
<major>人工智能</major>
</student>
</students>步骤1:定义学生实体类
首先需要一个实体类来封装解析出来的学生信息:
public class Student {
private int id;
private String name;
private int age;
private String major;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public String getMajor() {
return major;
}
public void setMajor(String major) {
this.major = major;
}
@Override
public String toString() {
return "Student{id=" + id + ", name='" + name + "', age=" + age + ", major='" + major + "'}";
}
}步骤2:自定义SAX解析处理器
继承DefaultHandler,重写对应的回调方法,实现解析逻辑:
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import java.util.ArrayList;
import java.util.List;
public class StudentSaxHandler extends DefaultHandler {
// 存储所有解析出的学生对象
private List<Student> studentList;
// 当前正在解析的学生对象
private Student currentStudent;
// 记录当前解析到的标签名
private String currentTagName;
// 临时存储标签内的文本内容
private StringBuilder tempContent;
public List<Student> getStudentList() {
return studentList;
}
@Override
public void startDocument() throws SAXException {
super.startDocument();
// 初始化集合和临时容器
studentList = new ArrayList<>();
tempContent = new StringBuilder();
}
@Override
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
super.startElement(uri, localName, qName, attributes);
// 清空临时文本内容,避免上一次的内容影响本次解析
tempContent.setLength(0);
if ("student".equals(localName)) {
// 遇到student开始标签,创建新的学生对象
currentStudent = new Student();
// 获取id属性值
String idStr = attributes.getValue("id");
if (idStr != null) {
currentStudent.setId(Integer.parseInt(idStr));
}
} else if ("name".equals(localName) || "age".equals(localName) || "major".equals(localName)) {
// 记录当前解析的标签名,方便在characters方法中处理内容
currentTagName = localName;
}
}
@Override
public void characters(char[] ch, int start, int length) throws SAXException {
super.characters(ch, start, length);
// 将标签内的文本内容追加到临时容器中
tempContent.append(ch, start, length);
}
@Override
public void endElement(String uri, String localName, String qName) throws SAXException {
super.endElement(uri, localName, qName);
if ("student".equals(localName)) {
// 遇到student结束标签,将当前学生对象加入集合
studentList.add(currentStudent);
currentStudent = null;
} else if ("name".equals(localName)) {
// 设置学生姓名,需要先去掉可能的空白字符
if (currentStudent != null) {
currentStudent.setName(tempContent.toString().trim());
}
} else if ("age".equals(localName)) {
// 设置学生年龄
if (currentStudent != null) {
String ageStr = tempContent.toString().trim();
if (!ageStr.isEmpty()) {
currentStudent.setAge(Integer.parseInt(ageStr));
}
}
} else if ("major".equals(localName)) {
// 设置学生专业
if (currentStudent != null) {
currentStudent.setMajor(tempContent.toString().trim());
}
}
// 清空当前标签名
currentTagName = null;
}
@Override
public void endDocument() throws SAXException {
super.endDocument();
// 解析完成,可以做一些收尾操作
}
}步骤3:调用SAX解析方法
在Activity中读取assets目录下的XML文件,调用SAX解析器完成解析:
import android.content.res.AssetManager;
import android.os.Bundle;
import android.util.Log;
import androidx.appcompat.app.AppCompatActivity;
import org.xml.sax.InputSource;
import org.xml.sax.XMLReader;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import java.io.InputStream;
import java.util.List;
public class MainActivity extends AppCompatActivity {
private static final String TAG = "SAX_PARSE_DEMO";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// 执行解析
parseXmlWithSax();
}
private void parseXmlWithSax() {
try {
// 获取AssetManager,读取assets目录下的students.xml文件
AssetManager assetManager = getAssets();
InputStream inputStream = assetManager.open("students.xml");
// 创建SAX解析器工厂
SAXParserFactory factory = SAXParserFactory.newInstance();
// 获取SAX解析器
SAXParser parser = factory.newSAXParser();
// 获取XMLReader
XMLReader xmlReader = parser.getXMLReader();
// 创建自定义的事件处理器
StudentSaxHandler handler = new StudentSaxHandler();
// 设置处理器
xmlReader.setContentHandler(handler);
// 开始解析,传入输入源
xmlReader.parse(new InputSource(inputStream));
// 获取解析结果
List<Student> studentList = handler.getStudentList();
// 打印解析结果
for (Student student : studentList) {
Log.d(TAG, student.toString());
}
// 关闭输入流
inputStream.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}SAX解析的注意事项
1. characters方法可能会被多次调用:比如标签内的文本内容包含换行、空格时,SAX可能会分多次触发characters方法,所以需要用StringBuilder来累积内容,而不是每次直接赋值。
2. 空白字符处理:XML中的换行、缩进等空白字符也会被解析为文本内容,所以在获取标签内文本后,通常需要调用trim()方法去掉前后空白。
3. 标签匹配:判断标签名时建议使用localName而不是qName,localName是去掉命名空间前缀的标签名,更通用。
4. 内存释放:解析完成后记得关闭输入流,避免资源泄漏。
SAX解析的适用场景
SAX解析适合处理大体积的XML文件,或者内存受限的移动端场景。如果XML文件体积很小,且需要频繁修改解析后的数据,也可以考虑使用DOM解析;如果需要更简洁的解析方式,也可以考虑Pull解析,它是Android内置的另一种事件驱动解析方式,使用起来比SAX更灵活。
Android_SAX解析XML解析DefaultHandler移动端性能事件驱动 本作品最后修改时间:2026-05-22 21:20:36