Android-----解析xml文件的三种方式

SAX解析方法介绍：

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

Pull解析器：

　　Pull解析是一个while循环，随时可以跳出。Pull解析器的工作方式为允许你的应用程序代码主动从解析器中获取事件，因此可以在满足了需要的条件后不再获取事件，结束解析工作。

DOM解析：

　　DOM解析XML文件时，会将XML的所有内容读取到内存中，然后允许您使用DOM API遍历XML树、检索所需的数据。因为DOM需要将所有内容读取到内存中，所以内存的消耗比较大，不建议使用DOM解析XML文件，若文件较小可行。

首先新建一个xml文件，放在res/raw目录下，没有raw目录则新建一个。

要解析的itcase.xml内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<persons>
    <person id="23">
        <name>liming</name>
        <age>30</age>
    </person>
    <person id="20">
        <name>lixiang</name>
        <age>25</age>
    </person>
</persons>

新建一个类存放解析的内容

Person.java如下：

public class Person {
    private int id;
    private String name;
    private int age;

    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;
    }
}

以上所需要的准备好了，就开始解析xml工作：

首先是SAX解析：

新建一个 XMLContentHandler.java文件内容如下：

public class XMLContentHandler extends DefaultHandler{

    private List<Person> persons = null;
    private Person currentPerson;
    private String tagName = null;//当前解析的元素标签

    public List<Person> getPersons() {
        return persons;
    }

    @Override/**【文档开始时，调用此方法】**/
    public void startDocument() throws SAXException {
        persons = new ArrayList<>();
    }

    @Override/**【标签开始时，调用此方法】**/
    /**【uri是命名空间|localName是不带命名空间前缀的标签名|qName是带命名空间前缀的标签名|attributes可以得到所有的属性名和对应的值】**/
    public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
        if (localName.equals("person")) {
            currentPerson = new Person();
            currentPerson.setId(Integer.parseInt(attributes.getValue("id")));
        }
        this.tagName = localName;
    }

    @Override/**【接收标签中字符数据时，调用此方法】**/
    /**【ch存放标签中的内容，start是起始位置，length是内容长度】**/
    public void characters(char[] ch, int start, int length) throws SAXException {
        if (tagName != null) {
            String data = new String(ch, start, length);
            if (tagName.equals("name")) {
                this.currentPerson.setName(data);
            } else if (tagName.equals("age")) {
                this.currentPerson.setAge(Short.parseShort(data));
            }
        }
    }

    @Override/**【标签结束时，调用此方法】**/
    /**【localName表示元素本地名称（不带前缀），qName表示元素的限定名（带前缀）】**/
    public void endElement(String uri, String localName, String qName) throws SAXException {
        if (localName.equals("person")) {
            persons.add(currentPerson);
            currentPerson = null;
        }
        this.tagName = null;
    }


}

新建一个调用XMLContentHandler中方法的XMLParsingMethods.java类，内容如下：

public class XMLParsingMethods {

