jsoup的使用_jsoup

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6

本文在写作过程中参考了官方文档传送门。

一、jsoup概述

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

二、相关概念简介

  • Document 文档对象。每份HTML页面都是一个文档对象Document 是 jsoup 体系中最顶层的结构。
  • Element元素对象。一个 Document 中可以着包含着多个 Element 对象可以使用 Element 对象来遍历节点提取数据或者直接操作HTML。
  • Elements元素对象集合类似于List<Element>。
  • Node节点对象。标签名称、属性等都是节点对象节点对象用来存储数据。
  • 类继承关系Document 继承自 Element Element 继承自 Node。
  • 一般执行流程先获取 Document 对象然后获取 Element 对象最后再通过 Node 对象获取数据。
    在这里插入图片描述

三、获取文档Document

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

正式开始之前我们需要导入有关 jar 包。

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

–

3.1从URL中加载文档对象常用

使用 Jsoup.connect(String url).get()方法获取只支持 http 和 https 协议:

Document doc = Jsoup.connect("http://csdn.com/").get();

String title = doc.title();
System.out.println(title);

connect(String url)方法创建一个新的 Connection并通过.get()或者.post()方法获得数据。如果从该URL获取HTML时发生错误便会抛出 IOException应适当处理。

Connection 接口还提供一个方法链来解决特殊请求我们可以在发送请求时带上请求的头部参数具体如下

Document doc = Jsoup.connect("http://csdn.com")
  .data("query", "Java")
  .userAgent("Mozilla")
  .cookie("auth", "token")
  .timeout(8000)
  .post();
  System.out.println(doc);

想获得完整的响应对象和响应码我们可以使用execute()方法

// 获得响应对象
Connection.Response response = Jsoup.connect("http://csdn.com").execute();
int                 code     = response.statusCode();

// 输出状态码200
System.out.println(code);

–

3.2从本地文件中加载文档对象

可以使用静态的Jsoup.parse(File in, String charsetName) 方法从文件中加载文档。其中in表示路径charsetName表示编码方式示例代码

File input = new File("/tmp/input.html");
Document doc = Jsoup.parse(input, "UTF-8");
System.out.println(doc);

–

3.3从字符串文本中加载文档对象

使用静态的Jsoup.parse(String html) 方法可以从字符串文本中获得文档对象 Document 示例代码

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

Document doc = Jsoup.parse(html);
System.out.println(doc);

–

3.4从<body>片断中获取文档对象

使用Jsoup.parseBodyFragment(String html)方法.

String html = "<p>Lorem ipsum.</p>";
Document doc = Jsoup.parseBodyFragment(html);
// doc 此时为<body> <p>Lorem ipsum.</p></body>

Element body = doc.body();
System.out.println(body);

parseBodyFragment 方法创建一个新的文档并插入解析过的HTML到body元素中。假如你使用正常的 Jsoup.parse(String html) 方法通常也能得到相同的结果但是明确将用户输入作为 body 片段处理是个更好的方式。

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

四、选择元素Element

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

4.1DOM方式

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

// 获取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();
    System.out.print(linkText+"\t");
    System.out.println(linkHref);
}

说明

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

4.1.1查找元素

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

4.1.2获取元素数据

  • attr(String key)获取单个属性值
  • attributes()获取所有属性值
  • attr(String key, String value)设置属性值
  • text()获取文本内容
  • text(String value)设置文本内容
  • html()获取元素内的HTML内容
  • html(String value)设置元素内的HTML内容
  • outerHtml()获取元素外HTML内容
  • data()获取数据内容例如script和style标签)
  • id()获得id值例<p id="goods">衣服</p>
  • className()获得第一个类选择器值
  • classNames()获得所有的类选择器值
  • tag()获取元素标签
  • tagName()获取元素标签名如<p>、<div>等

4.1.3操作HTML文本

  • append(String html)在末尾追加HTML文本
  • prepend(String html)在开头追加HTML文本
  • html(String value)在匹配元素内部添加HTML文本。

–

4.2CSS选择器方式

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

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();
    System.out.print(linkText + "\t");
    System.out.println(linkHref);
}

