Android笔记系列--XML文件操作

源码:
https://github.com/StarsAaron/DataParseDemo/tree/master

Android中获取XML文件

1) 在res/xml目录下(推荐使用)

XmlResourceParser xmlParser = this.getResources().getXml(R.xml.XXX); 

2) 在res/xml、res/raw目录下

InputStream inputStream = this.getResources().openRawResource(R.xml.XXX); 

3) 在assets文件夹下
(本人测试发现通过此方法获取的XML文档不能带有首行:
<?xml version="1.0" encoding="utf-8"?>
否则解析报错,具体原因未查明,知道原因请回复交流):

InputStream inputStream = getResources().getAssets().open(fileName); 

4) 在应用指定目录下(SDcard,应用data目录等)

// path路径根据实际项目修改,此次获取SDcard根目录 
String path = Environment.getExternalStorageDirectory().toString(); 
File xmlFlie = new File(path+fileName); 
InputStream inputStream = new FileInputStream(xmlFlie); 

XML文件解析

使用SAX解析器

采用SAX解析时具体处理步骤是:
1. 创建SAXParserFactory对象
2. 根据SAXParserFactory.newSAXParser()方法返回一个SAXParser析器
3. 根据SAXParser解析器获取事件源对象XMLReader
4. 实例化一个DefaultHandler对象
5. 连接事件源对象XMLReader到事件处理类DefaultHandler中
6. 调用XMLReader的parse方法从输入源中获取到的xml数据
7. 通过DefaultHandler返回我们需要的数据集合。

SaxBookParser.java代码如下:

---- 解析xml 

@Override
    public List<Book> parse(InputStream in) throws Exception {
        SAXParserFactory saxParserFactory = SAXParserFactory.newInstance();
        SAXParser saxParser = saxParserFactory.newSAXParser();
        MyHandler myHandler = new MyHandler(); // 实例化自定义Handler
        saxParser.parse(in, myHandler);
        return myHandler.getBookList();
    } 

    // 需要重写DefaultHandler的方法
    private class MyHandler extends DefaultHandler {
        private List<Book> booksList;
        private Book book;
        private StringBuilder builder;
        public List<Book> getBookList() {
            return booksList;
        }
        @Override
        public void startDocument() throws SAXException {
            super.startDocument();
            booksList = new ArrayList<Book>();
            builder = new StringBuilder();
        }
        @Override
        public void endDocument() throws SAXException {
            super.endDocument();
        }
        @Override
        public void startElement(String uri, String localName, String qName, Attributes attributes)
                throws SAXException {
            super.startElement(uri, localName, qName, attributes);
            if (localName.equals("book")) {
                book = new Book();
            }
            builder.setLength(0);// 将字符长度设置为0 以便重新开始读取元素内的字符节点
        }
        @Override
        public void endElement(String uri, String localName, String qName) throws SAXException {
            super.endElement(uri, localName, qName);
            if (localName.equals("id")) {
                book.setId(Integer.parseInt(builder.toString()));
            } else if (localName.equals("name")) {
                book.setName(builder.toString());
            } else if (localName.equals("price")) {
                book.setPrice(Float.parseFloat(builder.toString()));
            } else if (localName.equals("book")) {
                booksList.add(book);
            }
        }
        @Override
        public void characters(char[] ch, int start, int length) throws SAXException {
            super.characters(ch, start, length);
            builder.append(ch, start, length);
        }
    } 

---- 生成xml 