    /**【SAX解析XML文件】**/
    public static List<Person> readXmlBySAX(InputStream inputStream) {
        try {
            /**【创建解析器】**/
            SAXParserFactory spf = SAXParserFactory.newInstance();
            SAXParser saxParser = spf.newSAXParser();
            XMLContentHandler handler = new XMLContentHandler();
            saxParser.parse(inputStream, handler);
            inputStream.close();
            return handler.getPersons();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

到这里，SAX解析XML文件工作已经完成了，调用XMLPersingMethods中的readXmlBySAX就可以解析itcase.xml文件。在这里就先不调用，把三种的解析方法讲完再一并调用。

DOM解析XML文件：直接在XMLPersingMethods中添加解析方法

public class XMLParsingMethods {

    /**【SAX解析XML文件】**/
    public static List<Person> readXmlBySAX(InputStream inputStream) {
        ......
    }

    /**【DOM解析XML文件】**/
    public static List<Person> readXmlByDOM(InputStream inputStream){
        List<Person> persons = new ArrayList<>();
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        try {
            DocumentBuilder builder = factory.newDocumentBuilder();
            Document dom = builder.parse(inputStream);

            Element root = dom.getDocumentElement();
            /**【查找所有person节点】**/
            NodeList items = root.getElementsByTagName("person");
            for (int i = 0; i < items.getLength(); i++) {
                Person person = new Person();

                /**【得到第一个person的节点】**/
                Element personNode = (Element) items.item(i);

                /**【获取person节点的id属性】**/
                person.setId(new Integer(personNode.getAttribute("id")));

                /**【获取person节点下的所有子节点（标签之间的空白节点和name/age节点）】**/
                NodeList childsNodes = personNode.getChildNodes();

                /**【遍历所有子节点】**/
                for (int j = 0; j < childsNodes.getLength(); j++) {
                    Node node = (Node) childsNodes.item(j);

                    /**【判断是否为元素类型】**/
                    if(node.getNodeType() == Node.ELEMENT_NODE){
                        Element childNode = (Element) node;
                        /**【判断是否是name元素】**/
                        if ("name".equals(childNode.getNodeName())) {
                            /**【获取name元素下的text节点，然后从text节点获取数据】**/
                            person.setName(childNode.getFirstChild().getNodeValue());
                            /**【判断是否是age元素】**/
                        }else if("age".equals(childNode.getNodeName())){
                            /**【获取age元素下的text节点，然后从text节点获取数据】**/
                            person.setAge(new Short(childNode.getFirstChild().getNodeValue()));
                        }
                    }
                }
                persons.add(person);
            }
            inputStream.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return persons;
    }
}

至此，DOM解析XML文件工作也已经完成了。

Pull解析器解析XML文件：

public class XMLParsingMethods {

    /**【SAX解析XML文件】**/
    public static List<Person> readXmlBySAX(InputStream inputStream) {
        ......
    }

    /**【DOM解析XML文件】**/
    public static List<Person> readXmlByDOM(InputStream inputStream){
       ......
    }

    /**【Pull解析器解析XML文件】**/
    public static List<Person> readXmlByPull(InputStream inputStream){
        XmlPullParser parser = Xml.newPullParser();
        try {
            parser.setInput(inputStream,"UTF-8");
            int eventType = parser.getEventType();

            Person currenPerson = null;
            List<Person> persons = null;

            while(eventType != XmlPullParser.END_DOCUMENT){
                switch (eventType){
                    case XmlPullParser.START_DOCUMENT:/**【文档开始事件】**/
                        persons = new ArrayList<>();
                        break;
                    case XmlPullParser.START_TAG:/**【元素（即标签）开始事件】**/
                        String name = parser.getName();
                        if(name.equals("person")){
                            currenPerson = new Person();
                            currenPerson.setId(new Integer(parser.getAttributeValue(null,"id")));
                        }else if(currenPerson !=null){
                            if(name.equals("name")){/**【判断标签名（元素名）是否为name】**/
                                currenPerson.setName(parser.nextText());/**【如果后面是text元素，即返回它的值】**/
                            }else if(name.equals("age")){
                                currenPerson.setAge(new Integer(parser.nextText()));
                            }
                        }
                        break;
                    case XmlPullParser.END_TAG:/**【元素结束事件】**/
                        if(parser.getName().equalsIgnoreCase("person") && currenPerson != null){
                            persons.add(currenPerson);
                            currenPerson = null;
                        }
                        break;
                }
                eventType = parser.next();
            }
            inputStream.close();
            return persons;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

至此，SAX、DOM、Pull三种解析XML文件准备好了，接下来分别调用方法：

布局文件：

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    tools:context="com.hs.example.exampleapplication.PersonXML">

        <TextView
            android:id="@+id/data"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:textSize="20sp"
            android:text="Xml数据："/>

    <Button
        android:id="@+id/btn_read"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:textSize="25sp"
        android:text="解析XML文件"/>

</LinearLayout>

方法调用：

public class PersonXML extends AppCompatActivity implements View.OnClickListener{

    Button btn_read;
    TextView data ;
    List<Person> personList = null;
    InputStream inputStream;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_personxml);

        btn_read = this.findViewById(R.id.btn_read);
        btn_read.setOnClickListener(this);

        data = this.findViewById(R.id.data);

        personList = new ArrayList<>();
    }

    @Override
    public void onClick(View view) {
        switch (view.getId()){
            case R.id.btn_read:
                String result = "";
                inputStream = getResources().openRawResource(R.raw.itcase);
                if(inputStream == null){
                    Toast.makeText(this,"InputStream is null",Toast.LENGTH_SHORT).show();
                }else{
                    personList = XMLParsingMethods.readXmlByPull(inputStream); //调用Pull
                    //personList = XMLParsingMethods.readXmlBySAX(inputStream);//调用SAX
                    //personList = XMLParsingMethods.readXmlByDOM(inputStream);//调用DOM
                    if(personList!=null){
                        for(int i = 0 ;i <personList.size();i++){
                            String message = "id = " + personList.get(i).getId() + " , name = " + personList.get(i).getName()
                                    + " , age = " + personList.get(i).getAge() + ".
";
                            result += message;
                        }
                    }else{
                        Toast.makeText(this,"persons is null",Toast.LENGTH_SHORT).show();
                    }
                    data.setText(result);
                    XMLParsingMethods.createXmlFile(personList);//这里是接下来使用Pull解析器生成XML文件的方法调用
                }
                break;
        }

    }
}

运行效果：

顺道讲下使用Pull解析器生成XML文件：

public class XMLParsingMethods {

    /**【SAX解析XML文件】**/
    public static List<Person> readXmlBySAX(InputStream inputStream) {
        ......
    }

    /**【DOM解析XML文件】**/
    public static List<Person> readXmlByDOM(InputStream inputStream){
        ......
    }

    /**【Pull解析器解析XML文件】**/
    public static List<Person> readXmlByPull(InputStream inputStream){
        ......
    }

    /**【使用Pull解析器生成XML文件内容】**/
    public static String WriteXML(List<Person> persons,Writer writer ){
        XmlSerializer serializer = Xml.newSerializer();
        try {
            serializer.setOutput(writer);
            serializer.startDocument("UTF-8",true);

            /**【第一个参数为命名空间，不使用命名空间可以设置为null】**/
            serializer.startTag("","persons");
            /**【XML文件中要生成的内容】**/
            for(Person person : persons){
                serializer.startTag("","person");
                serializer.attribute("", "id", String.valueOf(person.getId()) );

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

                serializer.startTag("","age");
                serializer.text(String.valueOf(person.getAge()));
                serializer.endTag("","age");

                serializer.endTag("","person");
            }
            serializer.endTag("","persons");
            serializer.endDocument();
            return writer.toString();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    /**【生成XML文件代码】**/
    public static void createXmlFile(List<Person> persons){
        if(Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)){
            try {
                File sdCard = Environment.getExternalStorageDirectory();
                File xmlFile = new File(sdCard + File.separator + "testFolder/" + "myitcast.xml");
                FileOutputStream outStream =  new FileOutputStream(xmlFile);
                OutputStreamWriter outputStreamWriter = new OutputStreamWriter(outStream , "UTF-8");
                BufferedWriter writerFile = new BufferedWriter(outputStreamWriter);

                WriteXML(persons,writerFile);
                writerFile.flush();
                writerFile.close();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

运行后：

新建文件要先获得文件操作系统权限，推荐文章：https://blog.csdn.net/weixin_44001878/article/details/89520246

以上内容参考于：https://www.open-open.com/lib/view/open1392780226397.html