Jsoup（一）Jsoup詳解（官方）

時間 2019-11-20

標籤 jsoup 詳解官方欄目 Java 简体版

原文原文鏈接

1、Jsoup概述

1.一、簡介

jsoup 是一款Java 的HTML解析器，可直接解析某個URL地址、HTML文本內容。它提供了一套很是省力的API，

　可經過DOM，CSS以及相似於jQuery的操做方法來取出和操做數據。

1.二、Jsoup的主要功能

1）從一個URL，文件或字符串中解析HTML

2）使用DOM或CSS選擇器來查找、取出數據

3）可操做HTML元素、屬性、文本

注意：jsoup是基於MIT協議發佈的，可放心使用於商業項目。

1.三、jsoup 的主要類層次結構

2、入門

2.一、解析和遍歷一個HTML文檔

　　如何解析一個HTML文檔：

String html = "<html><head><title>First parse</title></head>"
+ "<body><p>Parsed HTML into a doc.</p></body></html>";
Document doc = Jsoup.parse(html);

　　其解析器可以盡最大可能從你提供的HTML文檔來創見一個乾淨的解析結果，不管HTML的格式是否完整。好比它能夠處理：

　　　　1）沒有關閉的標籤

            <p>Lorem <p>Ipsum parses to <p>Lorem</p> <p>Ipsum</p>

　　　　2）隱式標籤

        它能夠自動將 <td>Table data</td>包裝成<table><tr><td>?

　　　　3）建立可靠的文檔結構

 html標籤包含head 和 body，在head只出現恰當的元素

2.二、一個文檔的對象模型

1）文檔由多個Elements和TextNodes組成

2）其繼承結構以下：Document繼承Element繼承Node. TextNode繼承 Node.

3）一個Element包含一個子節點集合，並擁有一個父Element。他們還提供了一個惟一的子元素過濾列表。

3、輸入

3.一、解析一個HTML字符串

　　1）存在問題

　　　　來自用戶輸入，一個文件或一個網站的HTML字符串，你可能須要對它進行解析並取其內容，或校驗其格式是否完整，

　　　　或想修改它。怎麼辦？ jsoup可以幫你輕鬆解決這些問題

　　2）解決方法

　　使用靜態Jsoup.parse(String html) 方法或 Jsoup.parse(String html, String baseUri)

String html = "<html><head><title>First parse</title></head>"
  + "<body><p>Parsed HTML into a doc.</p></body></html>";
Document doc = Jsoup.parse(html);

3）描述

