jsoup的使用

時間  2019-11-29
標籤 jsoup 使用 欄目 Java 简体版
原文   原文鏈接

API:

http://jsoup.org/apidocs/org/jsoup/select/Elements.html


http://www.open-open.com/jsoup/


方法

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

 
 
 
 

  
  
  
  
 
   
 
    [java] 
    view plain 
    copy 
    print 
    ? 
    
 
   
 
  

  
  
  
  
     
   
  1. File input = new File("/tmp/input.html");  
    2.  
   
  2. Document doc = Jsoup.parse(input, "UTF-8", "http://example.com/");  
    3.  
   
  3.   
    4.  
   
  4. Elements links = doc.select("a[href]"); //帶有href屬性的a元素  
    5.  
   
  5. Elements pngs = doc.select("img[src$=.png]");  
    6.  
   
  6.   //擴展名爲.png的圖片  
    7.  
   
  7.   
    8.  
   
  8. Element masthead = doc.select("div.masthead").first();  
    9.  
   
  9.   //class等於masthead的div標籤  
    10.  
   
  10.   
    11.  
   
  11. Elements resultLinks = doc.select("h3.r > a"); //在h3元素以後的a元素  
    12.

說明

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

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

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

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)]
  • *: 這個符號將匹配全部元素

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

僞選擇器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開始的，也就是說第一個元素索引值爲0，第二個元素index爲1等

能夠查看Selector API參考來了解更詳細的內容jquery

jsoup 簡介

Java 程序在解析 HTML 文檔時，相信你們都接觸過 htmlparser 這個開源項目，但如今我已經再也不使用 htmlparser 了，緣由是 htmlparser 不多更新，但最重要的是有了 jsoup 。css3

jsoup 是一款 Java 的 HTML 解析器，可直接解析某個 URL 地址、HTML 文本內容。它提供了一套很是省力的 API，可經過 DOM，CSS 以及相似於 jQuery 的操做方法來取出和操做數據。正則表達式

jsoup 的主要功能以下：api

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

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

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

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

jsoup 的主要類層次結構如圖 1 所示：

圖 1. jsoup 的類層次結構
圖 1. jsoup 的類層次結構

接下來咱們專門針對幾種常見的應用場景舉例說明 jsoup 是如何優雅的進行 HTML 文檔處理的。

回頁首

文檔輸入

jsoup 能夠從包括字符串、URL 地址以及本地文件來加載 HTML 文檔，並生成 Document 對象實例。

下面是相關代碼：

清單 1
 // 直接從字符串中輸入 HTML 文檔
 String html = "<html><head><title> 開源中國社區 </title></head>"
  + "<body><p> 這裏是 jsoup 項目的相關文章 </p></body></html>"; 
 Document doc = Jsoup.parse(html); 

 // 從 URL 直接加載 HTML 文檔
 Document doc = Jsoup.connect("http://www.oschina.net/").get(); 
 String title = doc.title(); 

 Document doc = Jsoup.connect("http://www.oschina.net/") 
  .data("query", "Java")   // 請求參數
  .userAgent("I ’ m jsoup") // 設置 User-Agent 
  .cookie("auth", "token") // 設置 cookie 
  .timeout(3000)           // 設置鏈接超時時間
  .post();                 // 使用 POST 方法訪問 URL 

 // 從文件中加載 HTML 文檔
 File input = new File("D:/test.html"); 
 Document doc = Jsoup.parse(input,"UTF-8","http://www.oschina.net/");

請你們注意最後一種 HTML 文檔輸入方式中的 parse 的第三個參數，爲何須要在這裏指定一個網址呢（雖然能夠不指定，如第一種方法）？由於 HTML 文檔中會有不少例如連接、圖片以及所引用的外部腳本、css 文件等，而第三個名爲 baseURL 的參數的意思就是當 HTML 文檔使用相對路徑方式引用外部文件時，jsoup 會自動爲這些 URL 加上一個前綴，也就是這個 baseURL。

