Чтобы переводить контент на ваш предпочитаемый язык, Google использует технологии на основе искусственного интеллекта. Переводы от ИИ могут содержать ошибки.

Обработать XML-данные

XML (Extensible Markup Language) – это набор правил для кодирования документов в машиночитаемой форме. 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(), который извлекает и обрабатывает данные, интересующие приложение:

Kotlin

// 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)
        }
    }
 ...
}

Java

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, чтобы начать рекурсивную обработку фида. Если тег не относится к entry, он пропускается. После рекурсивной обработки всего фида readFeed() возвращает List, содержащий записи (включая вложенные элементы данных), извлеченные из фида. Затем синтаксический анализатор возвращает этот объект List.

Kotlin

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

Java

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-фида, сделайте следующее:

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

В этом фрагменте показано, как синтаксический анализатор обрабатывает записи, заголовки, ссылки и сводки.

Kotlin

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

Java

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() синтаксического анализатора:

Kotlin

@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++
        }
    }
}

Java

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-фид. Это позволяет разгрузить основной поток UI. Когда обработка завершается, приложение обновляет интерфейс в основном действии NetworkActivity.

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

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

Kotlin

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

Java

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, чтобы вернуться в основной поток, берет возвращенную строку и отображает ее в пользовательском интерфейсе.

Kotlin

// 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)
            }
        }
    }
}

Java

// 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, показан в следующем фрагменте кода. Она выполняет следующие действия:

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

Kotlin

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

Java

// 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();
}

Обработать XML-данные Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Выберите синтаксический анализатор

Проанализируйте фид

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

Kotlin

Java

Читать ленту

Kotlin

Java

Анализировать XML

Kotlin

Java

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

Kotlin

Java

Использовать XML-данные

Kotlin

Java

Kotlin

Java

Kotlin

Java

Обработать XML-данные