Android XML解析

Android XML解析 (2012-04-23 17:27)
标签div  Android  hidden  分类: Android


在Android平台上可以使用Simple API for XML(SAX) 、 Document Object Model(DOM)和Android附带的pull解析器解析XML文件。

 

下面是本例子要解析的XML文件:

文件名称:itcast.xml


点击(此处)折叠或打开

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <persons>
  3. <person id="23">
  4. <name>李明</name>
  5. <age>30</age>
  6. </person>
  7. <person id="20">
  8. <name>李向梅</name>
  9. <age>25</age>
  10. </person>
  11. </persons>

例子定义了一个javabean用于存放上面解析出来的xml内容, 这个javabean为Person,代码:


点击(此处)折叠或打开

  1. public class Person {
  2.     private Integer id;
  3.     private String name;
  4.     private Short age;
  5.     public Integer getId() {
  6.         return id;
  7.     }
  8.     public void setId(Integer id) {
  9.         this.id = id;
  10.     }
  11.     public String getName() {
  12.         return name;
  13.     }
  14.     public void setName(String name) {
  15.         this.name = name;
  16.     }
  17.     public Short getAge() {
  18.         return age;
  19.     }
  20.     public void setAge(Short age) {
  21.         this.age = age;
  22.     }
  23. }

使用SAX读取XML文件

SAX是一个解析速度快并且占用内存少的xml解析器,非常适合用于Android等移动设备。 SAX解析XML文件采用的是事件驱动,也就是说,它并不需要解析完整个文档,在按内容顺序解析文档的过程中,SAX会判断当前读到的字符是否合法XML语法中的某部分,如果符合就会触发事件。所谓事件,其实就是一些回调(callback)方法,这些方法(事件)定义在ContentHandler接口。

下面是一些ContentHandler接口常用的方法:

  • startDocument()  当遇到文档的开头的时候,调用这个方法,可以在其中做一些预处理的工作。
  • endDocument()    和上面的方法相对应,当文档结束的时候,调用这个方法,可以在其中做一些善后的工作。 
  • startElement(String namespaceURI, String localName, String qName, Attributes atts)    当读到一个开始标签的时候,会触发这个方法。namespaceURI就是命名空间,localName是不带命名空间前缀的标签名,qName是带命名空间前缀的标签名。通过atts可以得到所有的属性名和相应的值。要注意的是SAX中一个重要的特点就是它的流式处理,当遇到一个标签的时候,它并不会纪录下以前所碰到的标签,也就是说,在startElement()方法中,所有你所知道的信息,就是标签的名字和属性,至于标签的嵌套结构,上层标签的名字,是否有子元属等等其它与结构相关的信息,都是不得而知的,都需要你的程序来完成。这使得SAX在编程处理上没有DOM来得那么方便。
  • endElement(String uri, String localName, String name)   这个方法和上面的方法相对应,在遇到结束标签的时候,调用这个方法。
  • characters(char[] ch, int start, int length)    这个方法用来处理在XML文件中读到的内容,第一个参数用于存放文件的内容,后面两个参数是读到的字符串在这个数组中的起始位置和长度,使用new String(ch,start,length)就可以获取内容。

解析itcast.xml触发的事件为:

读到的标签及内容       触发事件 

{文档开始}          startDocument() 

<persons>           startElement(, "persons", null, "{Attributes}")

"\n\t"              characters("<persons>...</persons>", "12", "2")

<person>            startElement(, "person", null, "{Attributes}")

"\n\t\t"            characters("<persons>...</persons>", "31", "3")

<name>              startElement(, "name", null, "{Attributes}")

"李明"              characters("<persons>...</persons>", "40", "2")

</name>             endElement("", "name", null)

"\n\t\t"            characters("<persons>...</persons>", "50", "3")

<age>               startElement(, "age", null, "{Attributes}")

"30"                characters("<persons>...</persons>", "58", "2")

</age>              endElement("", "age", null)

"\n\t"              characters("<persons>...</persons>", "67", "2")