parse(String html, String baseUri) 這方法可以將輸入的HTML解析爲一個新的文檔 (Document），參數 baseUri 是用來將相對 URL 轉成絕對URL，

　　　　並指定從哪一個網站獲取文檔。如這個方法不適用，你可使用 parse(String html) 方法來解析成HTML字符串如上面的示例。

只要解析的不是空字符串，就能返回一個結構合理的文檔，其中包含(至少) 一個head和一個body元素。

一旦擁有了一個Document，你就可使用Document中適當的方法或它父類 Element和Node中的方法來取得相關數據。

3.二、解析一個body片段

　　1）存在問題

　　假如你有一個HTML片段 (好比. 一個 div 包含一對 p 標籤; 一個不完整的HTML文檔) 想對它進行解析。這個HTML片段能夠是用戶提交的一條評論

　　　　或在一個CMS頁面中編輯body部分。

　　2）辦法

使用Jsoup.parseBodyFragment(String html)方法。

String html = "<div><p>Lorem ipsum.</p>";
Document doc = Jsoup.parseBodyFragment(html);
Element body = doc.body();

　　3）說明

parseBodyFragment 方法建立一個空殼的文檔，並插入解析過的HTML到body元素中。假如你使用正常的 Jsoup.parse(String html) 方法，

　　　一般你也能夠獲得相同的結果，可是明確將用戶輸入做爲 body片斷處理，以確保用戶所提供的任何糟糕的HTML都將被解析成body元素。

Document.body() 方法可以取得文檔body元素的全部子元素，與 doc.getElementsByTag("body")相同。

3.三、從一個URL加載一個Document

　　1）存在問題

　　　　你須要從一個網站獲取和解析一個HTML文檔，並查找其中的相關數據。

　　2）解決方法

　　　　使用 Jsoup.connect(String url)方法:

Document doc = Jsoup.connect("http://example.com/").get();
String title = doc.title();

3）說明

connect(String url) 方法建立一個新的 Connection, 和 get() 取得和解析一個HTML文件。若是從該URL獲取HTML時發生錯誤，便會拋出 IOException，應適當處理。

Connection 接口還提供一個方法鏈來解決特殊請求，具體以下：

  Document doc = Jsoup.connect("http://example.com";)
  .data("query", "Java")
  .userAgent("Mozilla")
  .cookie("auth", "token")
  .timeout(3000)
  .post();

這個方法只支持Web URLs (http和https 協議); 假如你須要從一個文件加載，可使用 parse(File in, String charsetName) 代替。

3.四、從一個文件加載文檔

　　1）存在問題

　　　　在本機硬盤上有一個HTML文件，須要對它進行解析從中抽取數據或進行修改。

　　2）方法

　　　　可使用靜態 Jsoup.parse(File in, String charsetName, String baseUri) 方法：

File input = new File("/tmp/input.html");
Document doc = Jsoup.parse(input, "UTF-8", "http://example.com/";);

3）說明

parse(File in, String charsetName, String baseUri) 這個方法用來加載和解析一個HTML文件。如在加載文件的時候發生錯誤，將拋出IOException，應做適當處理。

baseUri 參數用於解決文件中URLs是相對路徑的問題。若是不須要能夠傳入一個空的字符串。

另外還有一個方法parse(File in, String charsetName) ，它使用文件的路徑作爲 baseUri。這個方法適用於若是被解析文件位於網站的本地文件系統，

　　　　且相關連接也指向該文件系統。

4、數據抽取

4.一、使用DOM方法來遍歷一個文檔

　　1）存在問題

　　　　你有一個 HTML文檔要從中提取數據，並瞭解這個HTML文檔的結構。

　　2）方法

　　　　將HTML解析成一個Document以後，就可使用相似於DOM的方法進行操做。

File input = new File("/tmp/input.html");
Document doc = Jsoup.parse(input, "UTF-8", "http://example.com/");

Element content = doc.getElementById("content");
Elements links = content.getElementsByTag("a");
for (Element link : links) {
  String linkHref = link.attr("href");
  String linkText = link.text();
}

　　3）說明php

　　　　Elements這個對象提供了一系列相似於DOM的方法來查找元素，抽取並處理其中的數據。具體以下：css

　　　　A：查看元素html

　　　　getElementById(String id)
　　　　getElementsByTag(String tag)
　　　　getElementsByClass(String className)
　　　　getElementsByAttribute(String key) (and related methods)
　　　　Element siblings: siblingElements(), firstElementSibling(), lastElementSibling(); nextElementSibling(), previousElementSibling()
　　　　Graph: parent(), children(), child(int index)

　　　　B：元素數據java

　　　　attr(String key)獲取屬性attr(String key, String value)設置屬性
　　　　attributes()獲取全部屬性
　　　　id(), className() and classNames()
　　　　text()獲取文本內容text(String value) 設置文本內容
　　　　html()獲取元素內HTMLhtml(String value)設置元素內的HTML內容
　　　　outerHtml()獲取元素外HTML內容
　　　　data()獲取數據內容（例如：script和style標籤)
　　　　tag() and tagName()

　　　　C：操做HTML和文本node

　　　　append(String html), prepend(String html)
　　　　appendText(String text), prependText(String text)
　　　　appendElement(String tagName), prependElement(String tagName)
　　　　html(String value)

4.二、使用選擇器語法來查找元素

　　1）存在問題jquery

　　　　你想使用相似於CSS或jQuery的語法來查找和操做元素。web

　　2）方法正則表達式

　　　　可使用Element.select(String selector) 和 Elements.select(String selector) 方法實現：django

File input = new File("/tmp/input.html");
Document doc = Jsoup.parse(input, "UTF-8", "http://example.com/");

Elements links = doc.select("a[href]"); //帶有href屬性的a元素
Elements pngs = doc.select("img[src$=.png]");
  //擴展名爲.png的圖片

Element masthead = doc.select("div.masthead").first();
  //class等於masthead的div標籤

Elements resultLinks = doc.select("h3.r > a"); //在h3元素以後的a元素

　　3）說明cookie

　　　　jsoup elements對象支持相似於CSS (或jquery)的選擇器語法，來實現很是強大和靈活的查找功能。.

　　　　這個select 方法在Document, Element,或Elements對象中均可以使用。且是上下文相關的，所以可實現指定元素的過濾，或者鏈式選擇訪問。

　　　　Select方法將返回一個Elements集合，並提供一組方法來抽取和處理結果。

　　　　A：Selector選擇器概述　　　

