jsoup 是一款Java 的HTML解析器,可直接解析某个URL地址、HTML文本内容。它提供了一套非常省力的API,可通过DOM,CSS以及类似于jQuery的操作方法来取出和操作数据。jsoup的主要功能如下:
1. 从一个URL,文件或字符串中解析HTML;
2. 使用DOM或CSS选择器来查找、取出数据;
3. 可操作HTML元素、属性、文本;
jsoup是基于MIT协议发布的,可放心使用于商业项目。
关于Jsoul的更多介绍,请访问Jsoul的官网:
关于Jsoul的官网API文档查询:http://jsoup.org/apidocs/
========================================================================================================
入门
1.解析和遍历一个html文档
String html = "
First parse"+ "
Parsed HTML into a doc.
";Document doc = Jsoup.parse(html);
(更详细内容可查看 解析一个HTML字符串.)
其解析器能够尽最大可能从你提供的HTML文档来创见一个干净的解析结果,无论HTML的格式是否完整。比如它可以处理:
没有关闭的标签 (比如:
Lorem
Ipsum parses to
Lorem
Ipsum
)隐式标签 (比如. 它可以自动将
Table data包装成?) 创建可靠的文档结构(html标签包含head 和 body,在head只出现恰当的元素) 一个文档的对象模型 文档由多个Elements和TextNodes组成 (以及其它辅助nodes:详细可查看:nodes package tree). 一个Element包含一个子节点集合,并拥有一个父Element。他们还提供了一个唯一的子元素过滤列表。 参见 ======================================================================================================== 输入 2.解析一个html字符串 存在问题 来自用户输入,一个文件或一个网站的HTML字符串,你可能需要对它进行解析并取其内容,或校验其格式是否完整,或想修改它。怎么办?jsonu能够帮你轻松解决这些问题 解决方法 String html = " First parse"+ " Parsed HTML into a doc. ";Document doc = Jsoup.parse(html); 描述 只要解析的不是空字符串,就能返回一个结构合理的文档,其中包含(至少) 一个head和一个body元素。 一旦拥有了一个Document,你就可以使用Document中适当的方法或它父类 ======================================================================================================== 3.解析一个body片断 存在问题 你需要从一个网站获取和解析一个HTML文档,并查找其中的相关数据。你可以使用下面解决方法: 解决方法 Document doc = Jsoup.connect("http://example.com/").get(); String title = doc.title(); 说明 Document doc = Jsoup.connect("http://example.com") .data("query", "Java") .userAgent("Mozilla") .cookie("auth", "token") .timeout(3000) .post(); 这个方法只支持Web URLs (http和https 协议); 假如你需要从一个文件加载,可以使用 问题 假如你有一个HTML片断 (比如. 一个 div 包含一对 p 标签; 一个不完整的HTML文档) 想对它进行解析。这个HTML片断可以是用户提交的一条评论或在一个CMS页面中编辑body部分。 办法 String html = " Lorem ipsum. ";Document doc = Jsoup.parseBodyFragment(html); Element body = doc.body(); 说明 parseBodyFragment 方法创建一个空壳的文档,并插入解析过的HTML到body元素中。假如你使用正常的 doc.getElementsByTag("body")相同。 保证安全Stay safe 假如你可以让用户输入HTML内容,那么要小心避免跨站脚本攻击。利用基于 ======================================================================================================== 4.从一个URL加载一个Document对象 存在问题 你需要从一个网站获取和解析一个HTML文档,并查找其中的相关数据。你可以使用下面解决方法: 解决方法 Document doc = Jsoup.connect("http://example.com/").get(); String title = doc.title(); 说明 Document doc = Jsoup.connect("http://example.com") .data("query", "Java") .userAgent("Mozilla") .cookie("auth", "token") .timeout(3000) .post(); 这个方法只支持Web URLs (http和https 协议); 假如你需要从一个文件加载,可以使用 ======================================================================================================== 5.根据一个文件加载Document对象 问题 在本机硬盘上有一个HTML文件,需要对它进行解析从中抽取数据或进行修改。 办法 File input = new File("/tmp/input.html"); Document doc = Jsoup.parse(input, "UTF-8", "http://example.com/"); 说明 baseUri 参数用于解决文件中URLs是相对路径的问题。如果不需要可以传入一个空的字符串。 另外还有一个方法baseUri。 这个方法适用于如果被解析文件位于网站的本地文件系统,且相关链接也指向该文件系统。 ======================================================================================================== 数据抽取 6.使用dom方法来遍历一个Document对象 ======================================================================================================== 7.使用选择器语法来查找元素 问题 你想使用类似于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元素 说明 jsoup elements对象支持类似于CSS (或jquery)的选择器语法,来实现非常强大和灵活的查找功能。. 这个select 方法在 Select方法将返回一个 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等 可以查看 ======================================================================================================== 8.从元素集合抽取属性、文本和html内容 问题 在解析获得一个Document实例对象,并查找到一些元素之后,你希望取得在这些元素中的数据。 方法 示例: String html = " An example link. ";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(); // "example" String linkInnerH = link.html(); // "example"//取得链接内的html内容 说明 上述方法是元素数据访问的核心办法。此外还其它一些方法可以使用: 这些访问器方法都有相应的setter方法来更改数据. 参见 ======================================================================================================== 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经常写成相对于文档位置的相对路径: .... 当你使用 假如你需要取得一个绝对路径,需要在属性名前加 abs: 前缀。这样就可以返回包含根路径的URL地址attr("abs:href") 因此,在解析HTML文档时,定义base URI非常重要。 如果你不想使用abs: 前缀,还有一个方法能够实现同样的功能 ======================================================================================================== 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("\nMedia: (%d)", media.size()); for (Element src : media) { if (src.tagName().equals("img")) print(" * %s: %sx%s (%s)", src.tagName(), src.attr("abs:src"), src.attr("width"), src.attr("height"), trim(src.attr("alt"), 20)); else print(" * %s: ", src.tagName(), src.attr("abs:src")); } print("\nImports: (%d)", imports.size()); for (Element link : imports) { print(" * %s (%s)", link.tagName(),link.attr("abs:href"), link.attr("rel")); } print("\nLinks: (%d)", links.size()); for (Element link : links) { print(" * a: (%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: 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之后可能想修改其中的某些属性值,然后再保存到磁盘或都输出到前台页面。 方法 rel="nofollow" 可以使用如下方法: doc.select("div.comments a").attr("rel", "nofollow"); 说明 与attr 方法也是返回当 doc.select("div.masthead").attr("title", "jsoup").addClass("round-box"); ======================================================================================================== 12.设置元素的html内容 问题 你需要一个元素中的HTML内容 方法 可以使用 Element div = doc.select("div").first(); // div.html(" lorem ipsum "); //lorem ipsum div.prepend(" First ");//在div前添加html内容div.append(" Last ");//在div之后添加html内容// 添完后的结果: First lorem ipsum Last Element span = doc.select("span").first(); // One span.wrap(" ");// 添完后的结果: One说明 参见 ======================================================================================================== 13.设置元素的文本内容 问题 你需要修改一个HTML文档中的文本内容 方法 可以使用 Element div = doc.select("div").first(); // div.text("five > four"); // five > four div.prepend("First "); div.append(" Last"); // now: First five > four Last 说明 文本设置方法与 HTML setter 方法一样: 对于传入的文本如果含有像 等这样的字符,将以文本处理,而非HTML。 ======================================================================================================== HTML清理 14.消除不受信任的html (来防止xss攻击) 问题 在做网站的时候,经常会提供用户评论的功能。有些不怀好意的用户,会搞一些脚本到评论内容中,而这些脚本可能会破坏整个页面的行为,更严重的是获取一些机要信息,此时需要清理该HTML,以避免跨站脚本cross-site scripting攻击(XSS)。 方法 使用jsoup HTML String unsafe = " 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提供了一系列的 这个cleaner非常好用不仅可以避免XSS攻击,还可以限制用户可以输入的标签范围。 参见 参阅XSS cheat sheet ,有一个例子可以了解为什么不能使用正则表达式,而采用安全的whitelist parser-based清理器才是正确的选择。 参阅 参阅 ======================================================================================================== jsoup 的基本功能到这里就介绍完毕,但由于jsoup 良好的可扩展性API 设计,你可以通过选择器的定义来开发出非常强大的HTML 解析功能。再加上jsoup 项目本身的开发也非常活跃,因此如果你正在使用Java ,需要对HTML 进行处理,不妨试试。 |