Анализ XML-данных

Расширяемый язык разметки (XML) — это набор правил кодирования документов в машиночитаемой форме. XML — популярный формат для обмена данными в Интернете.

Веб-сайты, которые часто обновляют свое содержимое, например новостные сайты или блоги, часто предоставляют XML-канал, чтобы внешние программы могли быть в курсе изменений контента. Загрузка и анализ XML-данных — обычная задача для сетевых приложений. В этом разделе объясняется, как анализировать XML-документы и использовать их данные.

Дополнительные сведения о создании веб-контента в приложении Android см. в разделе Веб-контент .

Выберите парсер

Мы рекомендуем XmlPullParser — эффективный и удобный способ анализа XML на Android. В Android есть две реализации этого интерфейса:

• KXmlParser с использованием XmlPullParserFactory.newPullParser()
• ExpatPullParser с использованием Xml.newPullParser()

Любой выбор хорош. В примере в этом разделе используются ExpatPullParser и Xml.newPullParser() .

Анализируйте ленту

Первый шаг при анализе фида — решить, какие поля вас интересуют. Анализатор извлекает данные для этих полей и игнорирует остальные.

См. следующий отрывок из проанализированного канала в примере приложения. Каждое сообщение на StackOverflow.com отображается в ленте как тег entry , содержащий несколько вложенных тегов:

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:creativeCommons="http://backend.userland.com/creativeCommonsRssModule" ...">
<title type="text">newest questions tagged android - Stack Overflow</title>
...
    <entry>
    ...
    </entry>
    <entry>
        <id>http://stackoverflow.com/q/9439999</id>
        <re:rank scheme="http://stackoverflow.com">0</re:rank>
        <title type="text">Where is my data file?</title>
        <category scheme="http://stackoverflow.com/feeds/tag?tagnames=android&sort=newest/tags" term="android"/>
        <category scheme="http://stackoverflow.com/feeds/tag?tagnames=android&sort=newest/tags" term="file"/>
        <author>
            <name>cliff2310</name>
            <uri>http://stackoverflow.com/users/1128925</uri>
        </author>
        <link rel="alternate" href="http://stackoverflow.com/questions/9439999/where-is-my-data-file" />
        <published>2012-02-25T00:30:54Z</published>
        <updated>2012-02-25T00:30:54Z</updated>
        <summary type="html">
            <p>I have an Application that requires a data file...</p>

        </summary>
    </entry>
    <entry>
    ...
    </entry>
...
</feed>

Пример приложения извлекает данные для тега entry и его вложенных тегов title , link и summary .

Создание экземпляра парсера

Следующим шагом в анализе канала является создание экземпляра анализатора и запуск процесса анализа. Этот фрагмент инициализирует синтаксический анализатор, чтобы он не обрабатывал пространства имен и использовал предоставленный InputStream в качестве входных данных. Он запускает процесс анализа с вызова nextTag() и вызывает метод readFeed() , который извлекает и обрабатывает данные, которые интересуют приложение:

Котлин Ява

// We don't use namespaces.
private val ns: String? = null

class StackOverflowXmlParser {

    @Throws(XmlPullParserException::class, IOException::class)
    fun parse(inputStream: InputStream): List<*> {
        inputStream.use { inputStream ->
            val parser: XmlPullParser = Xml.newPullParser()
            parser.setFeature(XmlPullParser.FEATURE_PROCESS_NAMESPACES, false)
            parser.setInput(inputStream, null)
            parser.nextTag()
            return readFeed(parser)
        }
    }
 ...
}

public class StackOverflowXmlParser {
    // We don't use namespaces.
    private static final String ns = null;

    public List parse(InputStream in) throws XmlPullParserException, IOException {
        try {
            XmlPullParser parser = Xml.newPullParser();
            parser.setFeature(XmlPullParser.FEATURE_PROCESS_NAMESPACES, false);
            parser.setInput(in, null);
            parser.nextTag();
            return readFeed(parser);
        } finally {
            in.close();
        }
    }
 ...
}

Читать ленту

