深入理解Jsoup解析器API与实际运用

作者: 爱学习的蹭蹭 | 来源:发表于2019-05-21 22:01 被阅读0次

1、前言简要

jsoup是一款Java 的HTML解析器，可直接解析某个URL地址、HTML文本内容。它提供了一套非常省力的API，可通过DOM，CSS以及类似于jQuery的操作方法来取出和操作数据。
个人认为jsoup是最好的解析器，在很多场景都能见到他的影子,不单只可以解析HTML所有结构，还可以解析XML，在做爬虫器最为广泛。
jsoup支持的语言有C#和Java

C#的叫Nsoup
Nsoup GitHub
jsoup英文官方网
 jsoup中文文官方网

2、为什么对JSOUP尤为深刻？

1、从2013年的时候工作中偶遇它，并在工作中大量使用它进行处理不同系统的页面的数据处理归档。
2、它不但是一个非常好的HTML的解析器，而且在很多场景会见到它的影子，Jsoup 防止 XSS 攻击工具类,JSOUP在做爬虫器最为广泛。
3、Jsoup 在解析XML也非常好用，而且语法与jQuery雷同，对正则表达式支撑友好。

3、解析和遍历一个HTML文档

public class Test1 {

    public static void main(String[] args) {
        String html = "<html><head><title>First parse</title></head>"
                + "<body><p>Parsed HTML into a doc.</p></body></html>";
        Document doc = Jsoup.parse(html);
        //把p标签的內容打印出来
        System.out.println(doc.select("p").text());
    }
}

存在问题

来自用户输入，一个文件或一个网站的HTML字符串，你可能需要对它进行解析并取其内容，或校验其格式是否完整，或想修改它。怎么办？jsonu能够帮你轻松解决这些问题
使用静态Jsoup.parse(String html)方法或Jsoup.parse(String html, String baseUri)

描述

parse(String html, String baseUri) 这方法能够将输入的HTML解析为一个新的文档 (Document），参数 baseUri 是用来将相对 URL 转成绝对URL，并指定从哪个网站获取文档。如这个方法不适用，你可以使用 parse(String html) 方法来解析成HTML字符串如上面的示例。.
只要解析的不是空字符串，就能返回一个结构合理的文档，其中包含(至少) 一个head和一个body元素。一旦拥有了一个Document，你就可以使用Document中适当的方法或它父类 Element和Node中的方法来取得相关数据。

4、从一个URL加载一个Document

以csdn的抓取今日推荐信息为例

public class Test2 {

    public static void main(String[] args) throws Exception {
        //定义一个URL地址
        String url   = "https://www.csdn.net/";
        //定义一个代理
        String agent = "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko)"
                + "  Chrome/56.0.2924.87 Safari/537.36";
        Document doc = Jsoup.connect(url).ignoreContentType(true).userAgent(agent)
                // ignoreHttpErrors
                // 这个很重要 否则会报HTTP error fetching URL. Status=404
                .ignoreHttpErrors(true) // 这个很重要
                .timeout(3000).get();
        
        // class=company_list > li > div#class=content
        // 找到样式为company_list的标签所有的li标签，再li下面的标签所有div样式为content的标签的信息

        Elements contents = doc.getElementsByClass("company_list").select("li").select("div[class=content]");
        for (Element node : contents) {
            //遍历所有p标签的文本内容
            Elements selects = node.select("p");
            selects.forEach(obj ->{
                String text = obj.text();
                System.out.println(text);
            });
        }
    }
}

运行结果

运行结果

5、使用DOM方法来遍历一个本地存在文件内容

当你电脑有一个HTML文件，需要通过Jsoup程序从中提取数据，并了解这个HTML文档的结构

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

6、Elements对象的API方法

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

查找元素

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() 通过标签的id，css的类名称，所有css的类名称获取信息
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)

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

你想使用类似于CSS或jQuery的语法来查找和操作元素。
可以使用Element.select(String selector) 和 Elements.select(String selector) 方法实现：

File input   = new File("/tmp/input.html");
Document doc = Jsoup.parse(input, "UTF-8", "http://example.com/");

Elements links = doc.select("a[href]"); //带有href属性的a元素
Elements pngs  = doc.select("img[src$=.png]");//扩展名为.png的图片

Element masthead     = doc.select("div.masthead").first();//class等于masthead的div标签
Elements resultLinks = doc.select("h3.r > a"); //在h3元素之后的a元素

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

