jsoup中文API

Lorem ipsum.

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\ .userAgent(\"Mozilla\") .cookie(\"auth\ .timeout(3000) .post();

这个方法只支持Web URLs (http和https协议); 假如你需要从一个文件加载，可以使用

parse(File in, String charsetName)代替。

5.从一个文件加载一个文档

问题

在本机硬盘上有一个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方法来遍历一个文档

问题

你有一个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() and classNames()

text()获取文本内容text(String value)设置文本内容

html()获取元素内HTMLhtml(String value)设置元素内的HTML内容 outerHtml()获取元素外HTML内容

data()获取数据内容（例如：script和style标签) tag() and tagName()

操作HTML和文本

append(String html), prepend(String html)

 appendText(String text), prependText(String text)

 appendElement(String tagName), prependElement(String

tagName)

 html(String value)



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: 通过标签查找元素，比如：a

ns|tag: 通过标签在命名空间查找元素，比如：可以用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参考来了解更详细的内容

8.从元素抽取属性，文本和HTML

问题

在解析获得一个Document实例对象，并查找到一些元素之后，你希望取得在这些元素中的数据。

方法

  

要取得一个属性的值，可以使用Node.attr(String key)方法 对于一个元素中的文本，可以使用Element.text()方法

对于要取得元素或属性中的HTML内容，可以使用Element.html(), 或

Node.outerHtml()方法

示例：

String html = \"

An href='http://example.com/'>example link.

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();

// \"example\" String linkInnerH = link.html(); // \"example\"//取得链接内的html内容

说明

上述方法是元素数据访问的核心办法。此外还其它一些方法可以使用：

Element.id()

 Element.tagName()

 Element.className() and Element.hasClass(String className)



这些访问器方法都有相应的setter方法来更改数据.

参见

  

Element和Elements集合类的参考文档

URLs处理

使用CSS选择器语法来查找元素

9.处理URLs

问题

你有一个包含相对URLs路径的HTML文档，需要将这些相对路径转换成绝对路径的URLs。

方法

1. 在你解析文档时确保有指定base URI，然后

2. 使用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经常写成相对于文档位置的相对路径：

.... 当你使用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...\

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)\ 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.attr(\"abs:src\")); }

print(\"\\nImports: (%d)\ for (Element link : imports) { print(\" * %s <%s> (%s)\

link.tagName(),link.attr(\"abs:href\"), link.attr(\"rel\")); }

print(\"\\nLinks: (%d)\ for (Element link : links) {

print(\" * a: <%s> (%s)rim(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; } }

org/jsoup/examples/ListLinks.java

示例输入结果

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

Media: (38)

* img: 18x18 () * img: 10x1 ()

* img: x () * img: 0x10 () * script: * img: 15x1 ()

* img: x () * img: 25x1 () * img:

x (Analytics by Mixpan.)

Imports: (2)

* link (stylesheet) * link (shortcut icon)

Links: (141)

* a: ()

* a: (Hacker News) * a: (new) * a: (comments) * a: (leaders) * a: (jobs)

* a: (submit) * a: (login) * a:

() * a:

(Facebook speeds up PHP) * a: (mcxx) * a: (9 comments) * a:

() * a:

(\"Tough. Django produces XHTML.\") * a: (andybak)

* a: (3 comments) * a:

()

* a: (More)

* a: (Lists) * a: (RSS)

* a: (Bookmarklet)

* a: (Guidelines)

* a: (FAQ)

* a: (News News) * a: (Feature Requests)

* a: (Y Combinator)

* a: (Apply) * a: (Library)

* a: () * a: ()

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\

说明

与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(); //

lorem ipsum

div.prepend(\"

First

Last

Element span = doc.select(\"span\").first(); // One

span.wrap(\"

说明

  

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(); //

// now:

说明

文本设置方法与HTML setter方法一样：

 

Element.text(String text)将清除一个元素中的内部HTML内容，然后提供

的文本进行代替

Element.prepend(String first)和Element.append(String last)

将分别在元素的内部html前后添加文本节点。

对于传入的文本如果含有像<, >等这样的字符，将以文本处理，而非HTML。

14.消除不受信任的HTML (来防止XSS攻击)

问题

在做网站的时候，经常会提供用户评论的功能。有些不怀好意的用户，会搞一些脚本到评论内容中，而这些脚本可能会破坏整个页面的行为，更严重的是获取一些机要信息，此时需要清理该HTML，以避免跨站脚本cross-site scripting攻击（XSS）。

方法

使用jsoup HTML Cleaner方法进行清除，但需要指定一个可配置的Whitelist。

String unsafe =

\"

onclick='stealCookies()'>Link

String safe = Jsoup.clean(unsafe, Whitelist.basic()); // now:

Link

说明

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链接属性了解