Jsoup—解析HTML頁面資料的工具
介紹:
GitHub原始碼 點選檢視
程式碼jar包 點選下載
Jsoup是一款比較好的Java版HTML解析器。可直接解析某個URL地址、HTML文字內容。它提供了一套非常省力的API,可通過DOM,CSS以及類似於jQuery的操作方法來取出和操作資料。
jSOUP主要功能
從一個URL,檔案或字串中解析HTML;
使用DOM或CSS選擇器來查詢、取出資料;
可操作HTML元素、屬性、文字;
依賴
compile 'org.jsoup:jsoup:1.10.2'
- 1
使用方法:
jsoup 可以從包括字串、URL地址以及本地檔案來載入HTML 文件,並生成Document物件例項。
1、Document物件(一個文件的物件模型):文件由多個Elements和TextNodes組成 (以及其它輔助nodes:詳細可檢視:nodes package tree).
2、一個Element包含一個子節點集合,並擁有一個父Element。他們還提供了一個唯一的子元素過濾列表。
1、從字串中輸入HTML文件
使用靜態方法Jsoup.parse(String html) 或 Jsoup.parse(String html, String baseUri)
String html = "<html><head><title>開源中國社群</title></head>"
+"<body><p>這裡是jsoup 專案的相關文章</p></body></html>";
Document doc = Jsoup.parse(html);
說明:
其解析器能夠盡最大可能從你提供的HTML文件來創見一個乾淨的解析結果,無論HTML的格式是否完整。比如它可以處理:
1、沒有關閉的標籤 (比如: <p>Lorem <p >Ipsum 解析為 <p>Lorem</p> <p>Ipsum</p>)
2、 隱式標籤 (比如:它可以自動將 <td>Table data</td>包裝成<table><tr><td>?)
3、建立可靠的文件結構(html標籤包含head 和 body,在head只出現恰當的元素)
parse(String html, String baseUri) 這個方法能夠將輸入的HTML解析為一個新的文件 (Document),引數 baseUri 是用來將相對 URL 轉成絕對URL,並指定從哪個網站獲取文件。如這個方法不適用,你可以使用
parse(String html) 方法來解析成HTML字串如上面的示例。 只要解析的不是空字串,就能返回一個結構合理的文件,其中包含(至少) 一個head和一個body元素。 一旦擁有了一個Document,你就可以使用Document中適當的方法或它父類 Element 和 Node 中的方法來取得相關資料
解析一個body片斷
假如你有一個HTML片斷 (比如. 一個 div 包含一對 p 標籤; 一個不完整的HTML文件) 想對它進行解析。這個HTML片斷可以是使用者提交的一條評論或在一個CMS頁面中編輯body部分。可以使用Jsoup.parseBodyFragment(String html) 方法.
String html = "<div><p>Lorem ipsum.</p>";
Document doc = Jsoup.parseBodyFragment(html);
Element body = doc.body();
說明:
1、parseBodyFragment 方法建立一個空殼的文件,並插入解析過的HTML到body元素中。
假如你使用正常的 Jsoup.parse(String html) 方法,通常你也可以得到相同的結果,但是明確將使用者輸入作為 body片段處理,以確保使用者所提供的任何糟糕的HTML都將被解析成body元素。
2、 Document.body() 方法能夠取得文件body元素的所有子元素,與 doc.getElementsByTag(“body”)相同。
2、從URL直接載入HTML文件
從一個網站獲取和解析一個HTML文件,並查詢其中的相關資料,可以使用 Jsoup.connect(String url)方法。
Document doc =Jsoup.connect("網址/").get();
String title = doc.title();
Document doc =Jsoup.connect("網址/")
.data("query", "Java") //請求引數
.userAgent("I’mjsoup") //設定User-Agent
.cookie("auth", "token") //設定cookie
.timeout(3000) //設定連線超時時間
.post(); //使用POST方法訪問URL
說明:
1、connect(String url) 方法建立一個新的 Connection 和 get() 取得和解析一個HTML檔案。如果從該URL獲取HTML時發生錯誤,便會丟擲 IOException,應適當處理。
2、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、從檔案中載入HTML文件
在本機硬碟上有一個HTML檔案,需要對它進行解析從中抽取資料或進行修改。可以使用靜態 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/");
說明:
1、parse(File in, String charsetName, String baseUri) 這個方法用來載入和解析一個HTML檔案。如在加 載檔案的時候發生錯誤,將丟擲IOException,應作適當處理。
2、baseUri引數用於解決檔案中URLs是相對路徑的問題。如果不需要可以傳入一個空的字串。
3、另外還有一個方法parse(File in, String charsetName) 它使用檔案的路徑做為 baseUri。 這個方法適用 於如果被解析檔案位於網站的本地檔案系統,且相關連結也指向該檔案系統。
4、使用選擇器語法來查詢元素(select)
使用 Element.select(String selector) 和 Elements.select(String selector),使用類似於CSS或jQuery的語法來查詢和操作元素。
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元素
5、從元素抽取屬性,文字和HTML
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內容
6、處理URLs
有一個包含相對URLs路徑的HTML文件,需要將這些相對路徑轉換成絕對路徑的URLs。
在解析文件時確保有指定baseURI,
然後使用 abs: 屬性字首來取得包含baseURI的絕對路徑
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/"
說明:
在HTML元素中,URLs經常寫成相對於文件位置的相對路徑: …. 當你使用 Node.attr(String key) 方法來取得a元素的href屬性時,它將直接返回在HTML原始碼中指定的值。
假如你需要取得一個絕對路徑,需要在屬性名前加 abs: 字首。這樣就可以返回包含根路徑的URL地址attr(“abs:href”),因此,在解析HTML文件時,定義baseURI非常重要。
如果你不想使用abs: 字首,還有一個方法能夠實現同樣的功能 Node.absUrl(String key)。
7、資料修改
設定屬性的值
在解析一個Document之後可能想修改其中的某些屬性值,然後再儲存到磁碟或都輸出到前臺頁面。
可以使用屬性設定方法 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");
說明:與Element 中的其它方法一樣,attr 方法也是返回當前 Element (或在使用選擇器是返回 Elements 集合)。這樣能夠很方便使用方法連用的書寫方式。比如:
doc.select("div.masthead").attr("title", "jsoup").addClass("round-box");
設定一個元素的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>
設定元素的文字內容
Element div = doc.select("div").first(); // <div></div>
div.text("five > four"); // <div>five > four</div>
div.prepend("First ");
div.append(" Last");
// now: <div>First five > four Last</div>
8:HTML清理
消除不受信任的HTML (防止XSS攻擊)
在做網站的時候,經常會提供使用者評論的功能。有些不懷好意的使用者,會搞一些指令碼到評論內容中,而這些指令碼可能會破壞整個頁面的行為,更嚴重的是獲取一些機要資訊,此時需要清理該HTML,以避免跨站指令碼cross-site scripting攻擊(XSS)。
使用jsoup HTML Cleaner 方法進行清除,但需要指定一個可配置的 Whitelist。
String unsafe = "<p><a href='http://example.com/' onclick='stealCookies()'>Link</a></p>";
String safe = Jsoup.clean(unsafe, Whitelist.basic());
// now: <p><a href="http://example.com/" rel="nofollow">Link</a></p>
說明:
XSS又叫CSS (Cross Site Script) ,跨站指令碼攻擊。它指的是惡意攻擊者往Web頁面裡插入惡意html程式碼,當用戶瀏覽該頁之時,嵌入其中Web裡面的html程式碼會被執行,從而達到惡意攻擊使用者的特殊目的。XSS屬於被動式的攻擊,因為其被動且不好利用,所以許多人常忽略其危害性。所以我們經常只讓使用者輸入純文字的內容,但這樣使用者體驗就比較差了。
一個更好的解決方法就是使用一個富文字編輯器WYSIWYG如CKEditor 和 TinyMCE。這些可以輸出HTML並能夠讓使用者視覺化編輯。雖然他們可以在客戶端進行校驗,但是這樣還不夠安全,需要在伺服器端進行校驗並清除有害的HTML程式碼,這樣才能確保輸入到你網站的HTML是安全的。否則,攻擊者能夠繞過客戶端的JavaScript驗證,並注入不安全的HMTL直接進入您的網站。
jsoup的whitelist清理器能夠在伺服器端對使用者輸入的HTML進行過濾,只輸出一些安全的標籤和屬性。
jsoup提供了一系列的Whitelist基本配置,能夠滿足大多數要求;但如有必要,也可以進行修改,不過要小心。
這個cleaner非常好用不僅可以避免XSS攻擊,還可以限制使用者可以輸入的標籤範圍。
jsoup 使用一個 Whitelist 類用來對 HTML 文件進行過濾,該類提供幾個常用方法:
whitelist常用方法
API檢視:whitelist
參考:
select用法詳解
jsoup 總結
CSDN的參考