这个select 方法在Document, Element,或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等
可以查看Selector API参考来了解更详细的内容

8、从元素抽取属性，文本和HTML

在解析获得一个Document实例对象，并查找到一些元素之后，你希望取得在这些元素中的数据。
要取得一个属性的值，可以使用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内容

说明

上述方法是元素数据访问的核心办法。此外还其它一些方法可以使用：
Element.id()
Element.tagName()
Element.className() and Element.hasClass(String className)
这些访问器方法都有相应的setter方法来更改数据.

参见

Element和Elements集合类的参考文档
URLs处理使用CSS选择器语法来查找元素

9、获取所有链接

这个示例程序将展示如何从一个URL获得一个页面。然后提取页面中的所有链接、图片和其它辅助内容。并检查URLs和文本信息。

public class ListLinks {
    public static void main(String[] args) throws IOException {
        Validate.isTrue(args.length == 1, "usage: supply url to fetch");
        String url = args[0];
        print("Fetching %s...", url);

        Document doc = Jsoup.connect(url).get();
        Elements links = doc.select("a[href]");
        Elements media = doc.select("[src]");
        Elements imports = doc.select("link[href]");

        print("\nMedia: (%d)", media.size());
        for (Element src : media) {
            if (src.tagName().equals("img"))
                print(" * %s: <%s> %sx%s (%s)",
                        src.tagName(), src.attr("abs:src"), src.attr("width"), src.attr("height"),
                        trim(src.attr("alt"), 20));
            else
                print(" * %s: <%s>", src.tagName(), src.attr("abs:src"));
        }

        print("\nImports: (%d)", imports.size());
        for (Element link : imports) {
            print(" * %s <%s> (%s)", link.tagName(),link.attr("abs:href"), link.attr("rel"));
        }

        print("\nLinks: (%d)", links.size());
        for (Element link : links) {
            print(" * a: <%s>  (%s)", link.attr("abs:href"), trim(link.text(), 35));
        }
    }

    private static void print(String msg, Object... args) {
        System.out.println(String.format(msg, args));
    }

    private static String trim(String s, int width) {
        if (s.length() > width)
            return s.substring(0, width-1) + ".";
        else
            return s;
    }
}

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攻击，还可以限制用户可以输入的标签范围。

参见

参阅 XSS cheat sheetl，有一个例子可以了解为什么不能使用正则表达式，而采用安全的whitelist parser-based
清理器才是正确的选择。
参阅Cleaner ，了解如何返回一个 Document 对象，而不是字符串
参阅Whitelist
，了解如何创建一个自定义的whitelist
nofollow 链接属性了解

11、学习Demo工程

如下是Lucene与jsoup整合的例子工程，由于工程是N久年前编写抓取163，百度网上的例子，现在有些网站应该改版（加权限控制），应该是失效获取不到内容，故工程的例子仅提供学习参考.
lucene与jsoup

Lucene与jsoup整合源码地址
 Jsoup解析html代码,与httpclient重定向的处理~
常见的jsoup使用例子

深入理解Jsoup解析器API与实际运用

1、前言简要

2、为什么对JSOUP尤为深刻？

3、解析和遍历一个HTML文档

存在问题

描述

4、从一个URL加载一个Document

5、使用DOM方法来遍历一个本地存在文件内容

6、Elements对象的API方法

查找元素

元素数据

操作HTML和文本

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

Selector选择器概述

Selector选择器组合使用

伪选择器selectors

8、从元素抽取属性，文本和HTML

说明

参见

9、获取所有链接

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

说明

参见

11、学习Demo工程

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Java 杂谈

Android学习

深入理解Jsoup解析器API与实际运用

1、前言简要

2、为什么对JSOUP尤为深刻？

3、 解析和遍历一个HTML文档

存在问题

描述

4、从一个URL加载一个Document

5、使用DOM方法来遍历一个本地存在文件内容

6、Elements对象的API方法

查找元素

元素数据

操作HTML和文本

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

Selector选择器概述

Selector选择器组合使用

伪选择器selectors

8、从元素抽取属性，文本和HTML

说明

参见

9、 获取所有链接

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

说明

参见

11、学习Demo工程

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Java 杂谈

Android学习

3、解析和遍历一个HTML文档

9、获取所有链接

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