@Override
public String serialize(List<Book> booksList) throwsException {
    SAXTransformerFactory factory = (SAXTransformerFactory)   TransformerFactory.newInstance();// 取得SAXTransformerFactory实例
    TransformerHandler handler = factory.newTransformerHandler(); // 从factory获取TransformerHandler实例
    Transformer transformer = handler.getTransformer(); // 从handler获取Transformer实例
    transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8"); // 设置输出采用的编码方式
    transformer.setOutputProperty(OutputKeys.INDENT, "yes"); // 是否自动添加额外的空白
    transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no"); // 是否忽略XML声明
    StringWriter writer = new StringWriter();
    Result result = new StreamResult(writer);
    handler.setResult(result);
    String uri = ""; // 代表命名空间的URI 当URI无值时 须置为空字符串
    String localName = ""; // 命名空间的本地名称(不包含前缀) 当没有进行命名空间处理时 须置为空字符串
    handler.startDocument();
    handler.startElement(uri, localName, "books", null);
    AttributesImpl attrs = new AttributesImpl(); // 负责存放元素的属性信息
    char[] ch = null;
    for (Book book : booksList) {
        attrs.clear(); // 清空属性列表
        attrs.addAttribute(uri, localName, "id", "string", String.valueOf(book.getId()));// 添加一个名为id的属性(type影响不大,这里设为string)
        handler.startElement(uri, localName, "book", attrs); // 开始一个book元素关联上面设定的id属性
        handler.startElement(uri, localName, "name", null); // 开始一个name元素
        ch = String.valueOf(book.getName()).toCharArray();
        handler.characters(ch, 0, ch.length); // 设置name元素的文本节点
        handler.endElement(uri, localName, "name");
        handler.startElement(uri, localName, "price", null);// 开始一个price元素
        ch = String.valueOf(book.getPrice()).toCharArray();
        handler.characters(ch, 0, ch.length); // 设置price元素的文本节点
        handler.endElement(uri, localName, "price");
        handler.endElement(uri, localName, "book");
    }
    handler.endElement(uri, localName, "books");
    handler.endDocument();
    return writer.toString();
}

使用DOM解析器

采用DOM解析时具体处理步骤是:
1. 首先利用DocumentBuilderFactory创建一D.ocumentBuilderFactory实例
2. 然后利用DocumentBuilderFactory创建DocumentBuilder
3. 然后加载XML文档(Document),
4. 然后获取文档的根结点(Element),
5. 然后获取根结点中所有子节点的列表(NodeList)
6. 然后使用再获取子节点列表中的需要读取的结点。

DomBookParser.java代码如下:

---- 解析xml

@Override
public List<Book> parse(InputStream in) throws Exception {
    List<Book> booksList = new ArrayList<Book>();
    DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
    DocumentBuilder builder = factory.newDocumentBuilder();
    Document doc = builder.parse(in); // 解析输入流 得到Document实例
    Element rootElement = doc.getDocumentElement();
    NodeList items = rootElement.getElementsByTagName("book");
    for (int i = 0; i < items.getLength(); i++) {
        Book book = new Book();
        Node item = items.item(i);
        NodeList properties = item.getChildNodes();
        for (int j = 0; j < properties.getLength(); j++) {
            Node property = properties.item(j);
            String nodeName = property.getNodeName();
            if (nodeName.equals("id")) {
                book.setId(Integer.parseInt(property.getFirstChild().getNodeValue()));
            } else if (nodeName.equals("name")) {
                book.setName(property.getFirstChild().getNodeValue());
            } else if (nodeName.equals("price")) {
                book.setPrice(Float.parseFloat(property.getFirstChild().getNodeValue()));
            }
        }
        booksList.add(book);
    }
    return booksList;
}
---- 生成xml
@Override
public String serialize(List<Book> booksList) throwsException {
    DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
    DocumentBuilder builder = null;
    builder = factory.newDocumentBuilder();
    Document doc = builder.newDocument(); // 由builder创建新文档
    Element rootElement = doc.createElement("books");
    for (Book book : booksList) {
        Element bookElement = doc.createElement("book");
        bookElement.setAttribute("id", book.getId() + "");
        Element nameElement = doc.createElement("name");
        nameElement.setTextContent(book.getName());
        bookElement.appendChild(nameElement);
        Element priceElement = doc.createElement("price");
        priceElement.setTextContent(book.getPrice() + "");
        bookElement.appendChild(priceElement);
        rootElement.appendChild(bookElement);
    }
    doc.appendChild(rootElement);
    TransformerFactory transFactory = TransformerFactory.newInstance();// 取得TransformerFactory实例
    Transformer transformer = null;
    transformer = transFactory.newTransformer();// 从transFactory获取Transformer实例
    transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8"); // 设置输出采用的编码方式
    transformer.setOutputProperty(OutputKeys.INDENT, "yes"); // 是否自动添加额外的空白
    transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no"); // 是否忽略XML声明
    StringWriter writer = new StringWriter();
    Source source = new DOMSource(doc); // 表明文档来源是doc
    Result result = new StreamResult(writer);// 表明目标结果为writer
    transformer.transform(source, result);// 开始转换
    return writer.toString();
} 

使用PULL解析器

采用PULL解析基本处理方式:

当PULL解析器导航到文档开始标签时就开始实例化list集合用来存贮数据对象。导航到元素开始标签时回判断元素标签类型,如果是river标签,则需要实例化River对象了,如果是其他类型,则取得该标签内容并赋予River对象。当然它也会导航到文本标签,不过在这里,我们可以不用。