Метод readFeed() выполняет фактическую работу по обработке канала. Он ищет элементы с тегом «запись» в качестве отправной точки для рекурсивной обработки канала. Если тег не является тегом entry , он его пропускает. После рекурсивной обработки всего канала readFeed() возвращает List , содержащий записи (включая вложенные элементы данных), извлеченные из канала. Этот List затем возвращается анализатором.

Котлин Ява

@Throws(XmlPullParserException::class, IOException::class)
private fun readFeed(parser: XmlPullParser): List<Entry> {
    val entries = mutableListOf<Entry>()

    parser.require(XmlPullParser.START_TAG, ns, "feed")
    while (parser.next() != XmlPullParser.END_TAG) {
        if (parser.eventType != XmlPullParser.START_TAG) {
            continue
        }
        // Starts by looking for the entry tag.
        if (parser.name == "entry") {
            entries.add(readEntry(parser))
        } else {
            skip(parser)
        }
    }
    return entries
}

private List readFeed(XmlPullParser parser) throws XmlPullParserException, IOException {
    List entries = new ArrayList();

    parser.require(XmlPullParser.START_TAG, ns, "feed");
    while (parser.next() != XmlPullParser.END_TAG) {
        if (parser.getEventType() != XmlPullParser.START_TAG) {
            continue;
        }
        String name = parser.getName();
        // Starts by looking for the entry tag.
        if (name.equals("entry")) {
            entries.add(readEntry(parser));
        } else {
            skip(parser);
        }
    }
    return entries;
}

Разобрать XML

Шаги для анализа XML-канала следующие:

1. Как описано в разделе «Анализ канала» , определите теги, которые вы хотите включить в свое приложение. В этом примере извлекаются данные для тега entry и его вложенных тегов: title , link и summary .
2. Создайте следующие методы:
   • Метод «чтения» для каждого тега, который вы хотите включить, например readEntry() и readTitle() . Парсер считывает теги из входного потока. Когда он встречает тег с именем, в этом примере, entry , title , link или summary , он вызывает соответствующий метод для этого тега. В противном случае он пропускает тег.
   • Методы извлечения данных для каждого типа тегов и перехода анализатора к следующему тегу. В этом примере соответствующие методы следующие:
     • Для тегов title и summary синтаксический анализатор вызывает readText() . Этот метод извлекает данные для этих тегов, вызывая parser.getText() .
     • Что касается тега link , анализатор извлекает данные для ссылок, сначала определяя, является ли ссылка тем типом, который его интересует. Затем он использует parser.getAttributeValue() для извлечения значения ссылки.
     • Для тега entry синтаксический анализатор вызывает readEntry() . Этот метод анализирует вложенные теги записи и возвращает объект Entry с элементами данных title , link и summary .
   • Вспомогательный рекурсивный метод skip() . Дополнительные сведения по этой теме см. в разделе Пропуск ненужных тегов .

В этом фрагменте показано, как анализатор анализирует записи, заголовки, ссылки и резюме.

Котлин Ява

data class Entry(val title: String?, val summary: String?, val link: String?)

// Parses the contents of an entry. If it encounters a title, summary, or link tag, hands them off
// to their respective "read" methods for processing. Otherwise, skips the tag.
@Throws(XmlPullParserException::class, IOException::class)
private fun readEntry(parser: XmlPullParser): Entry {
    parser.require(XmlPullParser.START_TAG, ns, "entry")
    var title: String? = null
    var summary: String? = null
    var link: String? = null
    while (parser.next() != XmlPullParser.END_TAG) {
        if (parser.eventType != XmlPullParser.START_TAG) {
            continue
        }
        when (parser.name) {
            "title" -> title = readTitle(parser)
            "summary" -> summary = readSummary(parser)
            "link" -> link = readLink(parser)
            else -> skip(parser)
        }
    }
    return Entry(title, summary, link)
}

// Processes title tags in the feed.
@Throws(IOException::class, XmlPullParserException::class)
private fun readTitle(parser: XmlPullParser): String {
    parser.require(XmlPullParser.START_TAG, ns, "title")
    val title = readText(parser)
    parser.require(XmlPullParser.END_TAG, ns, "title")
    return title
}

