jsoup - java jquery

http://www.open-open.com/jsoup/ 手册

jsoup 是一个 解析和遍历一个HTML文档

1. 解析一个HTML字符串

Jsoup.parse(String html)

Jsoup.parse(String html, String baseUri)  

参数 baseUri 是用来将相对 URL 转成绝对URL，并指定从哪一个网站获取文档。

Document doc = Jsoup.parse(html);

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

2.解析一个body片段 （如 div,p,span...）

Jsoup.parseBodyFragment(String html)

String html = "<div><p>Lorem ipsum.</p>";
//假如你使用正常的 Jsoup.parse(String html) 方法，一般你也能够获得相同的结果
Document doc = Jsoup.parseBodyFragment(html); 
//Document.body() 方法可以取得文档body元素的全部子元素，与 doc.getElementsByTag("body")相同。
Element body = doc.body();

 

3.从一个URL加载一个Document

 Jsoup.connect(String url)

Document doc = Jsoup.connect("http://example.com/").get();
String title = doc.title();

或更加具体：

Document doc = Jsoup.connect("http://example.com")
  .data("query", "Java")
  .userAgent("Mozilla")
  .cookie("auth", "token")
  .timeout(3000)
  .post();

这个方法只支持Web URLs (http和https 协议)

4.从一个文件加载一个文档

Jsoup.parse(File in, String charsetName)

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/");

 第一种：这个方法适用于若是被解析文件位于网站的本地文件系统，且相关连接也指向该文件系统。
 第二种： baseUri 参数用于解决文件中URLs是相对路径的问题。若是不须要能够传入一个空的字符串。

5.遍历一个文档

查找元素

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

Element content = doc.getElementById("content");
Elements links = content.getElementsByTag("a");

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

• Element.select(String selector)
• Elements.select(String selector)

Elements links = doc.select("a[href]"); //带有href属性的a元素
Elements pngs = doc.select("img[src$=.png]");
Element masthead = doc.select("div.masthead").first();
Elements resultLinks = doc.select("h3.r > a"); //在h3元素以后的a元素

soup elements对象支持相似于CSS (或jquery)的选择器语法，来实现很是强大和灵活的查找功能。.

元素数据

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

Element content = doc.getElementById("content");
Elements links = content.getElementsByTag("a");

操做HTML和文本

• append(String html), prepend(String html)
• appendText(String text), prependText(String text)
• appendElement(String tagName), prependElement(String tagName)
• html(String value)

6.处理URLs

 Node.absUrl(String key)

Element link = doc.select("a").first();
String relHref = link.attr("href"); // == "/"
String absHref = link.attr("abs:href"); // "http://www.open-open.com/"

假如你须要取得一个绝对路径，须要在属性名前加 abs: 前缀。这样就能够返回包含根路径的URL地址attr("abs:href")所以，在解析HTML文档时，定义base URI很是重要。

7.设置属性的值

Element.attr(String key, String value)

 Elements.attr(String key, String value).

doc.select("div.masthead").attr("title", "jsoup").addClass("round-box");

 

8.设置一个元素的HTML内容

Element.html(String html) 

这个方法将先清除元素中的HTML内容，而后用传入的HTML代替。

Element.prepend(String first) 和 Element.append(String last)

方法用于在分别在元素内部HTML的前面和后面添加HTML内容

Element.wrap(String around) 
对元素包裹一个外部HTML内容。

9.设置元素的文本内容
Element.text(String text) 
将清除一个元素中的内部HTML内容，而后提供的文本进行代替
Element.prepend(String first) 和 Element.append(String last) 

将分别在元素的内部html先后添加文本节点。
对于传入的文本若是含有像 <, > 等这样的字符，将以文本处理，而非HTML。

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): 查找自身包含文本匹配指定正则表达式的元素

防 xss(跨站攻击)

假如你可让用户输入HTML内容，那么要当心避免跨站脚本攻击。利用基于 Whitelist 的清除器和 clean(String bodyHtml, Whitelist whitelist)方法来清除用户输入的恶意内容。

Whitelist whitelist = Whitelist.none();
Jsoup.clean(String,Whitelist );
或者建立一个Clear对象,使用clean()方法

public Cleaner(Whitelist whitelist)

Cleaner.clean();

方法名	简介
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

Whitelist 提供扩展功能，例如 whitelist.addTags("embed","object","param","span","div"); 也可调用 addAttributes 为某些元素增长属性。

文档结构

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