HTML解析器Jsoup

百里浅暮 / 2023-08-21 / 原文

Jsoup简介

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

jsoup的主要功能如下：

从一个URL，文件或字符串中解析HTML；
使用DOM或CSS选择器来查找、取出数据；
可操作HTML元素、属性、文本；( Jsoup一般用于解析爬到的数据并存储, 很少用到操作 )

Jsoup使用

pom文件引入依赖

<dependency>
    <groupId>org.jsoup</groupId>
    <artifactId>jsoup</artifactId>
    <version>1.15.4</version>
</dependency>
<dependency>
    <groupId>com.alibaba.fastjson2</groupId>
    <artifactId>fastjson2</artifactId>
    <version>2.0.26</version>
</dependency>
<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.4</version>
</dependency>
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.4</version>
</dependency>

解析和遍历一个HTML文档

Jsoup解析URL

Jsoup可以直接输入url，它会发起请求并获取数据，封装为Document对象

// 解析url地址, 第一个参数是访问的url, 第二个参数时访问时候的超时时间
Document doc = Jsoup.parse(new URL("http://www.baidu.com"), 5000);
// 使用标签选择器, 获取title标签中的内容
String title = doc.getElementsByTag("title").first().text();
//打印
System.out.println(title);

虽然使用Jsoup可以替代HttpClient直接发起请求解析数据，但是往往不会这样用，因为实际的开发过程中，需要使用到多线程，连接池，代理等等方式，而jsoup对这些的支持并不是很好，所以我们一般把jsoup仅仅作为Html解析工具使用。

Jsoup解析字符串

// 使用工具类读取文件, 获取字符串
String content = FileUtils.readFileToString(new File("D:\\ideawork\\hello-world\\src\\main\\resources\\static\\index.html"), "utf8");
// 解析字符串
Document doc = Jsoup.parse(content);

String title = doc.getElementsByTag("title").first().text();
System.out.println(title);

Jsoup解析文字

// 解析文件
Document doc = Jsoup.parse(new File("D:\\ideawork\\hello-world\\src\\main\\resources\\static\\index.html"), "utf8");
String title = doc.getElementsByTag("title").first().text();
System.out.println(title);

使用Dom方式遍历文档

// 解析文件件, 获取Document对象
Document doc = Jsoup.parse(new File("D:\\ideawork\\hello-world\\src\\main\\resources\\static\\index.html"), "utf8");
// 1.根据id查询元素getElementById
Element element = doc.getElementById("city_bj");
// 2.根据标签获取元素getElementsByTag
Elements spans = doc.getElementsByTag("span");
// 3.根据class获取元素getElementsByClass, 以下表示必须包含class_a和class_b
Element a = doc.getElementsByClass("class_a class_b").first();
// 4.根据属性获取元素getElementsByAttribute
Element abc = doc.getElementsByAttribute("abc").first();
// 5.根据属性与属性值筛选, 即查找href=http://www.baidu.com的第一个元素
Element href = doc.getElementsByAttributeValue("href", "http://www.baidu.com").first();

// 打印元素内容
System.out.println("获取到的元素内容是: " + element.text());
for (Element span : spans) {
    System.out.println(span.text());
}
System.out.println(a.text());
System.out.println("abc.text() = " + abc.text());
System.out.println("href.text() = " + href.text());

Selector选择器

// 解析html文件, 获取Document对象
Document doc = Jsoup.parse(new File("D:\\ideawork\\hello-world\\src\\main\\resources\\static\\index.html"), "utf8");

//el#id: 元素+ID，比如： h3#city_bj
//Element element = doc.select("h3#city_bj").first();

//el.class: 元素+class，比如： li.class_a
//Element element = doc.select("li.class_a").first();

//el[attr]: 元素+属性名，比如： span[abc]
//Element element = doc.select("span[abc]").first();

//任意组合: 比如：span[abc].s_name, span标签有abc属性，并且有名为s_name的css class
Element element = doc.select("span[abc].s_name").first();

//ancestor child: 查找某个元素下子元素，比如：.city_con li 查找"city_con"下的所有li
//Elements elements = doc.select(".city_con li");

//parent > child: 查找某个父元素下的直接子元素，比如：
// .city_con > ul > li 查找city_con第一级（直接子元素）的ul，再找所有ul下的第一级li
//Elements elements = doc.select(".city_con > ul > li");

//parent > *: 查找某个父元素下所有直接子元素
Elements elements = doc.select(".city_con > ul > *");

// 打印
System.out.println("获取到的内容是: " + element.text());
for (Element ele : elements) {
    System.out.println("遍历的结果: " + ele.text());
}

Jsoup基本API

jsoup官方文档

Jsoup获取Document的三种方法