根据以上的解释,我们可以得出以下处理xml文档逻辑:

  1. 当导航到XmlPullParser.START_DOCUMENT,可以不做处理,当然你可以实例化集合对象等等。
  2. 当导航到XmlPullParser.START_TAG,则判断是否是river标签,如果是,则实例化river对象,并调用getAttributeValue方法获取标签中属性值。
  3. 当导航到其他标签,比如Introduction时候,则判断river对象是否为空,如不为空,则取出Introduction中的内容,nextText方法来获取文本节点内容
  4. 当然啦,它一定会导航到XmlPullParser.END_TAG的,有开始就要有结束嘛。在这里我们就需要判读是否是river结束标签,如果是,则把river对象存进list集合中了,并设置river对象为null.

由以上的处理逻辑,我们可以得出以下代码:

PullBookParser.java代码如下:

---- 解析xml
@Override
    public List<Book> parse(InputStream in) throws Exception {
        List<Book> books = null;
        Book book = null;
        // XmlPullParserFactory factory = XmlPullParserFactory.newInstance();
        // XmlPullParser parser = factory.newPullParser();
        XmlPullParser parser = Xml.newPullParser(); // 由android.util.Xml创建一个XmlPullParser实例
        parser.setInput(in, "UTF-8"); // 设置输入流 并指明编码方式
        int eventType = parser.getEventType();
        while (eventType != XmlPullParser.END_DOCUMENT) {
            switch (eventType) {
            case XmlPullParser.START_DOCUMENT:
                books = new ArrayList<Book>();
                break;
            case XmlPullParser.START_TAG:
                if (parser.getName().equals("book")) {
                    book = new Book();
                } else if (parser.getName().equals("id")) {
                    eventType = parser.next();
                    book.setId(Integer.parseInt(parser.getText()));
                } else if (parser.getName().equals("name")) {
                    eventType = parser.next();
                    book.setName(parser.getText());
                } else if (parser.getName().equals("price")) {
                    eventType = parser.next();
                    book.setPrice(Float.parseFloat(parser.getText()));
                }
                break;
            case XmlPullParser.END_TAG:
                if (parser.getName().equals("book")) {
                    books.add(book);
                    book = null;
                }
                break;
            }
            eventType = parser.next();
        }
        return books;
    }

---- 生成xml
@Override
    public String serialize(List<Book> booksList) throws Exception {
//      XmlPullParserFactory factory = XmlPullParserFactory.newInstance(); 
//      XmlSerializer serializer = factory.newSerializer(); 

        XmlSerializer serializer = Xml.newSerializer(); //由android.util.Xml创建一个XmlSerializer实例 
        StringWriter writer = new StringWriter(); 
        serializer.setOutput(writer);   //设置输出方向为writer 
        serializer.startDocument("UTF-8", true); 
        serializer.startTag("", "books"); 
        for (Book book : booksList) { 
            serializer.startTag("", "book"); 
            serializer.attribute("", "id", book.getId() + ""); 

            serializer.startTag("", "name"); 
            serializer.text(book.getName()); 
            serializer.endTag("", "name"); 

            serializer.startTag("", "price"); 
            serializer.text(book.getPrice() + ""); 
            serializer.endTag("", "price"); 

            serializer.endTag("", "book"); 
        } 
        serializer.endTag("", "books"); 
        serializer.endDocument(); 

        return writer.toString(); 
    }  

对于这三种解析器各有优点,我个人比较倾向于PULL解析器,因为SAX解析器操作起来太笨重,DOM不适合文档较大,内存较小的场景,唯有PULL轻巧灵活,速度快,占用内存小,使用非常顺手。读者也可以根据自己的喜好选择相应的解析技术。

