jsoup 简介
jsoup 是一款 Java 的 HTML 解析器，可直接解析某个 URL 地址、HTML 文本内容。它提供了一套非常省力的 API，可通过 DOM，CSS 以及类似于 jQuery 的操作方法来取出和操作数据。
jsoup 的主要功能如下：
1. 从一个 URL，文件或字符串中解析 HTML；
2. 使用 DOM 或 CSS 选择器来查找、取出数据；
3. 可操作 HTML 元素、属性、文本；
jsoup 是基于 MIT 协议发布的，可放心使用于商业项目。
jsoup 的主要类层次结构如图 1 所示：
图 1. jsoup 的类层次结构
文档输入
Jsoup可以从字符串，url地址，及本地文件加载HTML文档，并生成Document对象实例
<span style="white-space:pre"> </span>// 直接从字符串输入html文档
String html = "<html><head><title>gao_zhishi</title></head>"
+ "<body><p>jsoup文章</p></body></html>";
Document doc = Jsoup.parse(html);
// 从url直接加在html文档
Document doc1 = Jsoup.connect(
"http://blog.csdn.net/gao_zhishi/article/details/28595765")
.get();
Document doc2 = Jsoup.connect("http://blog.csdn.net/gao_zhishi/article/details/28595765")
.data("query", "Java") // 请求参数
.userAgent("I ’ m jsoup") // 设置 User-Agent
.cookie("auth", "token") // 设置 cookie
.timeout(3000) // 设置连接超时时间
.post(); // 使用 POST 方法访问 URL
// 从文件中加在html文档
File input=new File("D:/text.html");
Document doc3=Jsoup.parse(input,
"UTF-8",
"http://blog.csdn.net/gao_zhishi/article/details/28595765");文件加载html中parse的第三个参数，需要指定一个html。以为HTML文档中会有很多列入链接，图片以及所应用的外部脚本、CSS文件等，第三个参数的意思就是当HTML文档使用相对路径方式引用外部文件时，jsoup会自动为这些URl加上前缀，也就是这个baseurl
例如 <a href=/project> 123 </a> 会被转换成 <a href=http://blog.csdn.net/gao_zhishi/article/details/28595765/project> 123</a>
解析并提取HTML元素
DOM式的元素解析
<span style="white-space: pre;"> </span>Element content = doc.getElementById("content"); //根据元素idElements links = content.getElementsByTag("a"); //根据节点名for (Element link : links) {String linkHref = link.attr("href");String linkText = link.text();getElementById和getElementsByTag方法与JavaScript 的方法功能是一样的，可以根据节点名称或者HTML元素的id来获取对应的元素或元素列表。
Jsoup的选择器
类似于CSS或jQuery的语法来查找和操作元素
Document doc = Jsoup.parseBodyFragment("temp");
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 resultLLinks = doc.select("h3.r>a"); //在h3元素之后的a元素
jsoup elements对象支持类似于CSS(或jquery)的选择器语法，来实现非常强大和灵活的查找功能。这个select方法在Document,Element或Elements对象
中都可以使用。且是上下文相关的，因此可实现指定元素的过滤，或者链式选择访问。Select方法返回一个Elements集合。
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参考来了解更详细的内容
元素中抽取属性，文本和HTML
masthead.attr(String key); //key属性的值
Element.text(); //Element的文本
Element.html(); //元素中的htmlNode.outerHtml(); //属性中的html
<span style="font-weight: bold; white-space: pre;"> </span> 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内容说明
上述方法是元素数据访问的核心办法。此外还其它一些方法可以使用：
- Element.id()
- Element.tagName()
- Element.className() and Element.hasClass(String className)
这些访问器方法都有相应的setter方法来更改数据.
处理Urls
- 在你解析文档时确保有指定base URI，然后
- 使用 abs: 属性前缀来取得包含base URI的绝对路径。代码如下：
<span style="white-space:pre"> </span>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)。
设置属性的值
可以使用属性设置方法 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>
可以使用
Element中的HTML设置方法具体如下：
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) 方法来创建新的元素并作为文档的子元 素插入其中。
设置元素的文本内容
方法
可以使用
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（防止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攻击，还可以限制用户可以输入的标签范围。
参见
- 参阅XSS cheat sheet ，有一个例子可以了解为什么不能使用正则表达式，而采用安全的whitelist parser-based清理器才是正确的选择
- 参阅Cleaner ，了解如何返回一个 Document 对象，而不是字符串
- 参阅Whitelist，了解如何创建一个自定义的whitelist
- nofollow 链接属性了解
参考资料http://www.open-open.com/jsoup/whitelist-sanitizer.htm，转载注明出处
扫一扫
569
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
