概述
jsoup 是一款Java 的HTML解析器，可直接解析某个URL地址、HTML文本内容。它提供了一套很省力的API，可通过DOM，CSS以及类似于jQuery的操作方法来取出和操作数据。jsoup的主要功能例如以下：
========================================================================================================
入门
1.解析和遍历一个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文档来创见一个干净的解析结果。不管HTML的格式是否完整。比方它可以处理：
- 没有关闭的标签 (比方：
<p>Lorem <p>Ipsumparses to<p>Lorem</p> <p>Ipsum</p>) - 隐式标签 (比方. 它能够自己主动将
<td>Table data</td>包装成<table><tr><td>?) - 创建可靠的文档结构（html标签包括head 和 body，在head仅仅出现恰当的元素）
一个文档的对象模型
- 文档由多个Elements和TextNodes组成 (以及其他辅助nodes：具体可查看：nodes package tree).
- 其继承结构例如以下：
Document继承Element继承Node.TextNode继承Node. - 一个Element包括一个子节点集合。并拥有一个父Element。他们还提供了一个唯一的子元素过滤列表。
參见
- 数据抽取：DOM遍历
- 数据抽取：Selector syntax
输入
2.解析一个html字符串
存在问题
来自用户输入，一个文件或一个站点的HTML字符串，你可能须要对它进行解析并取其内容，或校验其格式是否完整，或想改动它。
怎么办？jsonu可以帮你轻松解决这些问题
解决方法
使用静态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);
描写叙述
parse(String html, String baseUri) 这方法可以将输入的HTML解析为一个新的文档
(Document），參数 baseUri 是用来将相对 URL 转成绝对URL，并指定从哪个站点获取文档。如这种方法不适用。你能够使用 parse(String html)
方法来解析成HTML字符串如上面的演示样例。.
仅仅要解析的不是空字符串，就能返回一个结构合理的文档，当中包括(至少) 一个head和一个body元素。
一旦拥有了一个Document，你就能够使用Document中适当的方法或它父类 Element和Node中的方法来取得相关数据。
========================================================================================================
3.解析一个body片断
存在问题
你须要从一个站点获取和解析一个HTML文档。并查找当中的相关数据。你能够使用以下解决方法：
解决方法
使用 Jsoup.connect(String url)方法:
Document doc = Jsoup.connect("http://example.com/").get();
String title = doc.title();
说明
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) 取代。
问题
假如你有一个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();
说明
parseBodyFragment 方法创建一个空壳的文档，并插入解析过的HTML到body元素中。假如你使用正常的Jsoup.parse(String
html) 方法。通常你也能够得到同样的结果，可是明白将用户输入作为 body片段处理。以确保用户所提供的不论什么糟糕的HTML都将被解析成body元素。
Document.body() 方法可以取得文档body元素的全部子元素，与doc.getElementsByTag("body")同样。
保证安全Stay safe
假如你能够让用户输入HTML内容，那么要小心避免跨站脚本攻击。利用基于 Whitelist
的清除器和clean(String
bodyHtml, Whitelist whitelist)方法来清除用户输入的恶意内容。
========================================================================================================
4.从一个URL载入一个Document对象
存在问题
你须要从一个站点获取和解析一个HTML文档，并查找当中的相关数据。
你能够使用以下解决方法：
解决方法
使用 Jsoup.connect(String url)方法:
Document doc = Jsoup.connect("http://example.com/").get();
String title = doc.title();
说明
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) 取代。
========================================================================================================
5.依据一个文件载入Document对象
问题
在本机硬盘上有一个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/");
说明
parse(File in, String charsetName, String baseUri)
这种方法用来载入和解析一个HTML文件。如在载入文件的时候错误发生。将抛出IOException，应作适当处理。
baseUri 參数用于解决文件里URLs是相对路径的问题。假设不须要能够传入一个空的字符串。
另外另一个方法parse(File in, String charsetName) 。它使用文件的路径做为baseUri。
这种方法适用于假设被解析文件位于站点的本地文件系统，且相关链接也指向该文件系统。
========================================================================================================
数据抽取
6.使用dom方法来遍历一个Document对象
问题
你有一个HTML文档要从中提取数据，并了解这个HTML文档的结构。
方法
将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();
}
说明
Elements这个对象提供了一系列类似于DOM的方法来查找元素，抽取并处理当中的数据。
详细例如以下：
查找元素
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)
元素数据
attr(String key)获取属性attr(String key, String value)设置属性attributes()获取全部属性id(),className()andclassNames()text()获取文本内容text(String value)设置文本内容html()获取元素内HTMLhtml(String value)设置元素内的HTML内容outerHtml()获取元素外HTML内容data()获取数据内容（比如：script和style标签)tag()andtagName()
操作HTML和文本
========================================================================================================
7.使用选择器语法来查找元素
问题
你想使用类似于CSS或jQuery的语法来查找和操作元素。
方法
能够使用Element.select(String selector)
和 Elements.select(String selector) 方法实现：
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元素
说明
jsoup elements对象支持类似于CSS (或jquery)的选择器语法。来实现很强大和灵活的查找功能。
.
这个select 方法在Document,Element,或Elements对象中都能够使用。且是上下文相关的，因此可实现指定元素的过滤，或者链式选择訪问。
Select方法将返回一个Elements集合。并提供一组方法来抽取和处理结果。
Selector选择器概述
tagname: 通过标签查找元素，比方：ans|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#logoel.class: 元素+class，比方：div.mastheadel[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 + divsiblingA ~ siblingX: 查找A元素之前的同级X元素，比方：h1 ~ pel, 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參考来了解更具体的内容
========================================================================================================
8.从元素集合抽取属性、文本和html内容
问题
在解析获得一个Document实例对象，并查找到一些元素之后，你希望取得在这些元素中的数据。
方法
- 要取得一个属性的值，能够使用
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内容
说明
上述方法是元素数据訪问的核心办法。此外还其他一些方法能够使用：
这些訪问器方法都有对应的setter方法来更改数据.
參见
Element和Elements集合类的參考文档- URLs处理
- 使用CSS选择器语法来查找元素
========================================================================================================
9.URL处理
问题
你有一个包括相对URLs路径的HTML文档，须要将这些相对路径转换成绝对路径的URLs。
方法
- 在你解析文档时确保有指定
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/"
说明
在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)。
========================================================================================================
10.程序演示样例：获取全部链接
这个演示样例程序将展示怎样从一个URL获得一个页面。
然后提取页面中的全部链接、图片和其他辅助内容。
并检查URLs和文本信息。
执行以下程序须要指定一个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("
Media: (%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("
Imports: (%d)", imports.size());
for (Element link : imports) {
print(" * %s <%s> (%s)", link.tagName(),link.attr("abs:href"), link.attr("rel"));
}
print("
Links: (%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;
}
}演示样例输入结果
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> ()
数据改动
11.设置属性值
问题
在你解析一个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");
========================================================================================================
12.设置元素的html内容
问题
你须要一个元素中的HTML内容
方法
能够使用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>
说明
Element.html(String html)这种方法将先清除元素中的HTML内容。然后用传入的HTML取代。Element.prepend(String first)和Element.append(String last)方法用于在分别在元素内部HTML的前面和后面加入HTML内容Element.wrap(String around)对元素包裹一个外部HTML内容。
參见
能够查看API參考文档中 Element.prependElement(String
tag)和Element.appendElement(String tag)
方法来创建新的元素并作为文档的子元素插入当中。
========================================================================================================
13.设置元素的文本内容
问题
你须要改动一个HTML文档中的文本内容
方法
能够使用Element的设置方法：:
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>
说明
文本设置方法与 HTML setter 方法一样：
Element.text(String text)将清除一个元素中的内部HTML内容。然后提供的文本进行取代Element.prepend(String first)和Element.append(String last)将分别在元素的内部html前后加入文本节点。
对于传入的文本假设含有像 <, > 等这种字符。将以文本处理。而非HTML。
HTML清理
14.消除不受信任的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并可以让用户可视化编辑。尽管他们可以在client进行校验，可是这样还不够安全，须要在server端进行校验并清除有害的HTML代码。这样才干确保输入到你站点的HTML是安全的。否则。攻击者可以绕过client的Javascript验证，并注入不安全的HMTL直接进入您的站点。
jsoup的whitelist清理器可以在server端对用户输入的HTML进行过滤，仅仅输出一些安全的标签和属性。
jsoup提供了一系列的Whitelist基本配置，可以满足大多数要求。但如有必要。也可以进行改动。只是要小心。
这个cleaner很好用不仅能够避免XSS攻击。还能够限制用户能够输入的标签范围。
參见
- 參阅XSS cheat sheet 。有一个样例能够了解为什么不能使用正則表達式，而採用安全的whitelist parser-based清理器才是正确的选择。
- 參阅
Cleaner，了解怎样返回一个Document对象。而不是字符串 - 參阅
Whitelist。了解怎样创建一个自己定义的whitelist - nofollow 链接属性了
jsoup 的基本功能到这里就介绍完成，但因为jsoup 良好的可扩展性API 设计，你能够通过选择器的定义来开发出很强大的HTML 解析功能。
再加上jsoup 项目本身的开发也很活跃，因此假设你正在使用Java 。须要对HTML 进行处理。最好还是试试。
版权声明：本文博主原创文章，博客，未经同意不得转载。