jsoup 框架的使用指南

发布时间：2023-03-21 文章分类：电脑基础 投稿人：樱花 字号： 默认 | 大 | 超大 打印

概述

参考：

概念简介

jsoup 是一款基于 Java 的 HTML 解析器，它提供了一套非常省力的 API，不但能直接解析某个 URL 地址、HTML 文本内容，而且还能通过类似于 DOM、CSS 或者 jQuery 的方法来操作数据，所以 jsoup 也可以被当做爬虫工具使用。

jsoup 实现 WHATWG HTML5 规范，并将 HTML 解析为与现代浏览器相同的 DOM。

相关概念简介

jsoup 框架的使用指南

依赖

<dependency>
    <groupId>org.jsoup</groupId>
    <artifactId>jsoup</artifactId>
    <version>1.15.4</version>
</dependency>

jsoup 的主要类

虽然完整的类库中有很多类，但大多数情况下，需要重点了解下面给出3 个类即可

API

Jsoup 类

Jsoup 类的一些重要方法如下：

// 创建并返回URL的连接。
static Connection connect(String url)
// 将指定的字符集文件解析成文档。
static Document parse(File in, String charsetName)
// 将给定的html代码解析成文档。
static Document parse(String html)
// 从本地文件中加载文档对象
static Document parse(File in, String charsetName)
// 从输入 HTML 返回安全的 HTML，通过解析输入 HTML 并通过允许的标签和属性的白名单进行过滤。
static String clean(String bodyHtml, Whitelist whitelist)

Connection 接口

// 将请求作为GET执行，并解析结果
Document get() throws IOException;
// 将请求作为POST执行，并解析结果。
Document post() throws IOException;
// 执行请求。获取内容包含响应码等
Connection.Response execute() throws IOException;
// 将请求方法设置为使用GET或POST。默认为GET
Connection method(Connection.Method method);
// 创建一个新请求，使用此Connection作为会话状态并初始化连接设置（然后可以独立于返回的Connection.request对象）
Connection newRequest();
// 设置要提取的请求URL。协议必须是HTTP或HTTPS
Connection url(URL url);
Connection url(String url);
// 设置头部信息
Connection header(String name, String value);
Connection headers(Map<String, String> headers);
// 发出请求的用户信息
Connection userAgent(String userAgent);
// 先前网页的地址，当前请求网页紧随其后,即来路
Connection referrer(String referrer);
// 设置用于此请求的HTTP代理。设置为null禁用以前设置的代理。
Connection proxy(Proxy proxy);
Connection proxy(String host, int port);
// 设置总请求超时时间。如果发生超时SocketTimeoutException将被抛出。默认超时为30秒（30000ms）。零超时被视为无限超时。
	// 注意，此超时指定连接时间和读取完整响应时间的组合最长持续时间
Connection timeout(int millis);
// 在关闭连接和截断输入之前，设置从（未压缩）连接读取到正文的最大字节数（即正文内容将被修剪）。
	// 默认最大值为2MB。最大大小为0被视为无限量（仅受机器上可用内存的限制）。
Connection maxBodySize(int bytes);
// 设置是否遵循服务器重定向的连接。默认为true
Connection followRedirects(boolean followRedirects);
// 将连接配置为在发生HTTP错误时不引发异常（4xx-5xx，例如404或500）。默认为false;，如果遇到错误，将引发IOException。
	// 如果设置为true，响应将填充错误正文，状态消息将反映错误。
Connection ignoreHttpErrors(boolean ignoreHttpErrors);
// 分析响应时忽略文档的Content-Type。默认为false，未识别的内容类型将引发IOException。（例如，为了防止试图解析JPEG二进制图像而产生垃圾。）设置为true可强制解析尝试，而不管内容类型如何。
Connection ignoreContentType(boolean ignoreContentType);
// 设置自定义SSL套接字工厂
Connection sslSocketFactory(SSLSocketFactory var1);
// 添加请求数据参数。请求参数在GET的请求查询字符串中发送，在POST的请求正文中发送。一个请求可能有多个同名值。
Connection data(String key, String value);
// 添加输入流作为请求数据参数。
Connection data(String key, String filename, InputStream inputStream);
// 添加输入流作为请求数据参数。对于GET，没有影响，但对于POST，这将上载输入流。filename为文件名，不是路径
Connection data(String key, String filename, InputStream InputStream, String contentType);
Connection data(Collection<Connection.KeyVal> data);
Connection data(Map<String, String> data);
Connection data(String... keyvals);
// 获取此密钥的数据KeyVal（如果有）
Connection.KeyVal data(String var1);
// 设置要在请求中发送的cookie
Connection cookie(String name, String value);
Connection cookies(Map<String, String> cookies);
// 获取此连接使用的cookie存储
Connection cookieStore(CookieStore cookieStore);
// 提供自定义或预先填充的CookieStore，用于此连接发出的请求。
CookieStore cookieStore();
// 提供在分析文档响应时使用的备用解析器
Connection parser(Parser parser);
// 设置请求的数据字符集，默认x-www-form-urlencoded
Connection postDataCharset(String charset);
// 设置连接请求
Connection request(Connection.Request var1);
// 设置POST（或PUT）请求主体
Connection requestBody(String body);
// 获取与此连接关联的请求对象
Connection.Request request();
// 设置连接的响应
Connection response(Connection.Response response);
// 执行请求后，获取响应。
Connection.Response response();