　　　　　　tagname: 經過標籤查找元素，好比：a
　　　　　　ns|tag: 經過標籤在命名空間查找元素，好比：能夠用 fb|name 語法來查找 <fb:name> 元素
　　　　　　#id: 經過ID查找元素，好比：#logo
　　　　　　.class: 經過class名稱查找元素，好比：.masthead
　　　　　　[attribute]: 利用屬性查找元素，好比：[href]
　　　　　　[^attr]: 利用屬性名前綴來查找元素，好比：能夠用[^data-] 來查找帶有HTML5 Dataset屬性的元素
　　　　　　[attr=value]: 利用屬性值來查找元素，好比：[width=500]
　　　　　　[attr^=value], [attr$=value], [attr*=value]: 利用匹配屬性值開頭、結尾或包含屬性值來查找元素，好比：[href*=/path/]
　　　　　　[attr~=regex]: 利用屬性值匹配正則表達式來查找元素，好比： img[src~=(?i)\.(png|jpe?g)]
　　　　　　*: 這個符號將匹配全部元素

　　　　B：Selector選擇器組合使用

　　　　　　el#id: 元素+ID，好比： div#logo
　　　　　　el.class: 元素+class，好比： div.masthead
　　　　　　el[attr]: 元素+class，好比： a[href]
　　　　　　任意組合，好比：a[href].highlight
　　　　　　ancestor child: 查找某個元素下子元素，好比：能夠用.body p 查找在"body"元素下的全部 p元素
　　　　　　parent > child: 查找某個父元素下的直接子元素，好比：能夠用div.content > p 查找 p 元素，也能夠用body > * 查找body標籤下全部直接子元素
　　　　　　siblingA + siblingB: 查找在A元素以前第一個同級元素B，好比：div.head + div
　　　　　　siblingA ~ siblingX: 查找A元素以前的同級X元素，好比：h1 ~ p
　　　　　　el, el, el:多個選擇器組合，查找匹配任一選擇器的惟一元素，例如：div.masthead, div.logo

　　　　C：僞選擇器selectors

　　　　　　:lt(n): 查找哪些元素的同級索引值（它的位置在DOM樹中是相對於它的父節點）小於n，好比：td:lt(3) 表示小於三列的元素
　　　　　　:gt(n):查找哪些元素的同級索引值大於n，好比： div p:gt(2)表示哪些div中有包含2個以上的p元素
　　　　　　:eq(n): 查找哪些元素的同級索引值與n相等，好比：form input:eq(1)表示包含一個input標籤的Form元素
　　　　　　:has(seletor): 查找匹配選擇器包含元素的元素，好比：div:has(p)表示哪些div包含了p元素
　　　　　　:not(selector): 查找與選擇器不匹配的元素，好比： div:not(.logo) 表示不包含 class="logo" 元素的全部 div 列表
　　　　　　:contains(text): 查找包含給定文本的元素，搜索不區分大不寫，好比： p:contains(jsoup)
　　　　　　:containsOwn(text): 查找直接包含給定文本的元素
　　　　　　:matches(regex): 查找哪些元素的文本匹配指定的正則表達式，好比：div:matches((?i)login)
　　　　　　:matchesOwn(regex): 查找自身包含文本匹配指定正則表達式的元素
　　　　　　注意：上述僞選擇器索引是從0開始的，也就是

4.三、從元素抽取屬性，本文和HTML

　　1）存在問題

　　　　在解析得到一個Document實例對象，並查找到一些元素以後，你但願取得在這些元素中的數據。

　　2）方法　　

　　　　要取得一個屬性的值，可使用Node.attr(String key) 方法
　　　　對於一個元素中的文本，可使用Element.text()方法
　　　　對於要取得元素或屬性中的HTML內容，可使用Element.html(), 或 Node.outerHtml()方法

　　String html = "<p>An <a href='http://example.com/'><b>example</b></a> link.</p>";
　　Document doc = Jsoup.parse(html);//解析HTML字符串返回一個Document實現
　　Element link = doc.select("a").first();//查找第一個a元素

　　String text = doc.body().text(); // "An example link"//取得字符串中的文本
　　String linkHref = link.attr("href"); // "http://example.com/"//取得連接地址
　　String linkText = link.text(); // "example""//取得連接地址中的文本

　　String linkOuterH = link.outerHtml(); 
 　　   // "<a href="http://example.com"><b>example</b></a>"
　　String linkInnerH = link.html(); // "<b>example</b>"//取得連接內的html內容

　　3）說明　　

　　　　上述方法是元素數據訪問的核心辦法。此外還其它一些方法可使用：

　　　　Element.id()
　　　　Element.tagName()
　　　　Element.className() and Element.hasClass(String className)