4.2.1说明

select()方法在Document、Element或Elements对象中都可以使用而且是上下文相关的因此可实现指定元素的过滤或者采用链式访问。

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

4.2.2select(String selector)方法参数简介

  • tagname: 通过标签查找元素例如通过"a"来查找<a>标签。
  • #id: 通过ID查找元素比如通过#logo查找<p id="logo">。
  • .class: 通过class名称查找元素比如通过.titile查找<p class="titile">。
  • ns|tag: 通过标签在命名空间查找元素比如使用 fb|name 来查找 <fb:name> 。
  • [attribute]: 利用属性查找元素比如通过[href]查找<a href="...">。
  • [^attribute]: 利用属性名前缀来查找元素比如可以用[^data-] 来查找带有HTML5 dataset属性的元素。
  • [attribute=value]: 利用属性值来查找元素比如[width=500]。
  • [attribute^=value], [attribute$=value], [attribute*=value]: 利用匹配属性值开头、结尾或包含属性值来查找元素比如通过[href*=/path/]来查找<a href="a/path/c.html">。
  • [attribute~=regex]: 利用属性值匹配正则表达式来查找元素比如通过 img[src~=(?i)\.(png|jpe?g)]来匹配所有的png或者jpg、jpeg格式的图片。
  • *: 通配符匹配所有元素。

4.2.3参数属性组合使用

  • el#id: 元素+ID比如 div#logo
  • el.class: 元素+class比如 div.masthead
  • el[attr]: 元素+class比如 a[href]匹配所有带有 href 属性的 a 元素。
  • 任意组合比如a[href].highlight匹配所有带有 href 属性且class="highlight"的 a 元素。
  • 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

4.2.4特殊参数伪选择器

  • :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等

五、获取数据Node

在获得文档对象并且指定查找元素后我们就可以获取元素中的数据。
这些访问器方法都有相应的setter方法来更改数据。

  • .attr(String key) 获得属性的值。
  • .text()获得元素中的文本。
  • .html()获得元素或属性内部的HTML内容不包括本身。
  • .outerHtml()获得元素或属性完整的HTML内容。
  • .id()获得元素id属性值。
  • className()获得元素类选择器值。
  • .tagName()获得元素标签命名。
  • .hasClass(String className)检查这个元素是否含有一个类选择器不区分大小写。
String   html = "<p><a href='http://csdn.com/'><b>example</b></a> link.</p>";
Document doc  = Jsoup.parse(html);

// 查找第一个<a>元素
Element link = doc.select("a").first();

// 输出example
String text     = link.text();
// 输出http://csdn.com/
String href = link.attr("href");
// 输出<b>example</b>
String aHtml     = link.outerHtml();
// 输出<a href='http://csdn.com/'><b>example</b></a>
String aOuterHtml     = link.outerHtml();

–

六、修改数据

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

6.1设置属性的值

当以下方法针对Element对象操作时只有一个元素会受到影响。当针对Elements对象进行操作时可能会影响到多个元素。

  • .attr(String key, String value)设置标签的属性值。
  • .addClass(String className)增加类选择器选项
  • .removeClass(String className)删除对应的类选择器
Document doc = Jsoup.connect("http://csdn.com").get();

// 复数Elements
Elements elements = doc.getElementsByClass("text");
// 单数Element
Element element = elements.first();

// 复数对象所有 class="text" 的元素都将受到影响
elements.attr("name","goods");
// 单数对象只有一个元素会受到影响链式写法
element.attr("name","shop")
        .addClass("red");

6.2修改元素的HTML内容

可以使用Element中的HTML设置方法具体如下

  • .html(String value)这个方法将先清除元素中的HTML内容然后用传入的HTML代替。
  • .prepend(String value)在元素前添加html内容。
  • .append(String value)在元素后添加html内容。
  • .wrap(String value)对元素包裹一个外部HTML内容将元素置于新增的内容中间。
Document doc = Jsoup.connect("http://csdn.com").get();

Element div = doc.select("div").first();
div.html("<p>csdn</p>");
div.prepend("<p>a</p>");
div.append("<p>good</p>");
// 输出<div"> <p>a</p> <p>csdn</p> <p>good</p> </div>

