请输入您要查询的百科知识:

 

词条 jsoup
释义

jsoup 简介

Java 程序在解析HTML 文档时,相信大家都接触过htmlparser 这个开源项目,我曾经在IBM DW 上发表过两篇关于htmlparser 的文章,分别是:从HTML中攫取你所需的信息 和扩展HTMLParser 对自定义标签的处理能力。但现在我已经不再使用htmlparser 了,原因是htmlparser 很少更新,但最重要的是有了jsoup 。

jsoup 是一款Java 的HTML解析器,可直接解析某个URL地址、HTML文本内容。它提供了一套非常省力的API,可通过DOM,CSS以及类似于jQuery的操作方法来取出和操作数据。

jsoup的主要功能如下:

1. 从一个URL,文件或字符串中解析HTML;

2. 使用DOM或CSS选择器来查找、取出数据;

3. 可操作HTML元素、属性、文本;

jsoup是基于MIT协议发布的,可放心使用于商业项目。

jsoup 的主要类层次结构如下图所示:

接下来我们专门针对几种常见的应用场景举例说明jsoup 是如何优雅的进行HTML 文档处理的。

文档输入

jsoup 可以从包括字符串、URL地址以及本地文件来加载HTML 文档,并生成Document 对象实例。

下面是相关代码:

// 直接从字符串中输入HTML 文档

String html = "<html><head><title>开源中国社区</title></head>"

+"<body><p>这里是jsoup 项目的相关文章</p></body></html>";

Document doc = Jsoup.parse(html);

// 从URL直接加载HTML 文档

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

// 从文件中加载HTML 文档

File input = new File("D:/test.html");

Document doc = Jsoup.parse(input,"UTF-8","网址/");

请大家注意最后一种HTML 文档输入方式中的parse 的第三个参数,为什么需要在这里指定一个网址呢(虽然可以不指定,如第一种方法)?因为HTML 文档中会有很多例如链接、图片以及所引用的外部脚本、css文件等,而第三个名为baseURL 的参数的意思就是当HTML 文档使用相对路径方式引用外部文件时,jsoup会自动为这些URL 加上一个前缀,也就是这个baseURL。

例如<a href=/project>开源软件</a> 会被转换成<a href=网址>开源软件</a>。

解析并提取HTML 元素

这部分涉及一个HTML 解析器最基本的功能,但jsoup使用一种有别于其他开源项目的方式——选择器,我们将在最后一部分详细介绍jsoup选择器,本节中你将看到jsoup是如何用最简单的代码实现。

不过jsoup也提供了传统的DOM 方式的元素解析,看看下面的代码:

File input = new File("D:/test.html");

Document doc = Jsoup.parse(input, "UTF-8","网址/");

Element content =doc.getElementById("content");

Elements links = content.getElementsByTag("a");

for (Element link : links) {

String linkHref =link.attr("href");

String linkText =link.text();

}

你可能会觉得jsoup的方法似曾相识,没错,像getElementById 和getElementsByTag 方法跟JavaScript 的方法名称是一样的,功能也完全一致。你可以根据节点名称或者是HTML 元素的id 来获取对应的元素或者元素列表。

与htmlparser 项目不同的是,jsoup 并没有为HTML 元素定义一个对应的类,一般一个HTML 元素的组成部分包括:节点名、属性和文本,jsoup 提供简单的方法供你自己检索这些数据,这也是jsoup保持瘦身的原因。

而在元素检索方面,jsoup 的选择器简直无所不能,

File input = new File("D:\\test.html");

Document doc =Jsoup.parse(input,"UTF-8","网址");

Elements links = doc.select("a[href]"); // 具有href 属性的链接

Elements pngs = doc.select("img[src$=.png]");//所有引用png图片的元素

Element masthead =doc.select("div.masthead").first();

// 找出定义了class=masthead 的元素

Elements resultLinks = doc.select("h3.r >a"); // direct a after h3

这是jsoup 真正让我折服的地方,jsoup使用跟jQuery 一模一样的选择器对元素进行检索,以上的检索方法如果换成是其他的HTML 解释器,至少都需要很多行代码,而jsoup 只需要一行代码即可完成。

jsoup 的选择器还支持表达式功能,我们将在最后一节介绍这个超强的选择器。

修改数据

在解析文档的同时,我们可能会需要对文档中的某些元素进行修改,例如我们可以为文档中的所有图片增加可点击链接、修改链接地址或者是修改文本等。

下面是一些简单的例子:

doc.select("div.commentsa").attr("rel", "nofollow");

//为所有链接增加rel=nofollow 属性

doc.select("div.commentsa").addClass("mylinkclass");

//为所有链接增加class=mylinkclass 属性

doc.select("img").removeAttr("onclick");//删除所有图片的onclick属性

doc.select("input[type=text]").val("");//清空所有文本输入框中的文本

道理很简单,你只需要利用jsoup 的选择器找出元素,然后就可以通过以上的方法来进行修改,除了无法修改标签名外(可以删除后再插入新的元素),包括元素的属性和文本都可以修改。

修改完直接调用Element(s) 的html() 方法就可以获取修改完的HTML 文档。

HTML 文档清理

jsoup 在提供强大的API 同时,人性化方面也做得非常好。在做网站的时候,经常会提供用户评论的功能。有些用户比较淘气,会搞一些脚本到评论内容中,而这些脚本可能会破坏整个页面的行为,更严重的是获取一些机要信息,例如XSS 跨站点攻击之类的。

jsoup 对这方面的支持非常强大,使用非常简单。看看下面这段代码:

String unsafe = "<p><a href='网址' onclick='stealCookies()'>开源中国社区</a></p>";

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

// 输出:

// <p><ahref="网址" rel="nofollow">开源中国社区</a></p>

jsoup 使用一个Whitelist 类用来对HTML 文档进行过滤,该类提供几个常用方法:

如果这五个过滤器都无法满足你的要求呢,例如你允许用户插入flash 动画,没关系,Whitelist提供扩展功能,例如whitelist.addTags("embed","object","param","span","div");也可调用addAttributes 为某些元素增加属性。

jsoup 的过人之处——选择器

前面我们已经简单的介绍了jsoup是如何使用选择器来对元素进行检索的。本节我们把重点放在选择器本身强大的语法上。下表是jsoup选择器的所有语法详细列表。

基本用法

以上是最基本的选择器语法,这些语法也可以组合起来使用,下面是jsoup支持的组合用法:

除了一些基本的语法以及这些语法进行组合外,jsoup 还支持使用表达式进行元素过滤选择。下面是jsoup支持的所有表达式一览表:

总结

jsoup 的基本功能到这里就介绍完毕,但由于jsoup 良好的可扩展性API 设计,你可以通过选择器的定义来开发出非常强大的HTML 解析功能。再加上jsoup 项目本身的开发也非常活跃,因此如果你正在使用Java ,需要对HTML 进行处理,不妨试试。

随便看

 

百科全书收录4421916条中文百科知识,基本涵盖了大多数领域的百科知识,是一部内容开放、自由的电子版百科全书。

 

Copyright © 2004-2023 Cnenc.net All Rights Reserved
更新时间:2024/12/23 17:20:19