　　　　這些訪問器方法都有相應的setter方法來更改數據.

4.四、處理URLs

　　1）存在問題

　　　　你有一個包含相對URLs路徑的HTML文檔，須要將這些相對路徑轉換成絕對路徑的URLs。

　　2）方法　　　　

　　　　在你解析文檔時確保有指定base URI，而後
　　　　使用 abs: 屬性前綴來取得包含base URI的絕對路徑。代碼以下：

　　Document doc = Jsoup.connect("http://www.open-open.com").get();

　　Element link = doc.select("a").first();
　　String relHref = link.attr("href"); // == "/"
　　String absHref = link.attr("abs:href"); // "http://www.open-open.com/"

　　3）說明

　　　　在HTML元素中，URLs常常寫成相對於文檔位置的相對路徑： <a href="/download">...</a>.

　　　　當你使用 Node.attr(String key) 方法來取得a元素的href屬性時，它將直接返回在HTML源碼中指定定的值。

　　　　假如你須要取得一個絕對路徑，須要在屬性名前加 abs: 前綴。這樣就能夠返回包含根路徑的URL地址attr("abs:href")

　　　　所以，在解析HTML文檔時，定義base URI很是重要。

　　　　若是你不想使用abs: 前綴，還有一個方法可以實現一樣的功能 Node.absUrl(String key)。

4.五、實例程序：獲取全部連連接

　　1）說明

　　　　這個示例程序將展現如何從一個URL得到一個頁面。而後提取頁面中的全部連接、圖片和其它輔助內容。並檢查URLs和文本信息。

　　2）運行下面程序須要執行一個URLs做爲參數

package org.jsoup.examples;

import org.jsoup.Jsoup;
import org.jsoup.helper.Validate;
import org.jsoup.nodes.Document;
import org.jsoup.nodes.Element;
import org.jsoup.select.Elements;

import java.io.IOException;

/**
 * Example program to list links from a URL.
 */
public class ListLinks {
    public static void main(String[] args) throws IOException {
        Validate.isTrue(args.length == 1, "usage: supply url to fetch");
        String url = args[0];
        print("Fetching %s...", url);

        Document doc = Jsoup.connect(url).get();
        Elements links = doc.select("a[href]");
        Elements media = doc.select("[src]");
        Elements imports = doc.select("link[href]");

        print("\nMedia: (%d)", media.size());
        for (Element src : media) {
            if (src.tagName().equals("img"))
                print(" * %s: <%s> %sx%s (%s)",
                        src.tagName(), src.attr("abs:src"), src.attr("width"), src.attr("height"),
                        trim(src.attr("alt"), 20));
            else
                print(" * %s: <%s>", src.tagName(), src.attr("abs:src"));
        }

        print("\nImports: (%d)", imports.size());
        for (Element link : imports) {
            print(" * %s <%s> (%s)", link.tagName(),link.attr("abs:href"), link.attr("rel"));
        }

        print("\nLinks: (%d)", links.size());
        for (Element link : links) {
            print(" * a: <%s>  (%s)", link.attr("abs:href"), trim(link.text(), 35));
        }
    }

    private static void print(String msg, Object... args) {
        System.out.println(String.format(msg, args));
    }

    private static String trim(String s, int width) {
        if (s.length() > width)
            return s.substring(0, width-1) + ".";
        else
            return s;
    }
}

　　3）查看結果

Fetching http://news.ycombinator.com/...

Media: (38)
 * img: <http://ycombinator.com/images/y18.gif> 18x18 ()
 * img: <http://ycombinator.com/images/s.gif> 10x1 ()
 * img: <http://ycombinator.com/images/grayarrow.gif> x ()
 * img: <http://ycombinator.com/images/s.gif> 0x10 ()
 * script: <http://www.co2stats.com/propres.php?s=1138>
 * img: <http://ycombinator.com/images/s.gif> 15x1 ()
 * img: <http://ycombinator.com/images/hnsearch.png> x ()
 * img: <http://ycombinator.com/images/s.gif> 25x1 ()
 * img: <http://mixpanel.com/site_media/images/mixpanel_partner_logo_borderless.gif> x (Analytics by Mixpan.)
 
Imports: (2)
 * link <http://ycombinator.com/news.css> (stylesheet)
 * link <http://ycombinator.com/favicon.ico> (shortcut icon)
 
