README.md · lurker8/sipsoup

# sipsoup

官方qq群:569543649(讨论dungproxy,vscrawler,sipSoup以及日常聊天吹水)

sipsoup是一个基于Jsoup的xpath实现，他将Jsoup的cssQuery变成了xpath语法的一部分，可以实现在xpath内部执行cssQuery和xpath混合模式的链式文档查询

是一款纯Java开发的使用xpath解析html的解析器，xpath语法分析与执行完全独立，html的DOM树生成借助Jsoup。

sipSoup本身也应该叫做Xsoup,JsoupXpath之类的,但是他出身太晚了,名字被占了,但是我觉得还是应该喝汤,所以我喜欢sipSoup这个名字。

每一个爬虫框架作者都应该实现一个xpath, sipsoup 出现也是如此,在我设计爬虫框架[vscrawler](http://git.oschina.net/virjar/vscrawler)的时候,考虑如何定位抽取数据,甚至如何整合其他爬虫框架的抽取API,
然后调研了Xsoup和JsoupXpath,看到JsoupXpath眼前一亮,我觉得他肯定适合我的需要,所以尝试使用JsoupXpath对接了Xsoup,因为JsoupXpath实现了xpath2.0的绝大部分语法功能,
使用JsoupXpath可以非常灵活自由的实现xpath。但是在整合的过程,我发现JsoupXpath有一点不符合我的需求,就是他都是运行的适合抛错,我希望能够在编译xpath表达式的时候,就可以做语法
检查,我希望JsoupXpath可以类似Xsoup一样做链式抽取,我希望规则模型可以缓存。所以尝试着对JsopXpath进行重构。

SipSoup本质是对JsoupXpath重构而来的,里面少部分代码仍然是JsoupXpath的,这里非常感谢JsoupXpath,但是绝大部分代码都被替换了,所以本身SipSoup不算依赖JsoupXpath(组件结构几乎还和JsoupXpath保持了一致)。
目前看来,SipSoup完全兼容JsoupXpath,因为它本身自JsoupXpath发展而来。关于JsoupXpath的相关资料,参考 [JSoupXpath](http://www.oschina.net/p/Jsoupxpath)

以下为改动点

1. 函数重构,JsoupXpath使用反射加载一个类里面的静态函数,SipSoup则是使用接口实现的方式扩展
2. 类扫描,默认函数注册,是通过扫描器自动注册,如果你需要扩展自己的函数,可以将自己的函数实现放到com.virjar.sipsoup.function,就能够自动注册
3. 轴函数,SipSoup不光支持一般的谓语函数扩展,同时支持轴函数,抽取函数扩展。而且允许函数带参数
4. css('cssQuery') css是SipSoup内置的重要轴函数,它可以将css查询表达式传递给css轴,这是SipSoup一个大的突破,他比Xsoup更加容易的实现了css和xpath混合链式抽取
5. 复杂谓语,目前来说,SipSoup对谓语的支持是我发现的最完善的,支持函数嵌套,表达式嵌套,括号嵌套,处理空格,转义等问题。SipSoup的谓语模块,是我花了整整一天写出来的计算器😄
6. 谓语数据类型扩展,在xpath语法中,我定义了数据类型分为: 字符串,数字,运算符,xpath,函数,属性取值动作,布尔类型,复合表达式 这几种类型,其中除运算符以外的其他数据类型都是可以扩展或者卸载的。(boolean类型是开始设计的时候没有的类型,然后通过这个机制注册了boolean,后来又将其添加到了默认类型了)
7. 运算符重载,运算符重载一般c++ 听得挺多,含义就是可以通过重载运算符实现操作符的行为改写。比如"+"加法操作,遇到数字执行加法,遇到字符串执行字符串链接,你可以重写他,遇到数字转化数字,失败使用默认值等等
8. 多xpath组合逻辑,可以实现多个xpath的多重与或计算,对应集合实现交集,并集计算

总之,SipSoup已经是一个高度扩展的Xpath语法分析器,通过灵活的扩展以及Jsoup整合,成为了一个异常强大的xpath工具

demo如下:
1. 格式化输出节点文本 allText [allText()](http://git.oschina.net/virjar/sipsoup/blob/master/src/test/java/com/virjar/sipsoup/AllTextTest.java)
2. position使用,选取所有偶数节点 [position](http://git.oschina.net/virjar/sipsoup/blob/master/src/test/java/com/virjar/sipsoup/PositionFunctionTest.java)
3. 注册新的函数  [RegisterNewFunctionTest.java](http://git.oschina.net/virjar/sipsoup/blob/master/src/test/java/com/virjar/sipsoup/RegisterNewFunctionTest.java)
4. 注册新的操作符 [运算符重载](http://git.oschina.net/virjar/sipsoup/blob/master/src/test/java/com/virjar/sipsoup/RegisterNewOperator.java)
5. 福利,美女爬虫 [实际demo](http://git.oschina.net/virjar/sipsoup/blob/master/src/test/java/com/virjar/sipsoup/XpathSelectTest.java)

风骚语法展示:

```
 <ul class="ad-thumb-list"> 
   <a href="www.java1234.com/test.jpg">这是一个混淆的图片数据</a>
   <li> 
    <div class="inner"> 
     <a href="http://image11.m1905.cn/uploadfile/2015/0608/20150608044330688388.jpg"><img src="http://image14.m1905.cn/uploadfile/2015/0608/thumb_1_147_100_20150608044330688388.jpg" title="" alt="" class="image0" /></a> 
    </div> </li> 
   <li> 
    <div class="inner"> 
     <a href="http://image13.m1905.cn/uploadfile/2015/0608/20150608044328940773.jpg"><img src="http://image11.m1905.cn/uploadfile/2015/0608/thumb_1_147_100_20150608044328940773.jpg" title="" alt="" class="image1" /></a> 
    </div> </li> 
   <li> 
    <div class="inner"> 
     <a href="http://image13.m1905.cn/uploadfile/2015/0608/20150608044328954604.jpg"><img src="http://image13.m1905.cn/uploadfile/2015/0608/thumb_1_147_100_20150608044328954604.jpg" title="" alt="" class="image2" /></a> 
    </div> </li> 
   <ul></ul>
  </ul>
```
这个文本,需要提取所有偶数行的a标签的图片的链接信息,对应xpath表达式可以这么写

``//css('.ad-thumb-list .inner')::a[position(parent(2)) %2 =0]/@href``
语法解释
1. ``css('.ad-thumb-list .inner')::`` 这是css轴的运用,这个表达式定位到了所有的图片数据(其中"\<a href="www.java1234.com/test.jpg"\>这是一个混淆的图片数据</a>"将会被过滤)
2. ``a[position(parent(2)) %2 =0]`` 这是复杂谓语的一个简单应用,首先a\[xxx\]定位到a标签,然后使用parent函数得到他的爷爷节点,(parent函数可以带参数,必须是一个数字,2代表父亲的父亲,也就是得到了li标签)
3. 然后使用position函数得到这个li元素的position偏移,也就是他是第几个li。
4. 最后,让他和2取模,如果结果为0,代表他就是偶数资源

### maven坐标
```
 
 <dependency>
      <groupId>com.virjar</groupId>
      <artifactId>sipsoup</artifactId>
      <version>RELEASE</version>
</dependency>
```

### 桥接器
考虑国内很多同学使用webMagic,webMagic内置的xpath是XSoup,如果想再WebMagic中使用SipSoup,那也是很容易实现的,SipSoup提供了到XSoup的桥接器。几行配置即可实现SipSoup到XSoup的替换
参见项目[xsoup-to-sipsoup](http://git.oschina.net/virjar/xsoup-to-sipsoup)

轴函数列表

|函数名称|参数|作用|
|------:|:------|:------|
|ancestor|无|全部祖先节点 父亲，爷爷 ， 爷爷的父亲...|
|ancestorOrSelf|无|全部祖先节点和自身节点|
|cacheCss|css query表达式|内部实现路由至Jsoup的select,和css轴不一样的是,cacheCss会对css规则进行缓存,在遇到大量同类型网页的解析的时候,可能一个css规则被多次使用,缓存css能够减少css规则编译的消耗,提升性能|
|child|无|直接子节点|
|css|css query表达式|内部实现路由至Jsoup的select|
|descendant|无|全部子代节点 儿子，孙子，孙子的儿子...|
|descendantOrSelf|无|全部子代节点和自身|
|following-sibling|无|节点后面的全部同胞节点following-sibling|
|following-sibling-one|无|返回下一个同胞节点(扩展) 语法 following-sibling-one|
|parent|无|父节点|
|preceding-sibling|无|节点前面的全部同胞节点，preceding-sibling|
|preceding-sibling-one|无|返回前一个同胞节点（扩展），语法 preceding-sibling-one|
|self|无|自身|
|sibling|无|全部同胞（扩展）|

#### 抽取函数
抽取函数用来对结果集进行转换,他是一些简单的数据抽取函数,如提取所有文本,提取某个属性等等,抽取函数目前不会太多。抽取结果可能为元素,也能为字符串。请注意,如果xpath节点中,存在抽取函数,而且抽取函数返回类型为字符串,那么这个函数应该是这个xpath节点链的末尾节点。因为每个抽取节点开始的时候,将会执行过滤,只会将element作为下一轮抽取的输入。

轴函数列表(哪位大神能帮我调整以下表格布局,真丑,我不喜欢)

|函数名称|参数|作用|
|------:|:------|:------|
|allText  |无|递归获取节点内全部的纯文本,将block的html元素转化为换行符,能够保持原有的html的段落结构,但是不能保持布局结构|
|@        |无|抽取当前节点的某个属性,数据内部函数,外界不可直接调用,原因是函数语法识别器不会识别"@"函数,但是"@"操作符本身内部是转化抽取函数了|
|html     |无|获取全部节点的内部的html|
|node     |无|获取全部节点的html|
|num      |无|抽取节点自有文本中全部数字|
|outerHtml|无|获取全部节点的 包含节点本身在内的全部html|
|self     |无|放弃抽取,保留自身。xpath默认会对当前节点的子节点进行操作,而有些时候轴函数定位到的节点就是需要的数据了,所以不需要在使用抽取函数计算新节点了,主要用在tag函数不能解决的场景下|
|tag      |tagName|内部函数,xpath 语法中的tag字段,默认路由到此函数处理``//div[@class]`` 这里的div在运行时会转化为 ``//tag('div')[@'class']``这两个表达式等价,但是第一个表达式才是xpath常规思路,而且对SipSoup这两个表达式性能完全一样 |
|text     |无|只获取节点自身的子文本|

### 过滤函数
过滤函数用在谓语中,过滤函数非常强大,因为它能够递归的使用函数,配合操作符,实现复杂的表达式计算,

过滤函数列表

|函数名称|参数|作用|
|------:|:------|:------|
|abs|数字,可以是整数或者小数|返回参数的绝对值。例子：abs(-3.14) 结果：3.14|
|allText|无|获取元素下面的全部文本|
|boolean|数字,boolean,字符串|返回数字、字符串的布尔值。如果没有参数,则默认返回false,如果本身是boolean,返回boolean,如果是字符串,尝试转化为boolean,如果是整数,非零为真。其他类型的数字,大于零为真。剩余场景全部返回false|
|concat|多个参数,可以为任意类型|返回字符串的拼接,例子：concat('XPath ','is ','FUN!') 结果：'XPath is FUN!',如果非字符串,则转化为字符串后执行字符串拼接|
|contains|两个参数,左右都为字符串,测试左侧字符串中是否包含右侧字符串|如果 string1 包含 string2，则返回 true，否则返回 false|
|false|无|返回布尔值 false|
|first|无|判断一个元素是不是同名同胞中的第一个,可以使用position函数代替,迁移自JSoupXpath的函数|
|hasClass|字符串,为css的class样式名称|css规则的className,实际上会调用Jsoup的hasClass方法(Jsoup本身的抽取器也是调用这个方法的)|
|last|无|判断一个元素是不是最后一个同名同胞中的|
|lower-case|一个参数,类型为字符串|转化字符串为大写|
|matches|两个参数,类型为字符串 | 如果 string 参数匹配指定的模式，则返回 true，否则返回 false,例子：matches("Merano", "ran") 结果：true|
|name|无|获取当前节点的节点名称|
|not|和boolean的参数相同|首先通过 boolean() 函数把参数还原为一个布尔值。如果该布尔值为 false，则返回 true，否则返回 true|
|nullToDefault|两个参数,任意类型|如果第一个参数的值为null,则第三个参数作为本函数的返回值,否则第一个参数为本函数的返回值|
|parent|一个或者零个参数,均为正整数类型|如果没有参数,则获取当前节点的父亲节点,返回值为element类型,如果传递了参数,则指定n代祖先对应节点|
|position|一个或者零个参数,为节点类型|如果没有传递参数,或者第一个参数计算结果为null,则返回当前节点在兄弟节点中的位置。否则返回传入的节点相对于传入节点兄弟节点的位置|
|root|无|返回当前节点的根节点,一般是document节点|
|string|一个参数,任意类型|返回参数的字符串值。参数可以是数字、逻辑值|
|string-length|一个参数,字符串类型|返回字符的长度|
|substring|两个或者参数|第一个参数为字符串类型,第二个参数为数字,第三个参数如果存在,也必须是数字类型。本函数返回字符串对应子串。第二个参数为起始偏移,如果第三个参数存在,则第三个参数为结尾偏移,否则结尾为字符串末尾|
|text|无|获取元素自己的子文本|
|toDouble|一个或者两个参数,第一个需要是数字,第二个如果存在,则需要是double类型|将一个字符串转化为double,如果转化失败,尝试使用默认值返回|
|toInt|个或者两个参数,第一个需要是数字,第二个如果存在,则需要是int类型|将一个字符串转化为int,如果转化失败,尝试使用默认值返回|
|true|无|返回布尔值 true|
|try|异常处理,0,1,2个参数|如果参数为空,返回true,如果第一个参数对应语法节点无异常执行,则返回第一个参数。否则返回第二个参数(此时如果第二个参数不存在,返回false)|
|upper-case|一个参数,类型为字符串|转化字符串为小写|

## 操作符

目前操作符相关,迁移自JSoupXpath其运算规则和JSoupXpath保持一致,SipSoup支持多个运算符组合,所以涉及操作符优先级问题(除非非常常见的用法,一般建议使用括号手动确定优先级)
操作符和对应优先级如下表,其中优先级高越优先的到计算,如果操作符优先级相同,则按照从左往右的顺序计算。
```
各运算符优先级定义

+   :20   加法运算
-   :20   减法运算
*   :30   乘法运算
/   :30   除法运算
%   :30   取模运算
&&  :0    逻辑且运算
||  :0    逻辑或运算
and :0    逻辑且运算,等价于&&
or  :0    逻辑或运算,等价于||
=   :10   相等判断,逻辑运算
>   :10   大于,逻辑运算
<   :10   小于,逻辑运算
>=  :10   大于等于,逻辑运算
<=  :10   小于等于,逻辑运算
*=  :10   包含,测试表达式左侧数据是否包含表达式右侧数据,仅适用于字符串,逻辑运算
$=  :10   以xxx结尾,测试左侧数据是否以表达式右侧数据结尾,仅适用于字符串,逻辑运算
^=  :10   以xxx开始,测试左侧数据是否以表达式右侧数据开始,仅适用于字符串,逻辑运算
!=  :10   不等于,和"="作用相反,逻辑运算
~=  :10   模式匹配,测试左侧数据是否符合右侧字符串代表的正则表达式模式,仅适用于字符串,逻辑运算
!~  :10   不匹配,与"~="相反,如果左侧数据不匹配右侧字符串代表的正则表达式,则返回true
```

### 操作符类型
操作符计算涉及到数据类型升级问题,如一个整形数据和一个长整形计算,将会转化为长整形。SipSoup默认支持较好的数字类型有:int,long,double(float按double处理),BigDecimal,并且会根据一般的惯例处理转型计算的问题

特别说明,对于``+``有两个动作,如果遇到数字,则执行数字加法,如果遇到字符串,则执行字符串链接。如果你觉得不应该有这个表现,可以通过重写操作符的方式修改

## 高级用法
1. 注册或重写新的函数  [RegisterNewFunctionTest.java](http://git.oschina.net/virjar/sipsoup/blob/master/src/test/java/com/virjar/sipsoup/RegisterNewFunctionTest.java)
2. 注册或重写新的操作符 [运算符重载](http://git.oschina.net/virjar/sipsoup/blob/master/src/test/java/com/virjar/sipsoup/RegisterNewOperator.java)
3. 注册新的数据类型 [TokenAnalysisRegistry.java](http://git.oschina.net/virjar/sipsoup/blob/master/src/main/java/com/virjar/sipsoup/parse/expression/token/TokenAnalysisRegistry.java) 这里不展示细节了,如果你需要这个功能了,那么你对SipSoup的源代码应该足够了解,应该可以独立驾驭这个类,并根据SipSoup定义的规范识识别新数据类型的格式,以及消费转化为特性计算节点模型

lurker8/sipsoup

简介

发行版

贡献者

近期动态

lurker8/sipsoup .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

lurker8/sipsoup