Android解析XML文件[通俗易懂]

大家好，又见面了，我是你们的朋友全栈君。

按计划每周更新一篇技术博文，第一篇：《
Android解析XML文件》

一、在Android应用中的XML文件来源

1、本地xml文件

本地XML文件可以放在应用根目录assets文件夹、res/xml、res/raw、SDcard卡、应用的data目录等；

除res/xml可直接通过getXml(int id)获取XML文档，返回一个解析器对象（XmlResourceParer：
XmlResourceParer是XmlPullParser的子类），其它位置情况都可以获取XML文档，返回一个Inputstream对象，进行读取数据，获取方法分别如下：

a.在res/xml目录下（推荐使用）：

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

b.在res/xml、res/raw目录下：

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

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

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

d.在应用指定目录下(SDcard，应用data目录等):

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

2、通过url得到的xml文件

很多时候需要解析xml文件都用于客户端与服务器之间的数据交互，比如解析google天气预报信息，或自己项目内定的一些XML数据结构，其中通过URL，使用DefaultHTTPClient get请求获取XML文件方法如下：

    /**     * 读取url的xml资源 转成String     * @param url     * @return 返回 读取url的xml字符串     */    public String getStringByUrl(String url) {        String outputString = "";        // DefaultHttpClient        DefaultHttpClient httpclient = new DefaultHttpClient();        // HttpGet        HttpGet httpget = new HttpGet(url);        // ResponseHandler        ResponseHandler<String> responseHandler = new BasicResponseHandler();        try {            outputString = httpclient.execute(httpget, responseHandler);            outputString = new String(outputString.getBytes("ISO-8859-1"), "utf-8");    // 解决中文乱码            Log.i("HttpClientConnector", "连接成功");        } catch (Exception e) {            Log.i("HttpClientConnector", "连接失败");            e.printStackTrace();        }        httpclient.getConnectionManager().shutdown();        return outputString;    }

二、XML文件的解析方式

能够运用在Android系统上解析XML文件的常用有三种方式：DOM、SAX和PULL，其中DOM解析XML是先把XML文件读进内存中，再通过接口获取数据，该方法使用相对小的XML文件，移动设备往往受硬件性能影响，如果XML文件比较大使用DOM解析往往效率跟不上；SAX和PULL都是采用事件驱动方式来进行解析，在Android中的事件机制是基于回调函数。

本例旨在考虑简单方便性，综合考虑选择了PULL解析，PULL解析器是一个开源项目，Android平台已经内置了PULL解析器，同时Android系统本身也是使用PULL解析器来解析各种XML文档。

1、事件回调类型

PULL解析XML文件时，回调XmlResourceParser内定义表示文档开头结束和节点开头结束的数值（事件回调类型），表示如下：

a.读取到XML文档开头（声明）返回：XmlPullParser.
START_DOCUMENT（0）

b.读取到XML文档结束返回：XmlPullParser.
END_DOCUMENT （1）

c.读取到XML节点开始返回：XmlPullParser.
START_TAG （2）

d.读取到XML节点结束返回：XmlPullParser.
END_TAG （3）

e.读取到XML文本返回：XmlPullParser.
TEXT （4）

2、XmlPullParser有几个主要方法(更多查阅Android APIs):

a.XmlPullParser.
getEventType() : Returns the type of the current event (START_TAG, END_TAG, TEXT, etc.) 【获取当前事件回调类型】

b.XmlPullParser.
getName():For START_TAG or END_TAG events, the (local) name of the current element is returned when namespaces are enabled.【获取当前节点名字】

c.XmlPullParser.
getAttributeValue(int index):Returns the given attributes value.【根据id获取节点属性值】

d.XmlPullParser.
getAttributeValue(String namespace, String name):Returns the attributes value identified by namespace URI and namespace localName.【根据name获取节点属性值】

e.XmlPullParser.
netxText():If current event is START_TAG then if next element is TEXT then element content is returned or if next event is END_TAG then empty string is returned, otherwise exception is thrown.【回调节点START_TAG时，通过此方法获取节点内容】

3、实际编码中如何使用

在实际编码中，主要根据事件回调类型，结合被解析的XML结构进行解析提取数据，PULL解析XML文件的主要模式如下，更具体使用看本文提供的例子：

try {    //开始解析事件    int eventType = parser.getEventType();    //处理事件，不碰到文档结束就一直处理    while (eventType != XmlPullParser.END_DOCUMENT) {         //因为定义了一堆静态常量，所以这里可以用switch        switch (eventType) {            case XmlPullParser.START_DOCUMENT:                // 不做任何操作或初开始化数据                break;            case XmlPullParser.START_TAG:                // 解析XML节点数据                // 获取当前标签名字                String tagName = parser.getName();                if(tagName.equals("XXXTAGXXX")){                    // 通过getAttributeValue 和 netxText解析节点的属性值和节点值                }                break;            case XmlPullParser.END_TAG:                // 单节点完成，可往集合里边添加新的数据                break;            case XmlPullParser.END_DOCUMENT:                break;        }        // 别忘了用next方法处理下一个事件，不然就会死循环        eventType = parser.next();    }} catch (XmlPullParserException e) {    e.printStackTrace();}catch (IOException e) {    e.printStackTrace();}

三、运用例子

本例主要是解析我国省市的XML文件，文件结构简单，本例采用资源数据地址：http://www.csw333.com/CityScene_I/getPlace.php，关于XML的结构基础之类的就不再累赘，实际项目中，根据XML文件的节点结果来进行变换，主要修改case XmlPullParser.START_TAG部分代码。

1.本例在获取XML文件的省份中，比较了获取三个不同位置的XML文件资源的读取方式；

2.再获取url上的XML文件时，返回的字符串进行utf-8转码，避免中文乱码（本例采用的url资源数据需要转码）；

3.针对实际项目中，若xml文件过大，可以使用多线程进行解析，避免ANR，若解析时间较长，可以添加滚动提示;

4.本例存在个Bug，根据例子使用的XML文件结构把直辖市也编进省份中，例子目的是解析XML文件，实际项目是需要避免；

5.
主要代码：

a.各种获取XML文件资源方式

    /**     * 同样删除首行，才能解析成功，     * @param fileName     * @return 返回xml文件的inputStream     */         public InputStream getInputStreamFromAssets(String fileName){        try {            InputStream inputStream = getResources().getAssets().open(fileName);            return inputStream;        } catch (IOException e) {            e.printStackTrace();        }        return null;    }    /**     * 读取XML文件，xml文件放到res/xml文件夹中，若XML为本地文件，则推荐该方法     *      * @param fileName     * @return : 读取到res/xml文件夹下的xml文件，返回XmlResourceParser对象（XmlPullParser的子类）     */    public XmlResourceParser getXMLFromResXml(String fileName){        XmlResourceParser xmlParser = null;        try {            //*/            //  xmlParser = this.getResources().getAssets().openXmlResourceParser("assets/"+fileName);        // 失败,找不到文件            xmlParser = this.getResources().getXml(R.xml.provinceandcity);            /*/            // xml文件在res目录下 也可以用此方法返回inputStream            InputStream inputStream = this.getResources().openRawResource(R.xml.provinceandcity);            /*/            return xmlParser;        } catch (Exception e) {             e.printStackTrace();         }        return xmlParser;    }    /**     * 读取url的xml资源 转成String     * @param url     * @return 返回 读取url的xml字符串     */    public String getStringByUrl(String url) {        String outputString = "";        // DefaultHttpClient        DefaultHttpClient httpclient = new DefaultHttpClient();        // HttpGet        HttpGet httpget = new HttpGet(url);        // ResponseHandler        ResponseHandler<String> responseHandler = new BasicResponseHandler();        try {            outputString = httpclient.execute(httpget, responseHandler);            outputString = new String(outputString.getBytes("ISO-8859-1"), "utf-8");    // 解决中文乱码            Log.i("HttpClientConnector", "连接成功");        } catch (Exception e) {            Log.i("HttpClientConnector", "连接失败");            e.printStackTrace();        }        httpclient.getConnectionManager().shutdown();        return outputString;    }    /**     * 解析SDcard xml文件     * @param fileName     * @return 返回xml文件的inputStream     */         public InputStream getInputStreamFromSDcard(String fileName){        try {            // 路径根据实际项目修改            String path = Environment.getExternalStorageDirectory().toString() + "/test_xml/";            Log.v("", "path : " + path);            File xmlFlie = new File(path+fileName);            InputStream inputStream = new FileInputStream(xmlFlie);            return inputStream;        } catch (IOException e) {            e.printStackTrace();        }        return null;    }

b.多线程解析：

    /**
     *  多线程加载网络端的xml，若xml文件过大也需要用该方式加载
     */
    Handler mHandler = new Handler();   
    Runnable mRunnable = new Runnable() {
        public void run() {
            if(!isFinishParser){

                mHandler.postDelayed(mRunnable, 1000);    
            }else{
                showView.setText(provinceStr);
                mHandler.removeCallbacks(mRunnable);
            }
        }
    };

    /**
     * 比较耗时操作新建一个线程，避免UI线程ANR
     */
    public void parserWhitThread(){
        new Thread(){
            @Override
            public void run() {                
                provinceandcityStr = getStringByUrl(provinceAndCityUrl);
                provinceArray = ProvincePullParse.Parse(provinceandcityStr);
                for(Province pro : provinceArray){
                    provinceStr += pro.getProvinceId() + " : " +pro.getProvinceName()+"\n";
                }
                isFinishParser = true;
            }
        }.start();
    }

c.从XML文件中解析出城市：

    public static ArrayList<City> ParseXml(XmlPullParser parser){
        ArrayList<City> CityArray = new ArrayList<City>();
        City CityTemp = null;
        int provinceId = 0;
        int cityId;
        String cityName;

        try {
            //开始解析事件
            int eventType = parser.getEventType();

            //处理事件，不碰到文档结束就一直处理
            while (eventType != XmlPullParser.END_DOCUMENT) {
                //因为定义了一堆静态常量，所以这里可以用switch
                switch (eventType) {
                    case XmlPullParser.START_DOCUMENT:
                        break;

                    case XmlPullParser.START_TAG:

                        //给当前标签起个名字
                        String tagName = parser.getName();
                        //  Log.d("", "====XmlPullParser.START_TAG=== tagName: " + tagName);

                        if(tagName.equals("province")){
                           
                            provinceId = Integer.parseInt(parser.getAttributeValue(0));
                        }else if(tagName.equals("item")){
                            CityTemp = new City();
                        }else if(tagName.equals("id")){
                            cityId = Integer.parseInt(parser.nextText());                            
                            parser.next();
                            cityName = parser.nextText();
                            
                            Log.v("", "id getText: "+cityId);
                            Log.v("", "name getText: "+cityName);                            
                            Log.e("", "=========================");
                            
                            CityTemp.setProvinceId(provinceId);
                            CityTemp.setCityId(cityId);
                            CityTemp.setCityName(cityName);
                            
                            CityArray.add(CityTemp);
                        }
                        break;

                    case XmlPullParser.END_TAG:
                        break;
                    case XmlPullParser.END_DOCUMENT:
                        break;
                }

                //别忘了用next方法处理下一个事件，忘了的结果就成死循环#_#
                eventType = parser.next();
            }
        } catch (XmlPullParserException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }

        return CityArray;
    }

源码下载：

http://download.csdn.net/detail/zzp16/4459459

参考引用

1.谷歌天气预报：
http://android.yaohuiji.com/archives/935

2.android解析xml文件的三种方式：
http://www.cnblogs.com/zhangdongzi/archive/2011/04/14/2016434.html

3.Android APIs：
http://developer.android.com/reference/org/xmlpull/v1/XmlPullParser.html

发布者：全栈程序员-站长，转载请注明出处：https://javaforall.net/158838.html原文链接：https://javaforall.net