Element span = doc.select("span").first();
span.wrap("<li><a href='...'></a></li>");
// 输出: <li><a href="..."> <span>csdn</span> </a></li>

6.3修改元素的文本内容

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

  • .text(String text) 清除元素内部的HTML内容然后用提供的文本代替。
  • .prepend(String first)在元素后添加文本节点。
  • Element.append(String last)在元素前添加文本节点。
 // <div></div>
Element div = doc.select("div").first();

div.text(" one "); 
div.prepend(" two ");
div.append(" three ");
// 输出: <div> two one three </div>

七、其他功能

6.1相对路径转绝对路径

问题描述
  你有一个包含相对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");

// 输出http://www.open-open.com/
String absHref = link.attr("abs:href");

说明

在HTML元素中URLs经常写成相对于文档位置的相对路径如<a href="/download">...</a>。当你使用 .attr(String key) 方法来取得a元素的href属性时它将直接返回在HTML源码中指定的值。

假如你需要取得一个绝对路径需要在属性名前加 abs: 前缀这样就可以返回包含根路径的URL地址attr("abs:href")。因此在解析HTML文档时定义base URI非常重要。

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

–

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

问题描述

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

解决方式
  使用clean()方法清除恶意代码但需要指定一个配置的 Safelist旧版本中是Whitelist通常使用Safelist.basic()即可。Safelist的工作原理是将输入的 HTML 内容单独隔离解析然后遍历解析树只允许已知的安全标签和属性输出。

String unsafe = 
        "<p><a href='http://csdn.com/' οnclick='attack()'>Link</a></p>";
        
// 输出: <p><a href="http://csdn.com/" >Link</a></p>
String safe = Jsoup.clean(unsafe, Safelist.basic());
System.out.println(safe);

说明

  jsoup的Safelist不仅能够在服务器端对用户输入的HTML进行过滤只输出一些安全的标签和属性还可以限制用户可以输入的标签范围。

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

问题描述

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

解决方式
  使用clean()方法清除恶意代码但需要指定一个配置的 Safelist旧版本中是Whitelist通常使用Safelist.basic()即可。Safelist的工作原理是将输入的 HTML 内容单独隔离解析然后遍历解析树只允许已知的安全标签和属性输出。

String unsafe = 
        "<p><a href='http://csdn.com/' οnclick='attack()'>Link</a></p>";
        
// 输出: <p><a href="http://csdn.com/" >Link</a></p>
String safe = Jsoup.clean(unsafe, Safelist.basic());
System.out.println(safe);

说明

  jsoup的Safelist不仅能够在服务器端对用户输入的HTML进行过滤只输出一些安全的标签和属性还可以限制用户可以输入的标签范围。

–

6.3jsoup使用代理

Connection.Response execute = Jsoup.connect("http://csdn.net/")
					               .proxy("12.12.12.12", 1080)	// 使用代理
					               .execute();

如果你读完觉得有收获不妨点个赞~

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6
返回列表

上一篇：大学生网页设计制作作业实例代码 (全网最全,建议收藏) HTML+CSS+JS_网页设计代码模板

下一篇：消息中间件RabbitMQ

“jsoup的使用_jsoup” 的相关文章

顺着这份Java面试地图，国内一二线互联网公司随便进...1年前 (2023-02-02)
记录--Vue开发历程---音乐播放器1年前 (2023-02-02)
优化if...else...语句1年前 (2023-02-02)
从0到1详解ZooKeeper的应用场景及架构1年前 (2023-02-02)
2022我的年度总结-- AI遮天之路1年前 (2023-02-02)
MySQL笔记01: MySQL入门_1.2 MySQL下载安装与配置1年前 (2023-02-02)
某高校校园网的规划与设计（课程设计）1年前 (2023-02-02)
【云原生 • DevOps】一文掌握持续集成工具 Jenkins_持续集成与云原生1年前 (2023-02-02)
Python自动批量修改文件名称的方法1年前 (2023-02-02)
python实现图书管理系统(带gui)_python图书管理系统1年前 (2023-02-02)

阿里云国际版