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.Google天氣預報：http://android.yaohuiji.com/archives/9352.android解析xml檔案的三種方式：http://www.cnblogs.com/zhangdongzi/archive/2011/04/14/2016434.html3.Android APIs：http://developer.android.com/reference/org/xmlpull/v1/XmlPullParser.html