例如 <a href=/project> 開源軟件 </a> 會被轉換成 <a href=http://www.oschina.net/project> 開源軟件 </a>。

回頁首

解析並提取 HTML 元素

這部分涉及一個 HTML 解析器最基本的功能，但 jsoup 使用一種有別於其餘開源項目的方式——選擇器，咱們將在最後一部分詳細介紹 jsoup 選擇器，本節中你將看到 jsoup 是如何用最簡單的代碼實現。

不過 jsoup 也提供了傳統的 DOM 方式的元素解析，看看下面的代碼：

清單 2.
 File input = new File("D:/test.html"); 
 Document doc = Jsoup.parse(input, "UTF-8", "http://www.oschina.net/"); 

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

你可能會以爲 jsoup 的方法似曾相識，沒錯，像 getElementById 和 getElementsByTag 方法跟 JavaScript 的方法名稱是同樣的，功能也徹底一致。你能夠根據節點名稱或者是 HTML 元素的 id 來獲取對應的元素或者元素列表。

與 htmlparser 項目不一樣的是，jsoup 並無爲 HTML 元素定義一個對應的類，通常一個 HTML 元素的組成部分包括：節點名、屬性和文本，jsoup 提供簡單的方法供你本身檢索這些數據，這也是 jsoup 保持瘦身的緣由。

而在元素檢索方面，jsoup 的選擇器簡直無所不能，

清單 3.
 File input = new File("D:\test.html"); 
 Document doc = Jsoup.parse(input,"UTF-8","http://www.oschina.net/"); 

 Elements links = doc.select("a[href]"); // 具備 href 屬性的連接
 Elements pngs = doc.select("img[src$=.png]");// 全部引用 png 圖片的元素


 Element masthead = doc.select("div.masthead").first(); 
 // 找出定義了 class=masthead 的元素

 Elements resultLinks = doc.select("h3.r > a"); // direct a after h3

這是 jsoup 真正讓我折服的地方，jsoup 使用跟 jQuery 如出一轍的選擇器對元素進行檢索，以上的檢索方法若是換成是其餘的 HTML 解釋器，至少都須要不少行代碼，而 jsoup 只須要一行代碼便可完成。

jsoup 的選擇器還支持表達式功能，咱們將在最後一節介紹這個超強的選擇器。

回頁首

修改數據

在解析文檔的同時，咱們可能會須要對文檔中的某些元素進行修改，例如咱們能夠爲文檔中的全部圖片增長可點擊連接、修改連接地址或者是修改文本等。

下面是一些簡單的例子：

清單 4.
 doc.select("div.comments a").attr("rel", "nofollow"); 
 // 爲全部連接增長 rel=nofollow 屬性
 doc.select("div.comments a").addClass("mylinkclass"); 
 // 爲全部連接增長 class=mylinkclass 屬性
 doc.select("img").removeAttr("onclick"); // 刪除全部圖片的 onclick 屬性
 doc.select("input[type=text]").val(""); // 清空全部文本輸入框中的文本

道理很簡單，你只須要利用 jsoup 的選擇器找出元素，而後就能夠經過以上的方法來進行修改，除了沒法修改標籤名外（能夠刪除後再插入新的元素），包括元素的屬性和文本均可以修改。

修改完直接調用 Element(s) 的 html() 方法就能夠獲取修改完的 HTML 文檔。

回頁首

HTML 文檔清理

jsoup 在提供強大的 API 同時，人性化方面也作得很是好。在作網站的時候，常常會提供用戶評論的功能。有些用戶比較淘氣，會搞一些腳本到評論內容中，而這些腳本可能會破壞整個頁面的行爲，更嚴重的是獲取一些機要信息，例如 XSS 跨站點攻擊之類的。

jsoup 對這方面的支持很是強大，使用很是簡單。看看下面這段代碼：

清單 5.
 String unsafe = "<p><a href='http://www.oschina.net/' onclick='stealCookies()'> 
 開源中國社區 </a></p>"; 
 String safe = Jsoup.clean(unsafe, Whitelist.basic()); 
 // 輸出 : 
 // <p><a href="http://www.oschina.net/" rel="nofollow"> 開源中國社區 </a></p>