读取取字符串的方式获取Document

获取完整的字符串内容

String html = "<html> <div> <h1>h1标签</h1> <span>span标签</span> </div> </html>";
Document document = Jsoup.parse(html);
System.out.println(document);

获取部分字符串内容

String html = "<html> <div> <h1>h1标签</h1> <span>span标签</span> </div> </html>";
Document document = Jsoup.parse(html);
//此处就像 JavaScript 的选择器
Elements div = document.getElementsByTag("div");
System.out.println(div);

使用 GET 或则 POST 方式获取 Document

通过GET方式获取

Document document;
try {
    //get 请求
    System.out.println("GET 请求方式获取数据");
    document = Jsoup.connect("http://www.baidu.com").get();
    System.out.println(document);
    System.out.println();
} catch (IOException e) {
    e.printStackTrace();
}

通过POST方式获取

Document document;
try {
    //POST请求
    System.out.println("POST 请求方式获取数据");
    document = Jsoup.connect("http://www.baidu.com")
        .data("wd", "生活")  //添加请求数据参数。
        .userAgent("Mozilla AppleWebKit Chrome Safari Edg")  //设置请求用户代理头。
        .cookie("auth", "token")  //设置请求中要发送的 cookie。
        .timeout(2000)  //设置超时时间
        .post();
    System.out.println(document);
} catch (IOException e) {
    e.printStackTrace();
}

在文件中获取 Document

File file = new File("src/main/resources/index.html");
Document document = null;
try {
    document = Jsoup.parse(file, "UTF-8");
    System.out.println(document);
} catch (IOException e) {
    e.printStackTrace();
} finally {
    if (document != null){
        document.clone();
    }
}

使用 Document 通过选择器获取 Elements

常用的方法：

select(String cssQuery)：查找与SelectorCSS查询匹配的元素，类似于 JQuery 的选择器。

getElementById(String id)：通过ID查找元素

getElementsByClass(String className)：通过class查找元素

getElementsByTag(String tagName) 通过指定名称查找元素，并递归地查找这些元素。

getAllElements()：在此元素下找到所有元素。

firstElementSibling()：获取此元素的第一个元素同级

getElementsByAttributeStarting(String keyPrefix)：查找具有以提供的前缀开头的属性名称的元素

getElementsByAttributeValue(String key, String value)：查找具有具有特定值的属性的元素

getElementsByAttributeValueContaining(String key, String match)：查找具有其值包含匹配字符串的属性的元素

getElementsByAttributeValueStarting(String key, String valuePrefix)：查找具有以值前缀开头的属性的元素

getElementsByAttributeValueEnding(String key, String valueSuffix)：查找具有以值后缀结尾的属性的元素

getElementsContainingText(String searchText) ：查找包含指定字符串的元素

创建一个 index.html 文件，内容如下：

<html>
<head>
    <title>hello页面</title>
</head>
<body>
    <div class="boxClass">class div 盒子</div>
    <div id="boxId">Id div 盒子</div>
    <div><span>div 下的 span 标签</span></div>
</body>
</html>

Java示例代码：

File file = new File("src/main/resources/index.html");
Document document = null;
try {
    document = Jsoup.parse(file, "UTF-8");
    //select 类似于 JQuery 选择器
    Elements e1 = document.select("body>div>span"); //<span>div 下的 span 标签</span>
    System.out.println(e1);

    //getElementById id 选择器
    Element e2 = document.getElementById("boxId");
    System.out.println(e2);//<div id="boxId"> Id div 盒子 </div>

    //getElementsByClass class 选择器
    Elements e3 = document.getElementsByClass("boxClass");
    System.out.println(e3);//<div class="boxClass"> class div 盒子 </div>

    //getAllElements
    Elements e4 = document.getElementsByTag("span");
    System.out.println(e4);//<span>div 下的 span 标签</span>

    //...
} catch (IOException e) {
    e.printStackTrace();
} finally {
    if (document != null) {
        document.clone();
    }
}

获取 Elements 的内容

常用的方法：

html()：检索元素的内部HTML。

html(String html)：设置此元素的内部HTML。

text()：获取此元素及其所有子元素的组合文本。

text(String text)：设置文档的文本。

java示例代码：

File file = new File("src/main/resources/index.html");
Document document = null;
try {
    document = Jsoup.parse(file, "UTF-8");
    //html：不带参数是获取 html，带参数是设置 html
    String html = document.select("body").html();
    System.out.println(html);

    //text：不带参数是获取 text，带参数是设置 text
    String text = document.select("body").text();
    System.out.println(text);//class div 盒子 Id div 盒子 div 下的 span 标签
} catch (IOException e) {
    e.printStackTrace();
} finally {
    if (document != null) {
        document.clone();
    }
}