Links: (141)
 * a: <http://ycombinator.com>  ()
 * a: <http://news.ycombinator.com/news>  (Hacker News)
 * a: <http://news.ycombinator.com/newest>  (new)
 * a: <http://news.ycombinator.com/newcomments>  (comments)
 * a: <http://news.ycombinator.com/leaders>  (leaders)
 * a: <http://news.ycombinator.com/jobs>  (jobs)
 * a: <http://news.ycombinator.com/submit>  (submit)
 * a: <http://news.ycombinator.com/x?fnid=JKhQjfU7gW>  (login)
 * a: <http://news.ycombinator.com/vote?for=1094578&dir=up&whence=%6e%65%77%73>  ()
 * a: <http://www.readwriteweb.com/archives/facebook_gets_faster_debuts_homegrown_php_compiler.php?utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+readwriteweb+%28ReadWriteWeb%29&utm_content=Twitter>  (Facebook speeds up PHP)
 * a: <http://news.ycombinator.com/user?id=mcxx>  (mcxx)
 * a: <http://news.ycombinator.com/item?id=1094578>  (9 comments)
 * a: <http://news.ycombinator.com/vote?for=1094649&dir=up&whence=%6e%65%77%73>  ()
 * a: <http://groups.google.com/group/django-developers/msg/a65fbbc8effcd914>  ("Tough. Django produces XHTML.")
 * a: <http://news.ycombinator.com/user?id=andybak>  (andybak)
 * a: <http://news.ycombinator.com/item?id=1094649>  (3 comments)
 * a: <http://news.ycombinator.com/vote?for=1093927&dir=up&whence=%6e%65%77%73>  ()
 * a: <http://news.ycombinator.com/x?fnid=p2sdPLE7Ce>  (More)
 * a: <http://news.ycombinator.com/lists>  (Lists)
 * a: <http://news.ycombinator.com/rss>  (RSS)
 * a: <http://ycombinator.com/bookmarklet.html>  (Bookmarklet)
 * a: <http://ycombinator.com/newsguidelines.html>  (Guidelines)
 * a: <http://ycombinator.com/newsfaq.html>  (FAQ)
 * a: <http://ycombinator.com/newsnews.html>  (News News)
 * a: <http://news.ycombinator.com/item?id=363>  (Feature Requests)
 * a: <http://ycombinator.com>  (Y Combinator)
 * a: <http://ycombinator.com/w2010.html>  (Apply)
 * a: <http://ycombinator.com/lib.html>  (Library)
 * a: <http://www.webmynd.com/html/hackernews.html>  ()
 * a: <http://mixpanel.com/?from=yc>  ()

5、數據修改

5.一、設置屬性值

　　1）存在問題　　　

　　　　在你解析一個Document以後可能想修改其中的某些屬性值，而後再保存到磁盤或都輸出到前臺頁面。

　　2）方法　

　　　　可使用屬性設置方法 Element.attr(String key, String value), 和 Elements.attr(String key, String value).

　　　　假如你須要修改一個元素的 class 屬性，可使用 Element.addClass(String className) 和 Element.removeClass(String className) 方法。

　　　　Elements 提供了批量操做元素屬性和class的方法，好比：要爲div中的每個a元素都添加一個 rel="nofollow" 可使用以下方法：

　　　　doc.select("div.comments a").attr("rel", "nofollow");

　　3）說明

　　　　與Element中的其它方法同樣，attr 方法也是返回當 Element (或在使用選擇器是返回 Elements 集合)。

　　　　這樣可以很方便使用方法連用的書寫方式。好比：

　　　　doc.select("div.masthead").attr("title", "jsoup").addClass("round-box");

5.二、設置一個元素的HTML內容

　　1）存在問題

　　　　你須要一個元素中的HTML的內容

　　2）方法

　　　　可使用Element中的HTML設置方法具體以下：

Element div = doc.select("div").first(); // <div></div>
div.html("<p>lorem ipsum</p>"); // <div><p>lorem ipsum</p></div>
div.prepend("<p>First</p>");//在div前添加html內容
div.append("<p>Last</p>");//在div以後添加html內容
// 添完後的結果: <div><p>First</p><p>lorem ipsum</p><p>Last</p></div>

Element span = doc.select("span").first(); // <span>One</span>
span.wrap("<li><a href='http://example.com/'></a></li>");
// 添完後的結果: <li><a href="http://example.com"><span>One</span></a></li>

　　3）說明

　　　　Element.html(String html) 這個方法將先清除元素中的HTML內容，而後用傳入的HTML代替。
　　　　Element.prepend(String first) 和 Element.append(String last) 方法用於在分別在元素內部HTML的前面和後面添加HTML內容
　　　　Element.wrap(String around) 對元素包裹一個外部HTML內容。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。