jsoup的使用

hello



在用了一段时间的正则表达式之后,一直想找个机会学习一下jsoup,据说是解析网页的神器,但苦于官方的英文文档。迟迟没有动手
自从看了youtube上的jsoup的视频之后,短短几行就实现了之前几十行的任务,(爬取网页上的所有超链接),这坚定了我学习jsoup的
决心,结合中文文档和英文文档,花了大概两天的时间,大概了解了一下jsoup的使用,对于正则表达式头疼的不行的我来说,
真乃神器啊,花点时间整理一下,原谅我大篇幅的抄官网,写的实在好,静下心来,一定看的懂。
ps:吐槽一下印象笔记,之前写过一次,没保存,就关闭了,居然没提示是否保存,哎,没办法,再整理一遍,遂有点粗糙,仅供参考



1、

   
   
   
   
String html = "<html><head><title>First parse</title></head>" + "<body><p>Parsed HTML into a doc.</p></body></html>"; Document doc = Jsoup.parse(html);

parse(String html, String baseUri) 这方法能够将输入的HTML解析为一个新的文档 (Document),参数 baseUri 是用来将相对 URL 转成绝对URL,并指定从哪个网站获取文档。如这个方法不适用,你可以使用 parse(String html) 方法来解析成HTML字符串如上面的示例。.

只要解析的不是空字符串,就能返回一个结构合理的文档,其中包含(至少) 一个head和一个body元素。

一旦拥有了一个Document,你就可以使用Document中适当的方法或它父类  ElementNode中的方法来取得相关数据。
2、
String html = "<div><p>Lorem ipsum.</p>";
Document doc = Jsoup.parseBodyFragment(html);
Element body = doc.body();
假如你有一个HTML片断 (比如. 一个  div  包含一对  p  标签; 一个不完整的HTML文档) 想对它进行解析。这个HTML片断可以是用户提交的一条评论或在一个CMS页面中编辑body部分。

parseBodyFragment 方法创建一个空壳的文档,并插入解析过的HTML到body元素中。假如你使用正常的 Jsoup.parse(String html) 方法,通常你也可以得到相同的结果,但是明确将用户输入作为 body片段处理,以确保用户所提供的任何糟糕的HTML都将被解析成body元素。

Document.body() 方法能够取得文档body元素的所有子元素,与  doc.getElementsByTag("body")相同。

3、从一个url加载doc
//load a document from a url
   //doc = Jsoup.connect(" http://www.jsoup.org/").get();
   //Elements links = doc.select("a");
   
   //System.out.println(doc);
   /*获得body
   Element body = doc.body();
   System.out.println(body);
   */
   /*
    *  获得title
   String title = doc.title();
   System.out.println(title);
   */
   /*打印所有链接
   for(Element e:links)
   {
    //System.out.println(e);
    //System.out.println(e.attr("abs:href"));

   }
   */
connect(String url)  方法创建一个新的  Connection , 和  get()  取得和解析一个HTML文件。如果从该URL获取HTML时发生错误,便会抛出 IOException,应适当处理。

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)  代替。
4、
在本机硬盘上有一个HTML文件,需要对它进行解析从中抽取数据或进行修改。
可以使用静态  Jsoup.parse(File in, String charsetName, String baseUri) 方法:
    
    
    
    
File input = new File("/tmp/input.html"); Document doc = Jsoup.parse(input, "UTF-8", http://example.com/);

parse(File in, String charsetName, String baseUri) 这个方法用来加载和解析一个HTML文件。如在加载文件的时候发生错误,将抛出IOException,应作适当处理。

baseUri 参数用于解决文件中URLs是相对路径的问题。如果不需要可以传入一个空的字符串。

另外还有一个方法parse(File in, String charsetName) ,它使用文件的路径做为 baseUri。 这个方法适用于如果被解析文件位于网站的本地文件系统,且相关链接也指向该文件系统。

5、
你有一个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();
}
//得到所有a标签
   Elements as = doc.getElementsByTag("a");
   for(Element a : as){
    System.out.println(a);
   }

