# pholcus **Repository Path**: netcrawler/pholcus ## Basic Information - **Project Name**: pholcus - **Description**: [爬虫框架 (golang)] Pholcus（幽灵蛛）是一款纯Go语言编写的高并发、分布式、重量级爬虫软件，支持单机、服务端、客户端三种运行模式，拥有Web、GUI、命令行三种操作界面；规则简单灵活、批量任务并发、输出方式丰富（mysql/mongodb/csv/excel等）、有大量Demo共享；同时她还支持横纵向两种抓取模式，支持模拟登录和任务暂停、取消等一系列高级功能。 - **Primary Language**: Go - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 15 - **Created**: 2019-09-07 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # pholcus [![GoDoc](https://godoc.org/github.com/tsuna/gohbase?status.png)](https://godoc.org/github.com/henrylee2cn/pholcus) [![GitHub release](https://img.shields.io/github/release/henrylee2cn/pholcus.svg)](https://github.com/henrylee2cn/pholcus/releases) Pholcus（幽灵蛛）是一款纯Go语言编写的高并发、分布式、重量级爬虫软件，支持单机、服务端、客户端三种运行模式，拥有Web、GUI、命令行三种操作界面；规则简单灵活、批量任务并发、输出方式丰富（mysql/mongodb/csv/excel等）、有大量Demo共享；同时她还支持横纵向两种抓取模式，支持模拟登录和任务暂停、取消等一系列高级功能。 ![image](https://github.com/henrylee2cn/pholcus/raw/master/doc/icon.png) * 官方QQ群：Go大数据 42731170 [![Go大数据群](http://pub.idqqimg.com/wpa/images/group.png)](http://jq.qq.com/?_wv=1027&k=XnGGnc) #### 爬虫原理 ![image](https://github.com/henrylee2cn/pholcus/raw/master/doc/project.png) #### 框架特点 1. Pholcus（幽灵蛛）以高效率，高灵活性和人性化设计为开发的指导思想； 2. 支持单机、服务端、客户端三种运行模式，即支持分布式布局，适用于各种业务需要； 3. 支持Web、GUI、命令行三种操作界面，适用于各种运行环境； 4. 支持mysql/mongodb/csv/excel等多种输出方式，且可以轻松添加更多输出方式； 5. 采用surfer高并发下载器，支持 GET/POST/HEAD 方法及 http/https 协议，同时支持固定UserAgent自动保存cookie与随机大量UserAgent禁用cookie两种模式，高度模拟浏览器行为，可实现模拟登录等功能； 6. 服务器/客户端模式采用teleport高并发socketAPI框架，全双工长连接通信，内部数据传输格式为JSON； 7. 对采集规则进行了精心设计，支持静态编译与动态JS两种规则，灵活简单且有大量Demo，写规则就是这么轻松； 8. 支持横纵向两种抓取模式，并且支持任务暂停、取消等操作。   #### 下载安装 1. 下载第三方依赖包源码，放至 GOPATH/src 目录下 [[点击下载 ZIP]](https://github.com/pholcus/dependent/archive/master.zip) 2. 下载保持更新状态的源码，命令行如下 ``` go get github.com/henrylee2cn/pholcus ``` 备注：Pholcus公开维护的spider规则库地址   #### 创建项目 ``` package main import ( "github.com/henrylee2cn/pholcus/exec" // "github.com/henrylee2cn/pholcus/logs" _ "github.com/pholcus/spider_lib" // 此为公开维护的spider规则库 // _ "spider_lib_pte" // 同样你也可以自由添加自己的规则库 ) func main() { // 允许日志打印行号 // logs.ShowLineNum() // 设置运行时默认操作界面，并开始运行 // 运行软件前，可设置 -a_ui 参数为"web"、"gui"或"cmd"，指定本次运行的操作界面 // 其中"gui"仅支持Windows系统 exec.DefaultRun("web") } ```   #### 编译运行 正常编译方法 ``` go install 或者 go build ``` Windows下隐藏cmd窗口的编译方法 ``` go install -ldflags="-H windowsgui" 或者 go build -ldflags="-H windowsgui" ``` 查看可选参数: ``` pholcus -h ``` ![image](https://github.com/henrylee2cn/pholcus/raw/master/doc/help.jpg)   > *(注意：当运行web操作界面时请将 src/github.com/henrylee2cn/pholcus/web 文件夹拷贝至当前项目目录下，其中的go文件可删除)，Web版操作界面截图如下：* ![image](https://github.com/henrylee2cn/pholcus/raw/master/doc/webshow_1.jpg)   > *GUI版操作界面之模式选择界面截图如下* ![image](https://github.com/henrylee2cn/pholcus/raw/master/doc/guishow_0.jpg)   > *Cmd版运行参数设置示例如下* ``` pholcus -a_ui=cmd -c_spider=3,8 -c_output=csv -c_thread=20 -c_docker=5000 -c_pause=300 -c_proxy=0 -c_keyword=pholcus,golang -c_maxpage=10 -c_inherit_y=true -c_inherit_n=true ```   #### 运行时目录文件 ``` ├─pholcus 软件 │ ├─pholcus 依赖文件目录 │ ├─pholcus.ini 配置文件 │ │ │ ├─proxy.lib 代理IP列表库 │ │ │ ├─spider.lib 动态规则目录 │ │ └─xxx.pholcus.html 动态规则文件 │ │ │ ├─phantomjs 程序文件 │ │ │ ├─logs 日志目录 │ │ │ ├─history 历史记录目录 │ │ └─└─cache 临时缓存目录 ```   #### 动态规则示例 特点：动态加载规则，无需重新编译软件，书写简单，添加自由，适用于轻量级的采集项目。
xxx.pholcus.html ``` HTML动态规则示例 HTML动态规则示例 [Auto Page] [http://xxx.xxx.xxx] false true false 300 ``` #### 静态规则示例 特点：随软件一同编译，定制性更强，效率更高，适用于重量级的采集项目。
xxx.go ``` func init() { Lewa.Register() } var Lewa = &Spider{ Name: "静态规则示例", Description: "静态规则示例 [Auto Page] [http://xxx.xxx.xxx]", // Pausetime: 300, // Keyword: USE, EnableCookie: true, RuleTree: &RuleTree{ Root: func(ctx *Context) { ctx.AddQueue(&request.Request{Url: "http://xxx.xxx.xxx", Rule: "登录页"}) }, Trunk: map[string]*Rule{ "登录页": { ParseFunc: func(ctx *Context) { ctx.AddQueue(&request.Request{ Url: "http://xxx.xxx.xxx", Rule: "登录后", Method: "POST", PostData: "username=123456@qq.com&password=123456&login_btn=login_btn&submit=login_btn", }) }, }, "登录后": { ParseFunc: func(ctx *Context) { ctx.Output(map[string]interface{}{ "全部": ctx.GetText(), }) ctx.AddQueue(&request.Request{ Url: "http://accounts.xxx.xxx/member", Rule: "个人中心", Header: http.Header{"Referer": []string{ctx.GetUrl()}}, }) }, }, "个人中心": { ParseFunc: func(ctx *Context) { ctx.Output(map[string]interface{}{ "全部": ctx.GetText(), }) }, }, }, }, } ```   #### FAQ 请求队列中，重复的URL是否会自动去重？ ``` url默认情况下是去重的，但是可以通过设置Request.Reloadable=true忽略重复。 ``` URL指向的页面内容若有更新，框架是否有判断的机制？ ``` url页面内容的更新，框架无法直接支持判断，但是用户可以自己在规则中自定义支持。 ``` 请求成功是依据web头的状态码判断？ ``` 不是判断状态，而是判断服务器有无响应流返回。即，404页面同样属于成功。 ``` 请求失败后的重新请求机制？ ``` 每个url尝试下载指定次数之后，若依然失败，则将该请求追加到一个类似defer性质的特殊队列中。 在当前任务正常结束后，将自动添加至下载队列，再次进行下载。如果依然有没下载成功的，则保存至失败历史记录。 当下次执行该条爬虫规则时，可通过选择继承历史失败记录，把这些失败请求自动加入defer性质的特殊队列……（后面是重复步骤） ```   #### 贡献者名单 贡献者 |贡献内容 --------------------------------|-------------------------------------------------- henrylee2cn|软件作者 kas|surfer下载器中phantomjs内核   #### 第三方依赖包 ``` go get github.com/pholcus/spider_lib go get github.com/henrylee2cn/teleport go get github.com/henrylee2cn/beelogs go get github.com/henrylee2cn/mahonia go get github.com/henrylee2cn/websocket.google go get github.com/PuerkitoBio/goquery go get github.com/robertkrimen/otto go get github.com/andybalholm/cascadia go get github.com/lxn/walk go get github.com/lxn/win go get github.com/tealeg/xlsx go get github.com/go-sql-driver/mysql go get github.com/elazarl/go-bindata-assetfs go get gopkg.in/mgo.v2 <以下需翻墙下载> go get golang.org/x/net/html go get golang.org/x/text/encoding go get golang.org/x/text/transform ``` > *（在此感谢以上开源项目的支持！）*   #### 开源协议 Pholcus（幽灵蛛）项目采用商业应用友好的[Apache License v2](https://github.com/henrylee2cn/pholcus/raw/master/doc/license.txt).发布