Element（元素）类

org.jsoup.nodes.Element extends Node

Elements 对象提供了一系列类似于 DOM 的方法来查找元素，抽取并处理其中的数据。

查找元素

// 通过 id 来查找元素
public Element getElementById(String id)
// 通过标签来查找元素
public Elements getElementsByTag(String tag)
// 通过类选择器来查找元素
public Elements getElementsByClass(String className)
// 通过属性名称来查找元素，例如查找带有 href 元素的标签
public Elements getElementsByAttribute(String key)
// 获取兄弟元素。如果元素没有兄弟元素，则返回一个空列表
public Elements siblingElements()
// 获取第一个兄弟元素
public Element firstElementSibling()
// 获取最后一个兄弟元素
public Element lastElementSibling()
// 获取下一个兄弟元素
public Element nextElementSibling()
// 获取上一个兄弟元素
public Element previousElementSibling()
// 获取此节点的父节点
public Element parent()
// 获取此节点的所有子节点
public Elements children()
// 获取此节点的指定子节点
public Element child(int index)
// 使用 CSS 选择器查找元素
public Elements select(String cssQuery)

获取元素数据

在获得文档对象并且指定查找元素后，就可以获取元素中的数据。

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

// 获取单个属性值
public String attr(String key) 
// 获取所有属性值
public Attributes attributes()
// 设置属性值
public Element attr(String key, String value)
// 获取文本内容
public String text()
// 设置文本内容
public Element text(String value)
// 获取元素内的 HTML 内容
public String html()
// 设置元素内的 HTML 内容
public Element html(String value)
// 获取元素外 HTML 内容
public String outerHtml()
// 获取数据内容（例如：script 和 style 标签)
public String data()
// 获得 id 值（例如：<p id="goods">衣服</p>）
public String id()
// 检查这个元素是否含有一个类选择器（不区分大小写）
public boolean hasClass(String className) 
// 获得第一个类选择器值
public String className()
// 获得所有的类选择器值
public Set<String>classNames()
// 获取元素标签
public Tag tag()
// 获取元素标签名（例如：`<p>`、`<div>` 等）
public String tagName()

修改数据

在解析了一个 Document 对象之后，可能想修改其中的某些属性值，并把它输出到前台页面或保存到其他地方，jsoup 对此提供了一套非常简便的接口（支持链式写法）。

基本使用

获取文档（Document）

获得文档对象 Document 一共有 4 种方法，分别对应不同的获取方式。

选择元素（Element）

解析文档对象并获取数据一共有 2 种方式，分别为 DOM方式、CSS 选择器方式，可以选择一种自己喜欢的方式去获取数据，效果一样。

DOM 方式

将 HTML 解析成一个 Document 之后，就可以使用类似于 DOM 的方法进行操作。

常用方法详见 Element（元素）类 API

示例代码：

// 获取 csdn 首页所有的链接
Document doc = Jsoup.connect("http://csdn.com").get();
Elements elements  = doc.getElementsByTag("body");
Elements contents  = elements.first().getElementsByTag("a");
for (Element content : contents) {
    String linkHref = content.attr("href");
    String linkText = content.text();
}

CSS 选择器方式

可以使用类似于 CSS 选择器的语法来查找和操作元素，常用的方法为 select(String cssQuery)

示例代码：

Document doc = Jsoup.connect("http://csdn.com").get();
// 获取带有 href 属性的 a 元素
Elements elements = doc.select("a[href]");
for (Element content : elements) {
    String linkHref = content.attr("href");
    String linkText = content.text();
}

select(String cssQuery) 方法参数简介

参数属性组合使用

特殊参数：伪选择器

注意：上述伪选择器索引是从 0 开始的，即第一个元素索引值为 0，第二个元素 index 为 1 等

其他功能

一些常用数据的获取

相对路径转绝对路径

示例场景

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

示例场景

jsoup 使用代理

标签 , ,