/*
   Elements as = doc.getElementsByTag("a");
   for(Element a : as){
    System.out.println(a);
   }
   */
   //找到id的nav的标签
   /*
   Element ids = doc.getElementById("nav");
   System.out.println(ids);
   */
   /*得到class = appdown 的标签
  
   Elements classes = doc.getElementsByClass("appDown");
   System.out.println(classes);
   */
   /*
   Elements attrs = doc.getElementsByAttribute("href");
   System.out.println(attrs);
   out:
   <a href=" http://house.focus.cn/" target="_blank">房产</a>
   <a href=" http://house.focus.cn/" target="_blank">更多</a>
   */
   /*得到parent标签
   Element div = doc.getElementsByClass("appDown").first();
   System.out.println(div);
   Element parent = div.parent();
   System.out.println(parent);
   <li class="appDown"><a href=" http://k.sohu.com/">App</a></li>
   <ul>
    <li class="client dev-pc"><a href="javascript:void(0);" class="dev-cur">电脑<em class="cor-b-h"></em></a> </li>
    <li class="retina dev-pad"> <a href="#" class="dev-cur">Pad<em class="cor-b-h"></em></a></li>
    <li class="client dev-pad"><a href="#"> 电脑</a></li>
    <li class="retina dev-pc"><a href="#">Pad</a></li>
    <li class="handset"><a href=" http://m.sohu.com/">手机</a></li>
    <li class="appDown"><a href=" http://k.sohu.com/">App</a></li>
   </ul>
   */
   /*得到标签的属性值
   Element aa = doc.getElementsByTag("a").first();
   System.out.println(aa);
   Attributes aatt = aa.attributes();
   System.out.println(aatt);
   <a href=" http://news.sohu.com/" target="_blank"><img src=" http://news.sohu.com/upload/2013/images/news_logo0.gif" width="112" height="48" alt="搜狐新闻" filter="1"></a>
    href=" http://news.sohu.com/" target="_blank"
    */

将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();
}

查找元素

  • 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)


6、

File input = new File("test.html");
   Document doc = Jsoup.connect(" http://jsoup.org/").get();
   
   //System.out.println(doc);
   /*
   Element content = doc.getElementById("content");
   System.out.println(content);
   */
   /*
   Elements links = doc.getElementsByTag("a");
   for(Element link : links){
    String linkHref = link.attr("abs:href");
    String Linktext = link.text();
    //System.out.println(linkHref);
    
    System.out.println(Linktext);
   }
   */
   /*
   Element link = doc.select("a").first();
   //System.out.println(link);
   String text = doc.body().text();
   //System.out.println(text);
   String linkhref = link.attr("href");
   String linktext = link.text();
   String linkouterH = link.outerHtml();
   String linkInnerH = link.html();
   System.out.println(linkhref+linktext+linkouterH+linkouterH);
   //      /jsoup<a href="/">jsoup</a><a href="/">jsoup</a>
    * */
   Elements links = doc.select("a[href]");//带有href属性的a元素
   Elements pngs = doc.select("img[src$=.png]");//扩展名为.png的图片
   Element masthead = doc.select("div.content").first();
   //class 等于masthead -的div标签
   Elements resultlinks = doc.select("h2.r>a");
   
   System.out.println(links.first());
   System.out.println(pngs.first());
   //System.out.println(masthead);
   System.out.println(resultlinks.first());

说明

jsoup elements对象支持类似于CSS (或jquery)的选择器语法,来实现非常强大和灵活的查找功能。.

这个select 方法在DocumentElement,或Elements对象中都可以使用。且是上下文相关的,因此可实现指定元素的过滤,或者链式选择访问。

Select方法将返回一个Elements集合,并提供一组方法来抽取和处理结果。

Selector选择器概述

  • tagname: 通过标签查找元素,比如:a
  • ns|tag: 通过标签在命名空间查找元素,比如:可以用 fb|name 语法来查找 <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等


7、

  • 要取得一个属性的值,可以使用Node.attr(String key) 方法
  • 对于一个元素中的文本,可以使用Element.text()方法
  • 对于要取得元素或属性中的HTML内容,可以使用Element.html(), 或 Node.outerHtml()方法
String html = "<p>An <a href='http://example.com/'><b>example</b></a> link.</p>";
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(); 
    // "<a href="http://example.com"><b>example</b></a>"
String linkInnerH = link.html(); // "<b>example</b>"//取得链接内的html内容

8、
你有一个包含相对URLs路径的HTML文档,需要将这些相对路径转换成绝对路径的URLs。

方法

  1. 在你解析文档时确保有指定base URI,然后
  2. 使用 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经常写成相对于文档位置的相对路径: <a href="/download">...</a>. 当你使用 Node.attr(String key) 方法来取得a元素的href属性时,它将直接返回在HTML源码中指定定的值。

假如你需要取得一个绝对路径,需要在属性名前加 abs: 前缀。这样就可以返回包含根路径的URL地址attr("abs:href")