</person>           endElement("", "person", null)

"\n\t"              characters("<persons>...</persons>", "79", "2")

<person>            startElement(, "person", null, "{Attributes}")

"\n\t\t"            characters("<persons>...</persons>", "98", "3")

<name>              startElement(, "name", null, "{Attributes}")

"李向梅"            characters("<persons>...</persons>", "107", "3")

</name>             endElement("", "name", null)

"\n\t\t"            characters("<persons>...</persons>", "118", "3")

<age>               startElement(, "age", null, "{Attributes}")

"25"                characters("<persons>...</persons>", "126", "2")

</age>              endElement("", "age", null)

"\n\t"              characters("<persons>...</persons>", "135", "2")

</person>           endElement("", "person", null)

"\n"                characters("<persons>...</persons>", "147", "1")

</persons>          endElement("", "persons", null)

{文档结束}          endDocument() 

只要为SAX提供实现ContentHandler接口的类,那么该类就可以得到通知事件(实际上就是SAX调用了该类中的回调方法)。因为ContentHandler是一个接口,在使用的时候可能会有些不方便,因此,SAX还为其制定了一个Helper类:DefaultHandler,它实现了这个接口,但是其所有的方法体都为空,在实现的时候,你只需要继承这个类,然后重载相应的方法即可。使用SAX解析itcast.xml的代码如下:


点击(此处)折叠或打开

  1. public static List<Person> readXML(InputStream inStream) {
  2.    try {
  3. SAXParserFactory spf = SAXParserFactory.newInstance();
  4. SAXParser saxParser = spf.newSAXParser(); //创建解析器
  5. //设置解析器的相关特性,http://xml.org/sax/features/namespaces = true 表示开启命名空间特性
  6. saxParser.setProperty("http://xml.org/sax/features/namespaces",true);
  7. XMLContentHandler handler = new XMLContentHandler();
  8. saxParser.parse(inStream, handler);
  9. inStream.close();
  10. return handler.getPersons();
  11.    } catch (Exception e) {
  12. e.printStackTrace();
  13.    }
  14.   return null;
  15. }
  16. import java.util.ArrayList;
  17. import java.util.List;
  18. import org.xml.sax.Attributes;
  19. import org.xml.sax.SAXException;
  20. import org.xml.sax.helpers.DefaultHandler;
  21. import cn.itcast.xml.domain.Person;
  22. public class XMLContentHandler extends DefaultHandler {
  23. private List<Person> persons = null;
  24. private Person currentPerson;
  25. private String tagName = null;//当前解析的元素标签
  26. public List<Person> getPersons() {
  27. return persons;
  28. }
  29. /*
  30. * 接收文档的开始的通知。
  31. */
  32. @Override public void startDocument() throws SAXException {
  33. persons = new ArrayList<Person>();
  34. }
  35. /*
  36. * 接收字符数据的通知。
  37. */
  38. @Override public void characters(char[] ch, int start, int length) throws SAXException {
  39. if(tagName!=null){
  40. String data = new String(ch, start, length);
  41. if(tagName.equals("name")){
  42. this.currentPerson.setName(data);
  43. }else if(tagName.equals("age")){
  44. this.currentPerson.setAge(Short.parseShort(data));
  45. }
  46. }
  47. }
  48. /*
  49. * 接收元素开始的通知。
  50. * 参数意义如下:
  51. * namespaceURI:元素的命名空间
  52. * localName :元素的本地名称(不带前缀)
  53. * qName :元素的限定名(带前缀)
  54. * atts :元素的属性集合
  55. */
  56. @Override public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException {
  57. if(localName.equals("person")){
  58. currentPerson = new Person();
  59. currentPerson.setId(Integer.parseInt(atts.getValue("id")));
  60. }
  61. this.tagName = localName;
  62. }
  63. /*
  64. * 接收文档的结尾的通知。
  65. * 参数意义如下:
  66. * uri :元素的命名空间
  67. * localName :元素的本地名称(不带前缀)
  68. * name :元素的限定名(带前缀)
  69. *
  70. */
  71. @Override public void endElement(String uri, String localName, String name) throws SAXException {
  72. if(localName.equals("person")){
  73. persons.add(currentPerson);
  74. currentPerson = null;
  75. }
  76. this.tagName = null;
  77. }
  78. }

