使用jsoup对HTML文档进行解析和操作
刘柄成,站长,开源中国社区
简介
jsoup是一款Java的HTML解析器,可直接解析某个URL地址、HTML文本内容。它提供了一套非常省力的API,可通过DOM,CSS以及类似于jQuery的操作方法来取出和操作数据。本文主要介绍如何使用jsoup来进行常用的HTML解析。
jsoup的主要功能如下:
从一个URL,文件或字符串中解析HTML;
使用DOM或CSS选择器来查、取出数据;
可操作HTML元素、属性、文本;
jsoup是基于MIT协议发布的,可放心使用于商业项目。
jsoup的主要类层次结构如图1所示:
图  1.jsoup的类层次结构
接下来我们专门针对几种常见的应用场景举例说明jsoup是如何优雅的进行HTML文档处理的。
文档输入
jsoup可以从包括字符串、URL地址以及本地文件来加载HTML文档,并生成Document 对象实例。
下面是相关代码:
清单1
//直接从字符串中输入HTML文档
String html="<html><head><title>开源中国社区</title></head>"
+"<body><p>这里是jsoup项目的相关文章</p></body></html>";
Document doc=Jsoup.parse(html);
//从URL直接加载HTML文档
Document t("www.oschina/").get();
String title=doc.title();
Document t("www.oschina/")
.data("query","Java")//请求参数
.userAgent("I’m jsoup")//设置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","www.oschina/");
请大家注意最后一种HTML文档输入方式中的parse的第三个参数,为什么需要在这里指定一个网址呢(虽然可以不指定,如第一种方法)?因为HTML文档中会有很多例如链接、图片以及所引用的外部脚本、css文件等,而第三个名为baseURL的参数的意思就是当HTML文档使用相对路径方式引用外部文件时,jsoup会自动为这些URL加上一个前缀,也就是这个baseURL。
例如<a href=/project>开源软件</a>会被转换成<a href=www.oschina/project>开源软件</a>。
解析并提取HTML元素
这部分涉及一个HTML解析器最基本的功能,但jsoup使用一种有别于其他开源项目的方式——选择器,我们将在最后一部分详细介绍jsoup选择器,本节中你将看到jsoup是如何用最简单的代码实现。
不过jsoup也提供了传统的DOM方式的元素解析,看看下面的代码:
清单  2.
File input=new File("D:/test.html");
Document doc=Jsoup.parse(input,"UTF-8","www.oschina/");
Element ElementById("content");
Elements ElementsByTag("a");
for(Element link:links){
String linkHref=link.attr("href");
String ();
}
你可能会觉得jsoup的方法似曾相识,没错,像getElementById和getElementsByTag方法跟JavaScript
的方法名称是一样的,功能也完全一致。你可以根据节点名称或者是HTML 元素的id来获取对应的元素或者元素列表。
与htmlparser项目不同的是,jsoup并没有为HTML元素定义一个对应的类,一般一个HTML元素的组成部分包括:节点名、属性和文本,jsoup提供简单的方法供你自己检索这些数据,这也是jsoup保持瘦身的原因。
而在元素检索方面,jsoup的选择器简直无所不能,
清单  3.
File input=new File("D:\test.html");
Document doc=Jsoup.parse(input,"UTF-8","www.oschina/");
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的选择器还支持表达式功能,我们将在最后一节介绍这个超强的选择器。
修改数据
在解析文档的同时,我们可能会需要对文档中的某些元素进行修改,例如我们可以为文档中的所有图片增加可点击链接、修改链接地址或者是修改文本等。
下面是一些简单的例子:
清单  4.
doc.select("divments a").attr("rel","nofollow");
//为所有链接增加rel=nofollow属性
doc.select("divments a").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对这方面的支持非常强大,使用非常简单。看看下面这段代码:
清单  5.
String unsafe="<p><a href='www.oschina/'onclick='stealCookies()'>
开源中国社区</a></p>";
String safe=Jsoup.clean(unsafe,Whitelist.basic());
//输出:
//<p><a href="www.oschina/"rel="nofollow">开源中国社区</a></p>
jsoup使用一个Whitelist类用来对HTML文档进行过滤,该类提供几个常用方法:
表  1.常用方法:
方法名简介
none()只允许包含文本信息
basic()允许的标签包括:a,b,blockquote,br,cite,code,dd,dl,dt,em,i,li,ol,p, pre,q,small,strike,strong,sub,sup,u,ul,以及合适的属性
simpleText()只允许b,em,i,strong,u这些标签basicWithImages()在basic()的基础上增加了图片
relaxed()这个过滤器允许的标签最多,包括:a,b,blockquote,br,caption,cite, code,col,colgroup,dd,dl,dt,em,h1,h2,h3,h4,h5,h6,i,img,li,ol,p, pre,q,small,strike,strong,sub,sup,table,tbody,td,tfoot,th,thead,tr,u, ul
如果这五个过滤器都无法满足你的要求呢,例如你允许用户插入flash动画,没关系,
Whitelist提供扩展功能,例如whitelist.addTags("embed","object","param","span","div");也可调用addAttributes为某些元素增加属性。href标签怎么用
jsoup的过人之处——选择器
前面我们已经简单的介绍了jsoup是如何使用选择器来对元素进行检索的。本节我们把重点放在选择器本身强大的语法上。下表是jsoup选择器的所有语法详细列表。
表  2.基本用法:
tagname使用标签名来定位,例如a
ns|tag 使用命名空间的标签定位,例如fb:name来查<fb:name>元素
#id使用元素id定位,例如#logo
.class使用元素的class属性定位,例如.head
[attribute]使用元素的属性进行定位,例如[href]表示检索具有href属性的所有元素
[^attr]使用元素的属性名前缀进行定位,例如[^data-]用来查HTML5的dataset属性
[attr=value]使用属性值进行定位,例如[width=500]定位所有width属性值为500的元素
[attr^=value],[attr$=value],
[attr*=value]
这三个语法分别代表,属性以value开头、结尾以及包含
[attr~=regex]使用正则表达式进行属性值的过滤,例如img[src~=(?i)\.(png|jpe?g)]
*定位所有元素
以上是最基本的选择器语法,这些语法也可以组合起来使用,下面是jsoup支持的组合用法:
表3:组合用法:
el#id定位id值某个元素,例如a#logo-><a id=logo href=…>
el.class定位class为指定值的元素,例如div.head-><div class=head>xxxx</div> el[attr]定位所有定义了某属性的元素,例如a[href]
以上三个任意
组合
例如a[href]#logo、a[name].outerlink
ancestor child 这五种都是元素之间组合关系的选择器语法,其中包括父子关系、合并关系和层次关系。
parent>child
siblingA+siblingB
siblingA~siblingX

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。