// Processes link tags in the feed.
@Throws(IOException::class, XmlPullParserException::class)
private fun readLink(parser: XmlPullParser): String {
    var link = ""
    parser.require(XmlPullParser.START_TAG, ns, "link")
    val tag = parser.name
    val relType = parser.getAttributeValue(null, "rel")
    if (tag == "link") {
        if (relType == "alternate") {
            link = parser.getAttributeValue(null, "href")
            parser.nextTag()
        }
    }
    parser.require(XmlPullParser.END_TAG, ns, "link")
    return link
}

// Processes summary tags in the feed.
@Throws(IOException::class, XmlPullParserException::class)
private fun readSummary(parser: XmlPullParser): String {
    parser.require(XmlPullParser.START_TAG, ns, "summary")
    val summary = readText(parser)
    parser.require(XmlPullParser.END_TAG, ns, "summary")
    return summary
}

// For the tags title and summary, extracts their text values.
@Throws(IOException::class, XmlPullParserException::class)
private fun readText(parser: XmlPullParser): String {
    var result = ""
    if (parser.next() == XmlPullParser.TEXT) {
        result = parser.text
        parser.nextTag()
    }
    return result
}
...

public static class Entry {
    public final String title;
    public final String link;
    public final String summary;

    private Entry(String title, String summary, String link) {
        this.title = title;
        this.summary = summary;
        this.link = link;
    }
}

// Parses the contents of an entry. If it encounters a title, summary, or link tag, hands them off
// to their respective "read" methods for processing. Otherwise, skips the tag.
private Entry readEntry(XmlPullParser parser) throws XmlPullParserException, IOException {
    parser.require(XmlPullParser.START_TAG, ns, "entry");
    String title = null;
    String summary = null;
    String link = null;
    while (parser.next() != XmlPullParser.END_TAG) {
        if (parser.getEventType() != XmlPullParser.START_TAG) {
            continue;
        }
        String name = parser.getName();
        if (name.equals("title")) {
            title = readTitle(parser);
        } else if (name.equals("summary")) {
            summary = readSummary(parser);
        } else if (name.equals("link")) {
            link = readLink(parser);
        } else {
            skip(parser);
        }
    }
    return new Entry(title, summary, link);
}

// Processes title tags in the feed.
private String readTitle(XmlPullParser parser) throws IOException, XmlPullParserException {
    parser.require(XmlPullParser.START_TAG, ns, "title");
    String title = readText(parser);
    parser.require(XmlPullParser.END_TAG, ns, "title");
    return title;
}

// Processes link tags in the feed.
private String readLink(XmlPullParser parser) throws IOException, XmlPullParserException {
    String link = "";
    parser.require(XmlPullParser.START_TAG, ns, "link");
    String tag = parser.getName();
    String relType = parser.getAttributeValue(null, "rel");
    if (tag.equals("link")) {
        if (relType.equals("alternate")){
            link = parser.getAttributeValue(null, "href");
            parser.nextTag();
        }
    }
    parser.require(XmlPullParser.END_TAG, ns, "link");
    return link;
}

// Processes summary tags in the feed.
private String readSummary(XmlPullParser parser) throws IOException, XmlPullParserException {
    parser.require(XmlPullParser.START_TAG, ns, "summary");
    String summary = readText(parser);
    parser.require(XmlPullParser.END_TAG, ns, "summary");
    return summary;
}

// For the tags title and summary, extracts their text values.
private String readText(XmlPullParser parser) throws IOException, XmlPullParserException {
    String result = "";
    if (parser.next() == XmlPullParser.TEXT) {
        result = parser.getText();
        parser.nextTag();
    }
    return result;
}
  ...
}

Пропускайте теги, которые вам не интересны

Парсеру необходимо пропускать теги, которые ему не интересны. Вот метод парсера skip() :

Котлин Ява

