JSOUP实践:解析和遍历HTML文档

一、jsoup简介       

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

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

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

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

        其解析器能够尽最大可能从你提供的HTML文档来创见一个干净的解析结果,无论HTML的格式是否完整。比如它可以处理:

        1、没有关闭的标签: (比如:

Lorem

Ipsum parses to

Lorem

Ipsum

)

        2、隐式标签: (比如: 它可以自动将 Table data包装成

?)

        3、创建可靠的文档结构(html标签包含head 和 body,在head只出现恰当的元素)

        解析是通过Jsoup类库将Html转换为一个Jsoup 文档对象模型,如下:

String html="First parse"
           +"

Parsed HTML into a doc

"; Document doc = Jsoup.parse(html);

        一个文档的对象模型,由多个Elements和TextNodes组成 (以及其它辅助nodes:详细可查看:nodes package tree)。其继承结构如下:Document继承Element继承Node. TextNode继承 Node。一个Element包含一个子节点集合,并拥有一个父Element。他们还提供了一个唯一的子元素过滤列表。

二、Jsoup.parse(String html) 或 Jsoup.parse(String html, String baseUri)方法

        parse(String html, String baseUri) 这方法能够将输入的HTML解析为一个新的文档 (Document),参数 baseUri 是用来将相对 URL 转成绝对URL,并指定从哪个网站获取文档。如这个方法不适用,你可以使用 parse(String html) 方法来解析成HTML字符串如上面的示例。只要解析的不是空字符串,就能返回一个结构合理的文档,其中包含(至少) 一个head和一个body元素。一旦拥有了一个Document,你就可以使用Document中适当的方法或它父类 Element和Node中的方法来取得相关数据。

三、解析一个body片断

        假如你有一个HTML片断 (比如. 一个 div 包含一对 p 标签; 一个不完整的HTML文档) 想对它进行解析。这个HTML片断可以是用户提交的一条评论或在一个CMS页面中编辑body部分。可以使用Jsoup.parseBodyFragment(String html)方法。

String html = "

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")相同。假如你可以让用户输入HTML内容,那么要小心避免跨站脚本攻击。利用基于 Whitelist 的清除器和 clean(String bodyHtml, Whitelist whitelist)方法来清除用户输入的恶意内容。

四、从一个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", "Java")  
  .userAgent("Mozilla")  
  .cookie("auth", "token")  
  .timeout(3000)  
  .post(); 


        这个方法只支持Web URLs (http和https 协议),假如你需要从一个文件加载,可以使用 parse(File in, String charsetName) 代替。

五、使用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)

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

        可以使用类似于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等。

七、从元素抽取属性,文本和HTML

         在解析获得一个Document实例对象,并查找到一些元素之后,如何取得在这些元素中的数据。方法如下:要取得一个属性的值,可以使用Node.attr(String key) 方法;获取一个元素中的文本,可以使用Element.text()方法;要取得元素或属性中的HTML内容,可以使用Element.html(), 或 Node.outerHtml()方法。示例:

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内容

       说明:上述方法是元素数据访问的核心办法。此外还其它一些方法可以使用:
       Element.id()
       Element.tagName()
       Element.className() and Element.hasClass(String className)

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

八、处理URLs

        当处理有一个包含相对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经常写成相对于文档位置的相对路径: .... 当你使用 Node.attr(String key) 方法来取得a元素的href属性时,它将直接返回在HTML源码中指定定的值。假如你需要取得一个绝对路径,需要在属性名前加 abs: 前缀。这样就可以返回包含根路径的URL地址attr("abs:href")。因此,在解析HTML文档时,定义base URI非常重要。如果你不想使用abs: 前缀,还有一个方法能够实现同样的功能 Node.absUrl(String key)。

 

 

 

 

 

 

你可能感兴趣的:(Jsoup)