使用DOM读取XML文件

除了可以使用 SAX解析XML文件,大家也可以使用熟悉的DOM来解析XML文件。 DOM解析XML文件时,会将XML文件的所有内容读取到内存中,然后允许您使用DOM API遍历XML树、检索所需的数据。使用DOM操作XML的代码看起来比较直观,并且,在某些方面比基于SAX的实现更加简单。但是,因为DOM需要将XML文件的所有内容读取到内存中,所以内存的消耗比较大,特别对于运行Android的移动设备来说,因为设备的资源比较宝贵,所以建议还是采用SAX来解析XML文件,当然,如果XML文件的内容比较小采用DOM是可行的。


点击(此处)折叠或打开

  1. import java.io.InputStream;
  2. import java.util.ArrayList;
  3. import java.util.List;
  4. import javax.xml.parsers.DocumentBuilder;
  5. import javax.xml.parsers.DocumentBuilderFactory;
  6. import org.w3c.dom.Document;
  7. import org.w3c.dom.Element;
  8. import org.w3c.dom.Node;
  9. import org.w3c.dom.NodeList;
  10. import cn.itcast.xml.domain.Person;
  11. /**
  12. * 使用Dom解析xml文件
  13. *
  14. */
  15. public class DomXMLReader {
  16. public static List<Person> readXML(InputStream inStream) {
  17. List<Person> persons = new ArrayList<Person>();
  18. DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
  19. try {
  20. DocumentBuilder builder = factory.newDocumentBuilder();
  21. Document dom = builder.parse(inStream);
  22. Element root = dom.getDocumentElement();
  23. NodeList items = root.getElementsByTagName("person");//查找所有person节点
  24. for (int i = 0; i < items.getLength(); i++) {
  25. Person person = new Person();
  26. //得到第一个person节点
  27. Element personNode = (Element) items.item(i);
  28. //获取person节点的id属性值
  29. person.setId(new Integer(personNode.getAttribute("id")));
  30. //获取person节点下的所有子节点(标签之间的空白节点和name/age元素)
  31. NodeList childsNodes = personNode.getChildNodes();
  32. for (int j = 0; j < childsNodes.getLength(); j++) {
  33. Node node = (Node) childsNodes.item(j); //判断是否为元素类型
  34. if(node.getNodeType() == Node.ELEMENT_NODE){ Element childNode = (Element) node;
  35.                                         //判断是否name元素
  36.    if ("name".equals(childNode.getNodeName())) {
  37.     //获取name元素下Text节点,然后从Text节点获取数据
  38.                                     person.setName(childNode.getFirstChild().getNodeValue());
  39.    } else if (“age”.equals(childNode.getNodeName())) {
  40.              person.setAge(new Short(childNode.getFirstChild().getNodeValue()));
  41.    }
  42. }
  43.        }
  44.    persons.add(person);
  45. }
  46. inStream.close();
  47. } catch (Exception e) {
  48. e.printStackTrace();
  49. }
  50. return persons;
  51. }

使用Pull解析器读取XML文件
除了可以使用 SAX和DOM解析XML文件,大家也可以使用Android内置的Pull解析器解析XML文件。 Pull解析器的运行方式与 SAX 解析器相似。它提供了类似的事件,如:开始元素和结束元素事件,使用parser.next()可以进入下一个元素并触发相应事件。事件将作为数值代码被发送,因此可以使用一个switch对感兴趣的事件进行处理。当元素开始解析时,调用parser.nextText()方法可以获取下一个Text类型元素的值。
Pull解析器的源码及文档下载网址:http://www.xmlpull.org/

点击(此处)折叠或打开

  1. import org.xmlpull.v1.XmlPullParser;
  2. import android.util.Xml;
  3. import cn.itcast.xml.domain.Person;
  4. public class PullXMLReader {
  5. public static List<Person> readXML(InputStream inStream) {
  6. XmlPullParser parser = Xml.newPullParser();
  7. try {
  8. parser.setInput(inStream, "UTF-8");
  9. int eventType = parser.getEventType();
  10. Person currentPerson = null;
  11. List<Person> persons = null;
  12. while (eventType != XmlPullParser.END_DOCUMENT) {
  13. switch (eventType) {
  14. case XmlPullParser.START_DOCUMENT://文档开始事件,可以进行数据初始化处理
  15. persons = new ArrayList<Person>();
  16. break;
  17. case XmlPullParser.START_TAG://开始元素事件
  18. String name = parser.getName();
  19. if (name.equalsIgnoreCase("person")) {
  20. currentPerson = new Person();
  21. currentPerson.setId(new Integer(parser.getAttributeValue(null, "id")));
  22. } else if (currentPerson != null) {
  23. if (name.equalsIgnoreCase("name")) {
  24. currentPerson.setName(parser.nextText());// 如果后面是Text元素,即返回它的值
  25. } else if (name.equalsIgnoreCase("age")) {
  26. currentPerson.setAge(new Short(parser.nextText()));
  27. }
  28. }
  29. break;
  30. case XmlPullParser.END_TAG://结束元素事件
  31. if (parser.getName().equalsIgnoreCase("person") && currentPerson != null) {
  32. persons.add(currentPerson);
  33. currentPerson = null;
  34. }
  35. break;
  36. }
  37. eventType = parser.next();
  38. }
  39. inStream.close();
  40. return persons;
  41. } catch (Exception e) {
  42. e.printStackTrace();
  43. }
  44. return null;
  45. }
  46. }

使用Pull解析器生成XML文件

有些时候,我们需要生成一个XML文件,生成XML文件的方法有很多,如:可以只使用一个StringBuilder组拼XML内容,然后把内容写入到文件中;或者使用DOM API生成XML文件,或者也可以使用pull解析器生成XML文件,这里推荐大家使用Pull解析器。

使用Pull解析器生成一个与itcast.xml文件内容相同的myitcast.xml文件。


点击(此处)折叠或打开

  1. public static String writeXML(List<Person> persons, Writer writer){
  2.     XmlSerializer serializer = Xml.newSerializer();
  3.     try {
  4.         serializer.setOutput(writer);
  5.         serializer.startDocument("UTF-8", true);
  6.       //第一个参数为命名空间,如果不使用命名空间,可以设置为null
  7.         serializer.startTag("", "persons");
  8.         for (Person person : persons){
  9.             serializer.startTag("", "person");
  10.             serializer.attribute("", "id", person.getId().toString());
  11.             serializer.startTag("", "name");
  12.             serializer.text(person.getName());
  13.             serializer.endTag("", "name");
  14.             serializer.startTag("", "age");
  15.             serializer.text(person.getAge().toString());
  16.             serializer.endTag("", "age");
  17.             serializer.endTag("", "person");
  18.         }
  19.         serializer.endTag("", "persons");
  20.         serializer.endDocument();
  21.         return writer.toString();
  22.     } catch (Exception e) {
  23.         e.printStackTrace();
  24.     }
  25.     return null;
  26. }

使用代码如下(生成XML文件):


点击(此处)折叠或打开

  1. File xmlFile = new File("myitcast.xml");
  2. FileOutputStream outStream = new FileOutputStream(xmlFile);
  3. OutputStreamWriter outStreamWriter = new OutputStreamWriter(outStream, "UTF-8");
  4. BufferedWriter writer = new BufferedWriter(outStreamWriter);
  5. writeXML(persons, writer);
  6. writer.flush();
  7. writer.close();

如果只想得到生成的xml内容,可以使用StringWriter:


点击(此处)折叠或打开

  1. StringWriter writer = new StringWriter();
  2. writeXML(persons, writer);
  3. String content = writer.toString();

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值