@Throws(XmlPullParserException::class, IOException::class)
private fun skip(parser: XmlPullParser) {
    if (parser.eventType != XmlPullParser.START_TAG) {
        throw IllegalStateException()
    }
    var depth = 1
    while (depth != 0) {
        when (parser.next()) {
            XmlPullParser.END_TAG -> depth--
            XmlPullParser.START_TAG -> depth++
        }
    }
}

private void skip(XmlPullParser parser) throws XmlPullParserException, IOException {
    if (parser.getEventType() != XmlPullParser.START_TAG) {
        throw new IllegalStateException();
    }
    int depth = 1;
    while (depth != 0) {
        switch (parser.next()) {
        case XmlPullParser.END_TAG:
            depth--;
            break;
        case XmlPullParser.START_TAG:
            depth++;
            break;
        }
    }
 }

Вот как это работает:

• Он генерирует исключение, если текущее событие не является START_TAG .
• Он использует START_TAG и все события до соответствующего END_TAG включительно.
• Он отслеживает глубину вложенности, чтобы убедиться, что он останавливается на правильном END_TAG , а не на первом встреченном теге после исходного START_TAG .

Таким образом, если текущий элемент имеет вложенные элементы, значение depth не будет равно 0, пока синтаксический анализатор не обработает все события между исходным START_TAG и соответствующим ему END_TAG . Например, рассмотрим, как парсер пропускает элемент <author> , который имеет два вложенных элемента: <name> и <uri> :

• При первом выполнении цикла while следующим тегом, который анализатор встретит после <author> будет START_TAG для <name> . Значение depth увеличивается до 2.
• Во второй раз в while следующим тегом, с которым сталкивается синтаксический анализатор, является END_TAG </name> . Значение depth уменьшается до 1.
• В третий раз в цикле while следующим тегом, с которым сталкивается синтаксический анализатор, является START_TAG <uri> . Значение depth увеличивается до 2.
• В четвертый раз в цикле while следующим тегом, с которым сталкивается синтаксический анализатор, является END_TAG </uri> . Значение depth уменьшается до 1.
• В пятый и последний раз цикла while следующим тегом, с которым сталкивается синтаксический анализатор, является END_TAG </author> . Значение depth уменьшается до 0, что указывает на то, что элемент <author> успешно пропущен.

Потребление XML-данных

Пример приложения асинхронно извлекает и анализирует XML-канал. Это снимает обработку с основного потока пользовательского интерфейса. После завершения обработки приложение обновляет пользовательский интерфейс в своем основном действии NetworkActivity .

В следующем фрагменте метод loadPage() выполняет следующее:

• Инициализирует строковую переменную с URL-адресом XML-канала.
• Вызывает метод downloadXml(url) , если это позволяют настройки пользователя и сетевое подключение. Этот метод загружает и анализирует канал и возвращает строковый результат, который будет отображаться в пользовательском интерфейсе.

Котлин Ява

class NetworkActivity : Activity() {

    companion object {

        const val WIFI = "Wi-Fi"
        const val ANY = "Any"
        const val SO_URL = "http://stackoverflow.com/feeds/tag?tagnames=android&sort=newest"
        // Whether there is a Wi-Fi connection.
        private var wifiConnected = false
        // Whether there is a mobile connection.
        private var mobileConnected = false

        // Whether the display should be refreshed.
        var refreshDisplay = true
        // The user's current network preference setting.
        var sPref: String? = null
    }
    ...
    // Asynchronously downloads the XML feed from stackoverflow.com.
    fun loadPage() {

        if (sPref.equals(ANY) && (wifiConnected || mobileConnected)) {
            downloadXml(SO_URL)
        } else if (sPref.equals(WIFI) && wifiConnected) {
            downloadXml(SO_URL)
        } else {
            // Show error.
        }
    }
    ...
}

public class NetworkActivity extends Activity {
    public static final String WIFI = "Wi-Fi";
    public static final String ANY = "Any";
    private static final String URL = "http://stackoverflow.com/feeds/tag?tagnames=android&sort=newest";