因此,在解析HTML文档时,定义base URI非常重要。

如果你不想使用abs: 前缀,还有一个方法能够实现同样的功能 Node.absUrl(String key)


9、

可以使用属性设置方法 Element.attr(String key, String value), 和 Elements.attr(String key, String value).

假如你需要修改一个元素的 class 属性,可以使用 Element.addClass(String className) 和Element.removeClass(String className) 方法。

Elements 提供了批量操作元素属性和class的方法,比如:要为div中的每一个a元素都添加一个rel="nofollow" 可以使用如下方法:

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

说明

Element中的其它方法一样,attr 方法也是返回当 Element (或在使用选择器是返回 Elements 集合)。这样能够很方便使用方法连用的书写方式。比如:

doc.select("div.masthead").attr("title", "jsoup").addClass("round-box");
  • Element.html(String html) 这个方法将先清除元素中的HTML内容,然后用传入的HTML代替
  • Element.prepend(String first) 和 Element.append(String last) 方法用于在分别在元素内部HTML的前面和后面添加HTML内容
  • Element.wrap(String around) 对元素包裹一个外部HTML内容。

文本设置方法与 HTML setter 方法一样:

  • Element.text(String text) 将清除一个元素中的内部HTML内容,然后提供的文本进行代替
  • Element.prepend(String first) 和 Element.append(String last) 将分别在元素的内部html前后添加文本节点。

对于传入的文本如果含有像 <> 等这样的字符,将以文本处理,而非HTML。


/*
   Elements e = doc.select("a").attr("rel", "nofolow");//为所有的a标签增加属性值
   
   doc.select("div.wrap").attr("title","jsoup").addClass("round-box");
   doc.select("a").remove();//删除a标签
   System.out.println(doc);
   */
   /*修改div的内容
   Element div = doc.select("div").first();
   div.html("<p>这是我加的</p>");
   div.prepend("<p>哈哈</p>");
   div.append("<p>字串</p>");
   */
   /*用wrap里面的包住span标签
   Element span = doc.select("span").first();
   span.wrap("<li><a href='http://www.baidu.com'></a></li>");
   */
   /*
   Element div = doc.select("div").first();
   div.text("five > four");
   div.prepend("First ");
   div.append(" Last");
   System.out.println(doc);
   <div class="wrap">
      First five &gt; four Last
     </div>
     */
   
10、

消除不受信任的HTML (来防止XSS攻击)

问题

在做网站的时候,经常会提供用户评论的功能。有些不怀好意的用户,会搞一些脚本到评论内容中,而这些脚本可能会破坏整个页面的行为,更严重的是获取一些机要信息,此时需要清理该HTML,以避免跨站脚本cross-site scripting攻击(XSS)。

方法

使用jsoup HTML Cleaner 方法进行清除,但需要指定一个可配置的 Whitelist

String unsafe = 
  "<p><a href='http://example.com/' onclick='stealCookies()'>Link</a></p>";
String safe = Jsoup.clean(unsafe, Whitelist.basic());
// now: <p><a href="http://example.com/" rel="nofollow">Link</a></p>

说明

XSS又叫CSS (Cross Site Script) ,跨站脚本攻击。它指的是恶意攻击者往Web页面里插入恶意html代码,当用户浏览该页之时,嵌入其中Web里面的html代码会被执行,从而达到恶意攻击用户的特殊目的。XSS属于被动式的攻击,因为其被动且不好利用,所以许多人常忽略其危害性。所以我们经常只让用户输入纯文本的内容,但这样用户体验就比较差了。

一个更好的解决方法就是使用一个富文本编辑器WYSIWYG如CKEditor 和 TinyMCE。这些可以输出HTML并能够让用户可视化编辑。虽然他们可以在客户端进行校验,但是这样还不够安全,需要在服务器端进行校验并清除有害的HTML代码,这样才能确保输入到你网站的HTML是安全的。否则,攻击者能够绕过客户端的Javascript验证,并注入不安全的HMTL直接进入您的网站。

jsoup的whitelist清理器能够在服务器端对用户输入的HTML进行过滤,只输出一些安全的标签和属性。

jsoup提供了一系列的Whitelist基本配置,能够满足大多数要求;但如有必要,也可以进行修改,不过要小心。

这个cleaner非常好用不仅可以避免XSS攻击,还可以限制用户可以输入的标签范围。



















































































你可能感兴趣的:(jsoup的使用)