xml文件操作 public class XmlUtils { /** * 获取Document对象。根据xml文件的名字获取Document对象。 * * @param file * 要获取对象的xml文件全路径。 * @return 返回获取到的Document对象。 * @throws IOException * 如果发生任何 IO 错误时抛出此异常。 * @throws SAXException * 如果发生任何解析错误时抛出此异常。 * @throws ParserConfigurationException * 如果无法创建满足所请求配置的 DocumentBuilder,将抛出该异常。 * @exception NullPointerException * 如果file为空时,抛出此异常。 */ public static Document parseForDoc(final String file) throws SAXException, IOException, SecurityException, NullPointerException, ParserConfigurationException { return XmlUtils.parseForDoc(new FileInputStream(file)); } /** * 将一个xml字符串解析成Document对象。 * * @param xmlStr * 要被解析的xml字符串。 * @param encoding * 字符串的编码。 * @return 返回解析后的Document对象。 * @throws IOException * 如果发生任何 IO 错误时抛出此异常。 * @throws SAXException * 如果发生任何解析错误时抛出此异常。 * @throws ParserConfigurationException * 如果无法创建满足所请求配置的 DocumentBuilder,将抛出该异常。 */ public static Document parseForDoc(String xmlStr, String encoding) throws SAXException, IOException, ParserConfigurationException { if (xmlStr == null) { xmlStr = ""; } ByteArrayInputStream byteInputStream = new ByteArrayInputStream( xmlStr.getBytes(encoding)); return XmlUtils.parseForDoc(byteInputStream); } /** * 获取Document对象。根据字节输入流获取一个Document对象。 * * @param is * 获取对象的字节输入流。 * @return 返回获取到的Document对象。如果出现异常,返回null。 * @throws IOException * 如果发生任何 IO 错误时抛出此异常。 * @throws SAXException * 如果发生任何解析错误时抛出此异常。 * @throws ParserConfigurationException * 如果无法创建满足所请求配置的 DocumentBuilder,将抛出该异常。 * @exception IllegalArgumentException * 当 is 为 null 时抛出此异常。 */ public static Document parseForDoc(final InputStream is) throws SAXException, IOException, ParserConfigurationException, IllegalArgumentException { try { DocumentBuilderFactory factory = DocumentBuilderFactory .newInstance(); DocumentBuilder builder = factory.newDocumentBuilder(); return builder.parse(is); } finally { is.close(); } } /** * 通过xpath表达式解析某个xml节点。 * * @param obj * 要被解析的xml节点对象。 * @param xPath * xpath表达式。 * @param qName * 被解析的目标类型。 * @return 返回解析后的对象。 * @throws XPathExpressionException * 如果不能计算 expression。 * * @exception RuntimeException * 创建默认对象模型的 XPathFactory 遇到故障时。 * @exception NullPointerException * 如果xPath为空时抛出时异常。 */ private static Object parseByXpath(final Object obj, final String xPath, QName qName) throws NullPointerException, RuntimeException, XPathExpressionException { XPathFactory xpathFactory = XPathFactory.newInstance(); XPath path = xpathFactory.newXPath(); return path.evaluate(xPath, obj, qName); } /** * 通过XPath表达式获取单个节点。 * * @param obj * 要被解析的對象。 * @param xPath * XPath表达式。 * @return 返回获取到的节点。 * * @throws XPathExpressionException * 如果不能计算 expression。 * * @exception RuntimeException * 创建默认对象模型的 XPathFactory 遇到故障时。 * @exception NullPointerException * 如果xPath为空时抛出时异常。 */ public static Node parseForNode(final Object obj, final String xPath) throws NullPointerException, RuntimeException, XPathExpressionException { return (Node) XmlUtils.parseByXpath(obj, xPath, XPathConstants.NODE); } /** * 通过XPath表达式获取某个xml节点的字符串值。 * * @param obj * 要被解析的對象。 * @param xPath * XPath表达式。 * @return 返回获取到的节点的字符串值。 * * @throws XPathExpressionException * 如果不能计算 expression。 * * @exception RuntimeException * 创建默认对象模型的 XPathFactory 遇到故障时。 * @exception NullPointerException * 如果xPath为空时抛出时异常。 */ public static String parseForString(final Object obj, final String xPath) throws NullPointerException, RuntimeException, XPathExpressionException { return (String) XmlUtils .parseByXpath(obj, xPath, XPathConstants.STRING); } /** * 通过XPath表达式获取某个xml节点的布尔值。 * * @param obj * 要被解析的對象。 * @param xPath * XPath表达式。 * @return 返回获取到的节点的布尔值。 * * @throws XPathExpressionException * 如果不能计算 expression。 * * @exception RuntimeException * 创建默认对象模型的 XPathFactory 遇到故障时。 * @exception NullPointerException * 如果xPath为空时抛出时异常。 */ public static Boolean parseForBoolean(final Object obj, final String xPath) throws NullPointerException, RuntimeException, XPathExpressionException { return (Boolean) XmlUtils.parseByXpath(obj, xPath, XPathConstants.BOOLEAN); } /** * 通过XPath表达式获取Node列表。 * * @param obj * 要被解析的對象。 * @param xPath * XPath表达式。 * @return 返回获取到的Node列表。 * * @throws XPathExpressionException * 如果不能计算 expression。 * * @exception RuntimeException * 创建默认对象模型的 XPathFactory 遇到故障时。 * @exception NullPointerException * 如果xPath为空时抛出时异常。 */ public static List parseForNodeList(final Object obj, final String xPath) throws NullPointerException, RuntimeException, XPathExpressionException { List lists = new ArrayList(); NodeList nList = (NodeList) XmlUtils.parseByXpath(obj, xPath, XPathConstants.NODESET); if (nList != null) { for (int i = 0; i < nList.getLength(); i++) { lists.add(nList.item(i)); } } return lists; } /** * 获取节点的制定属性。 * * @param node * 节点。 * @param attrName * 属性名。 * @return 返回获取到的属性值。如果找不到相关的 * */ public static String getAttribute(final Object node, final String attrName) { String result = ""; if ((node != null) && (node instanceof Node)) { if (((Node) node).getNodeType() == Node.ELEMENT_NODE) { result = ((Element) node).getAttribute(attrName); } else { // 遍历整个xml某节点指定的属性 NamedNodeMap attrs = ((Node) node).getAttributes(); if ((attrs.getLength() > 0) && (attrs != null)) { Node attr = attrs.getNamedItem(attrName); result = attr.getNodeValue(); } } } return result; } /** * 使用新节点替换原来的旧节点。 * * @param oldNode * 要被替换的旧节点。 * @param newNode * * 替换后的新节点。 * @exception DOMException * 如果此节点为不允许 * newNode节点类型的子节点的类型;或者如果要放入的节点为此节点的一个祖先或此节点本身;或者如果此节点为 * Document 类型且替换操作的结果将第二个 DocumentType 或 Element 添加到 * Document 上。 WRONG_DOCUMENT_ERR: 如果 newChild * 是从不同的文档创建的,不是从创建此节点的文档创建的,则引发此异常。 * NO_MODIFICATION_ALLOWED_ERR: 如果此节点或新节点的父节点为只读的,则引发此异常。 * NOT_FOUND_ERR: 如果 oldChild 不是此节点的子节点,则引发此异常。 * NOT_SUPPORTED_ERR: 如果此节点为 Document 类型,则如果 DOM 实现不支持替换 * DocumentType 子节点或 Element 子节点,则可能引发此异常。 */ public static void replaceNode(Node oldNode, Node newNode) { if ((oldNode != null) && (newNode != null)) { oldNode.getParentNode().replaceChild(newNode, oldNode); } } /** * 将Document输出到指定的文件中。 * * @param fileName * 文件名。 * @param node * 要保存的对象。 * @param encoding * 保存的编码。 * @throws FileNotFoundException * 指定的文件名不存在时,抛出此异常。 * @throws TransformerException * 如果转换过程中发生不可恢复的错误时,抛出此异常。 */ public static void saveXml(final String fileName, final Node node, String encoding) throws FileNotFoundException, TransformerException { XmlUtils.writeXml(new FileOutputStream(fileName), node, encoding); } /** * 将Document输出成字符串的形式。 * * @param node * Node对象。 * @param encoding * 字符串的编码。 * @return 返回输出成的字符串。 * @throws TransformerException * 如果转换过程中发生不可恢复的错误时,抛出此异常。 * @throws UnsupportedEncodingException * 指定的字符串编码不支持时,抛出此异常。 */ public static String nodeToString(Node node, String encoding) throws TransformerException, UnsupportedEncodingException { ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); XmlUtils.writeXml(outputStream, node, encoding); return outputStream.toString(encoding); } /** * 将指定的Node写到指定的OutputStream流中。 * * @param encoding * 编码。 * @param os * OutputStream流。 * @param node * Node节点。 * @throws TransformerException * 如果转换过程中发生不可恢复的错误时,抛出此异常。 */ private static void writeXml(OutputStream os, Node node, String encoding) throws TransformerException { TransformerFactory transFactory = TransformerFactory.newInstance(); Transformer transformer = transFactory.newTransformer(); transformer.setOutputProperty("indent", "yes"); transformer.setOutputProperty(OutputKeys.ENCODING, encoding); DOMSource source = new DOMSource(); source.setNode(node); StreamResult result = new StreamResult(); result.setOutputStream(os); transformer.transform(source, result); } }
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

繁星点点-

请我喝杯咖啡呗

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值