jsoup 使用一個 Whitelist 類用來對 HTML 文檔進行過濾，該類提供幾個經常使用方法：

表 1. 經常使用方法：
方法名 簡介
none() 只容許包含文本信息
basic() 容許的標籤包括：a, b, blockquote, br, cite, code, dd, dl, dt, em, i, li, ol, p, pre, q, small, strike, strong, sub, sup, u, ul, 以及合適的屬性
simpleText() 只容許 b, em, i, strong, u 這些標籤
basicWithImages() 在 basic() 的基礎上增長了圖片
relaxed() 這個過濾器容許的標籤最多，包括：a, b, blockquote, br, caption, cite, code, col, colgroup, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, i, img, li, ol, p, pre, q, small, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, u, ul

若是這五個過濾器都沒法知足你的要求呢，例如你容許用戶插入 flash 動畫，不要緊，Whitelist 提供擴展功能，例如 whitelist.addTags("embed","object","param","span","div"); 也可調用 addAttributes 爲某些元素增長屬性。

回頁首

jsoup 的過人之處——選擇器

前面咱們已經簡單的介紹了 jsoup 是如何使用選擇器來對元素進行檢索的。本節咱們把重點放在選擇器自己強大的語法上。下表是 jsoup 選擇器的全部語法詳細列表。

表 2. 基本用法：
tagname 使用標籤名來定位，例如 a
ns|tag 使用命名空間的標籤訂位，例如 fb:name 來查找 <fb:name> 元素
#id 使用元素 id 定位，例如 #logo
.class 使用元素的 class 屬性定位，例如 .head
[attribute] 使用元素的屬性進行定位，例如 [href] 表示檢索具備 href 屬性的全部元素
[^attr] 使用元素的屬性名前綴進行定位，例如 [^data-] 用來查找 HTML5 的 dataset 屬性
[attr=value] 使用屬性值進行定位，例如 [width=500] 定位全部 width 屬性值爲 500 的元素
[attr^=value], [attr$=value], [attr*=value] 這三個語法分別表明，屬性以 value 開頭、結尾以及包含
[attr~=regex] 使用正則表達式進行屬性值的過濾，例如 img[src~=(?i)\.(png|jpe?g)]
* 定位全部元素

以上是最基本的選擇器語法，這些語法也能夠組合起來使用，下面是 jsoup 支持的組合用法：

表 3：組合用法：
el#id 定位 id 值某個元素，例如 a#logo -> <a id=logo href= … >
el.class 定位 class 爲指定值的元素，例如 div.head -> <div class=head>xxxx</div>
el[attr] 定位全部定義了某屬性的元素，例如 a[href]
以上三個任意組合 例如 a[href]#logo 、a[name].outerlink
ancestor child 這五種都是元素之間組合關係的選擇器語法，其中包括父子關係、合併關係和層次關係。
parent > child
siblingA + siblingB
siblingA ~ siblingX
el, el, el

除了一些基本的語法以及這些語法進行組合外，jsoup 還支持使用表達式進行元素過濾選擇。下面是 jsoup 支持的全部表達式一覽表：

表 4. 表達式：
:lt(n) 例如 td:lt(3) 表示 小於三列
:gt(n) div p:gt(2) 表示 div 中包含 2 個以上的 p
:eq(n) form input:eq(1) 表示只包含一個 input 的表單
:has(seletor) div:has(p) 表示包含了 p 元素的 div
:not(selector) div:not(.logo) 表示不包含 class=logo 元素的全部 div 列表
:contains(text) 包含某文本的元素，不區分大小寫，例如 p:contains(oschina)
:containsOwn(text) 文本信息徹底等於指定條件的過濾
:matches(regex) 使用正則表達式進行文本過濾：div:matches((?i)login)
:matchesOwn(regex) 使用正則表達式找到自身的文本
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程