    // Whether there is a Wi-Fi connection.
    private static boolean wifiConnected = false;
    // Whether there is a mobile connection.
    private static boolean mobileConnected = false;
    // Whether the display should be refreshed.
    public static boolean refreshDisplay = true;
    public static String sPref = null;
    ...
    // Asynchronously downloads the XML feed from stackoverflow.com.
    public void loadPage() {

        if((sPref.equals(ANY)) && (wifiConnected || mobileConnected)) {
            downloadXml(URL);
        }
        else if ((sPref.equals(WIFI)) && (wifiConnected)) {
            downloadXml(URL);
        } else {
            // Show error.
        }
    }

Метод downloadXml вызывает следующие методы Kotlin:

• lifecycleScope.launch(Dispatchers.IO) , который использует сопрограммы Kotlin для запуска метода loadXmlFromNetwork() в потоке ввода-вывода. Он передает URL-адрес канала в качестве параметра. Метод loadXmlFromNetwork() извлекает и обрабатывает канал. По завершении он возвращает строку результата.
• withContext(Dispatchers.Main) , который использует сопрограммы Kotlin для возврата в основной поток, принимает возвращенную строку и отображает ее в пользовательском интерфейсе.

На языке программирования Java этот процесс выглядит следующим образом:

• Executor выполняет метод loadXmlFromNetwork() в фоновом потоке. Он передает URL-адрес канала в качестве параметра. Метод loadXmlFromNetwork() извлекает и обрабатывает канал. По завершении он возвращает строку результата.
• Handler вызывает post , чтобы вернуться в основной поток, принимает возвращенную строку и отображает ее в пользовательском интерфейсе.

Котлин Ява

// Implementation of Kotlin coroutines used to download XML feed from stackoverflow.com.
private fun downloadXml(vararg urls: String) {
    var result: String? = null
    lifecycleScope.launch(Dispatchers.IO) {
        result = try {
            loadXmlFromNetwork(urls[0])
        } catch (e: IOException) {
            resources.getString(R.string.connection_error)
        } catch (e: XmlPullParserException) {
            resources.getString(R.string.xml_error)
        }
        withContext(Dispatchers.Main) {
            setContentView(R.layout.main)
            // Displays the HTML string in the UI via a WebView.
            findViewById<WebView>(R.id.webview)?.apply {
                loadData(result?: "", "text/html", null)
            }
        }
    }
}

// Implementation of Executor and Handler used to download XML feed asynchronously from stackoverflow.com.
private void downloadXml(String... urls) {
    ExecutorService executor = Executors.newSingleThreadExecutor();
    Handler handler = new Handler(Looper.getMainLooper());
    executor.execute(() -> {
        String result;
            try {
                result = loadXmlFromNetwork(urls[0]);
            } catch (IOException e) {
                result = getResources().getString(R.string.connection_error);
            } catch (XmlPullParserException e) {
                result = getResources().getString(R.string.xml_error);
            }
        String finalResult = result;
        handler.post(() -> {
            setContentView(R.layout.main);
            // Displays the HTML string in the UI via a WebView.
            WebView myWebView = (WebView) findViewById(R.id.webview);
            myWebView.loadData(finalResult, "text/html", null);
        });
    });
}

Метод loadXmlFromNetwork() , вызываемый из downloadXml показан в следующем фрагменте. Он делает следующее:

1. Создает экземпляр StackOverflowXmlParser . Он также создает переменные для объектов List of Entry ( entries ), а также для title , url и summary , чтобы хранить значения, извлеченные из XML-канала для этих полей.
2. Вызывает downloadUrl() , который извлекает канал и возвращает его как InputStream .
3. Использует StackOverflowXmlParser для анализа InputStream . StackOverflowXmlParser заполняет List entries данными из канала.
4. Обрабатывает List entries и объединяет данные фида с HTML-разметкой.
5. Возвращает строку HTML, которая отображается в пользовательском интерфейсе основного действия.

Котлин Ява

// Uploads XML from stackoverflow.com, parses it, and combines it with
// HTML markup. Returns HTML string.
@Throws(XmlPullParserException::class, IOException::class)
private fun loadXmlFromNetwork(urlString: String): String {
    // Checks whether the user set the preference to include summary text.
    val pref: Boolean = PreferenceManager.getDefaultSharedPreferences(this)?.run {
        getBoolean("summaryPref", false)
    } ?: false

    val entries: List<Entry> = downloadUrl(urlString)?.use { stream ->
        // Instantiates the parser.
        StackOverflowXmlParser().parse(stream)
    } ?: emptyList()

    return StringBuilder().apply {
        append("<h3>${resources.getString(R.string.page_title)}</h3>")
        append("<em>${resources.getString(R.string.updated)} ")
        append("${formatter.format(rightNow.time)}</em>")
        // StackOverflowXmlParser returns a List (called "entries") of Entry objects.
        // Each Entry object represents a single post in the XML feed.
        // This section processes the entries list to combine each entry with HTML markup.
        // Each entry is displayed in the UI as a link that optionally includes
        // a text summary.
        entries.forEach { entry ->
            append("<p><a href='")
            append(entry.link)
            append("'>" + entry.title + "</a></p>")
            // If the user set the preference to include summary text,
            // adds it to the display.
            if (pref) {
                append(entry.summary)
            }
        }
    }.toString()
}

// Given a string representation of a URL, sets up a connection and gets
// an input stream.
@Throws(IOException::class)
private fun downloadUrl(urlString: String): InputStream? {
    val url = URL(urlString)
    return (url.openConnection() as? HttpURLConnection)?.run {
        readTimeout = 10000
        connectTimeout = 15000
        requestMethod = "GET"
        doInput = true
        // Starts the query.
        connect()
        inputStream
    }
}

// Uploads XML from stackoverflow.com, parses it, and combines it with
// HTML markup. Returns HTML string.
private String loadXmlFromNetwork(String urlString) throws XmlPullParserException, IOException {
    InputStream stream = null;
    // Instantiates the parser.
    StackOverflowXmlParser stackOverflowXmlParser = new StackOverflowXmlParser();
    List<Entry> entries = null;
    String title = null;
    String url = null;
    String summary = null;
    Calendar rightNow = Calendar.getInstance();
    DateFormat formatter = new SimpleDateFormat("MMM dd h:mmaa");

    // Checks whether the user set the preference to include summary text.
    SharedPreferences sharedPrefs = PreferenceManager.getDefaultSharedPreferences(this);
    boolean pref = sharedPrefs.getBoolean("summaryPref", false);

    StringBuilder htmlString = new StringBuilder();
    htmlString.append("<h3>" + getResources().getString(R.string.page_title) + "</h3>");
    htmlString.append("<em>" + getResources().getString(R.string.updated) + " " +
            formatter.format(rightNow.getTime()) + "</em>");

    try {
        stream = downloadUrl(urlString);
        entries = stackOverflowXmlParser.parse(stream);
    // Makes sure that the InputStream is closed after the app is
    // finished using it.
    } finally {
        if (stream != null) {
            stream.close();
        }
     }

    // StackOverflowXmlParser returns a List (called "entries") of Entry objects.
    // Each Entry object represents a single post in the XML feed.
    // This section processes the entries list to combine each entry with HTML markup.
    // Each entry is displayed in the UI as a link that optionally includes
    // a text summary.
    for (Entry entry : entries) {
        htmlString.append("<p><a href='");
        htmlString.append(entry.link);
        htmlString.append("'>" + entry.title + "</a></p>");
        // If the user set the preference to include summary text,
        // adds it to the display.
        if (pref) {
            htmlString.append(entry.summary);
        }
    }
    return htmlString.toString();
}

// Given a string representation of a URL, sets up a connection and gets
// an input stream.
private InputStream downloadUrl(String urlString) throws IOException {
    URL url = new URL(urlString);
    HttpURLConnection conn = (HttpURLConnection) url.openConnection();
    conn.setReadTimeout(10000 /* milliseconds */);
    conn.setConnectTimeout(15000 /* milliseconds */);
    conn.setRequestMethod("GET");
    conn.setDoInput(true);
    // Starts the query.
    conn.connect();
    return conn.getInputStream();
}