jsoup - JavaShuo

jsoup

jsoup文档: http://www.open-open.com/jsoup/css

原连接: http://www.oschina.net/question/12_14127html

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 对象实例。

下面是相关代码：cookie

 
      01 
      // 直接从字符串中输入 HTML 文档 
     
      02 
      String html = "<html><head><title>开源中国社区</title></head>" 
     
      03 
        + "<body><p>这里是 jsoup 项目的相关文章</p></body></html>"; 
     
      04 
      Document doc = Jsoup.parse(html); 
     
      05 
        
      06 
      // 从URL直接加载 HTML 文档 
     
      07 
      Document doc = Jsoup.connect("http://www.oschina.net/").get(); 
     
      08 
      String title = doc.title(); 
     
      09 
        
      10 
      Document doc = Jsoup.connect("http://www.oschina.net/") 
     
      11 
        .data("query", "Java")   //请求参数 
     
      12 
        .userAgent("I’m jsoup") //设置User-Agent 
     
      13 
        .cookie("auth", "token") //设置cookie 
     
      14 
        .timeout(3000)           //设置链接超时时间 
     
      15 
        .post();                 //使用POST方法访问URL 
     
      16 
        
      17 
      // 从文件中加载 HTML 文档 
     
      18 
      File input = new File("D:/test.html"); 
     
      19 
      Document doc = Jsoup.parse(input,"UTF-8","http://www.oschina.net/");

请你们注意最后一种 HTML 文档输入方式中的 parse 的第三个参数，为何须要在这里指定一个网址呢（虽然能够不指定，如第一种方法）？由于 HTML 文档中会有不少例如连接、图片以及所引用的外部脚本、css文件等，而第三个名为 baseURL 的参数的意思就是当 HTML 文档使用相对路径方式引用外部文件时，jsoup 会自动为这些 URL 加上一个前缀，也就是这个 baseURL。

例如 <a href=/project>开源软件</a> 会被转换成 <a href=http://www.oschina.net/project>开源软件</a>。

解析并提取 HTML 元素

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

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

 
      1 
      File input = new File("D:/test.html"); 
     
      2 
      Document doc = Jsoup.parse(input, "UTF-8", "http://www.oschina.net/"); 
     
      3 
        
      4 
      Element content = doc.getElementById("content"); 
     
      5 
      Elements links = content.getElementsByTag("a"); 
     
      6 
      for (Element link : links) { 
     
      7 
        String linkHref = link.attr("href"); 
     
      8 
        String linkText = link.text(); 
     
      9 
      }

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

与 htmlparser 项目不一样的是，jsoup 并无为 HTML 元素定义一个对应的类，通常一个 HTML 元素的组成部分包括：节点名、属性和文本，jsoup 提供简单的方法供你本身检索这些数据，这也是 jsoup 保持瘦身的缘由。

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

 
      01 
      File input = new File("D:\test.html"); 
     
      02 
      Document doc = Jsoup.parse(input,"UTF-8","http://www.oschina.net/"); 
     
      03 
        
      04 
      Elements links = doc.select("a[href]"); // 具备 href 属性的连接 
     
      05 
      Elements pngs = doc.select("img[src$=.png]");//全部引用png图片的元素 
     
      06 
        
      07 
        
      08 
      Element masthead = doc.select("div.masthead").first(); 
     
      09 
      // 找出定义了 class="masthead" 的元素 
     
      10 
        
      11 
      Elements resultLinks = doc.select("h3.r > a"); // direct a after h3

这是 jsoup 真正让我折服的地方，jsoup 使用跟 jQuery 如出一辙的选择器对元素进行检索，以上的检索方法若是换成是其余的 HTML 解释器，至少都须要不少行代码，而 jsoup 只须要一行代码便可完成。

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

修改数据

在解析文档的同时，咱们可能会须要对文档中的某些元素进行修改，例如咱们能够为文档中的全部图片增长可点击连接、修改连接地址或者是修改文本等。

下面是一些简单的例子：spa

 
      1 
      doc.select("div.comments a").attr("rel", "nofollow"); 
     
      2 
      //为全部连接增长 rel=nofollow 属性 
     
      3 
        
      4 
      doc.select("div.comments a").addClass("mylinkclass"); 
     
      5 
      //为全部连接增长 class="mylinkclass" 属性 
     
      6 
        
      7 
      doc.select("img").removeAttr("onclick"); //删除全部图片的onclick属性 
     
      8 
        
      9 
      doc.select("input[type=text]").val(""); //清空全部文本输入框中的文本

道理很简单，你只须要利用 jsoup 的选择器找出元素，而后就能够经过以上的方法来进行修改，除了没法修改标签名外（能够删除后再插入新的元素），包括元素的属性和文本均可以修改。

修改完直接调用 Element(s) 的 html() 方法就能够获取修改完的 HTML 文档。.net

HTML 文档清理

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

jsoup 对这方面的支持很是强大，使用很是简单。看看下面这段代码：设计

 
      1 
      String unsafe = "<p><a href='http://www.oschina.net/' onclick='stealCookies()'>开源中国社区</a></p>"; 
     
      2 
      String safe = Jsoup.clean(unsafe, Whitelist.basic()); 
     
      3 
      // 输出: 
     
      4 
      // <p><a href="http://www.oschina.net/" rel="nofollow">开源中国社区</a></p>

jsoup 使用一个 Whitelist 类用来对 HTML 文档进行过滤，该类提供几个经常使用方法：code

若是这五个过滤器都没法知足你的要求呢，例如你容许用户插入 flash 动画，不要紧，Whitelist 提供扩展功能，例如 whitelist.addTags("embed","object","param","span","div"); 也可调用 addAttributes 为某些元素增长属性。

jsoup 的过人之处——选择器

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

基本用法

以上是最基本的选择器语法，这些语法也能够组合起来使用，下面是 jsoup 支持的组合用法：

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

总结jsoup 的基本功能到这里就介绍完毕，但因为 jsoup 良好的可扩展性 API 设计，你能够经过选择器的定义来开发出很是强大的 HTML 解析功能。再加上 jsoup 项目自己的开发也很是活跃，所以若是你正在使用 Java ，须要对 HTML 进行处理，不妨试试。