Skip to content

gocrawl

2,037 2 6 BSD-3-Clause
(19 May 2021) Nov 20 2016 58.1 thousand (month)

Gocrawl is a polite, slim and concurrent web crawler library written in Go. It is designed to be simple and easy to use, while still providing a high degree of flexibility and control over the crawling process.

One of the key features of Gocrawl is its politeness, which means that it obeys the website's robots.txt file and respects the crawl-delay specified in the file. It also takes into account the website's last modified date, if any, to avoid recrawling the same page. This helps to reduce the load on the website and prevent any potential legal issues. Gocrawl is also highly concurrent, which allows it to efficiently crawl large numbers of pages in parallel. This helps to speed up the crawling process and reduce the time required to complete the task.

The library also offers a high degree of flexibility in customizing the crawling process. It allows you to specify custom callbacks and handlers for handling different types of pages, such as error pages, redirects, and so on. This allows you to handle and process the pages as per your requirement. Additionally, Gocrawl provides various functionalities such as support for cookies, user-agent, auto-detection of links, and auto-detection of sitemaps.

Example Use


// Only enqueue the root and paths beginning with an "a"
var rxOk = regexp.MustCompile(`http://duckduckgo\.com(/a.*)?$`)

// Create the Extender implementation, based on the gocrawl-provided DefaultExtender,
// because we don't want/need to override all methods.
type ExampleExtender struct {
    gocrawl.DefaultExtender // Will use the default implementation of all but Visit and Filter
}

// Override Visit for our need.
func (x *ExampleExtender) Visit(ctx *gocrawl.URLContext, res *http.Response, doc *goquery.Document) (interface{}, bool) {
    // Use the goquery document or res.Body to manipulate the data
    // ...

    // Return nil and true - let gocrawl find the links
    return nil, true
}

// Override Filter for our need.
func (x *ExampleExtender) Filter(ctx *gocrawl.URLContext, isVisited bool) bool {
    return !isVisited && rxOk.MatchString(ctx.NormalizedURL().String())
}

func ExampleCrawl() {
    // Set custom options
    opts := gocrawl.NewOptions(new(ExampleExtender))

    // should always set your robot name so that it looks for the most
    // specific rules possible in robots.txt.
    opts.RobotUserAgent = "Example"
    // and reflect that in the user-agent string used to make requests,
    // ideally with a link so site owners can contact you if there's an issue
    opts.UserAgent = "Mozilla/5.0 (compatible; Example/1.0; +http://example.com)"

    opts.CrawlDelay = 1 * time.Second
    opts.LogFlags = gocrawl.LogAll

    // Play nice with ddgo when running the test!
    opts.MaxVisits = 2

    // Create crawler and start at root of duckduckgo
    c := gocrawl.NewCrawlerWithOptions(opts)
    c.Run("https://duckduckgo.com/")

    // Remove "x" before Output: to activate the example (will run on go test)

    // xOutput: voluntarily fail to see log output
}

Alternatives / Similar


23,410 v2.1.0 (4 years ago) May 14 2018 compare
7,566 v1.3.4 (4 years ago) Feb 15 2020 compare
2,641 2024-12-04 (6 days ago) Jun 06 2019 compare
663 2024-12-03 (6 days ago) Feb 09 2017 compare
5,716 v0.18.0 (1 year, 8 months ago) Aug 06 2019 compare

Other Languages

52,353 2.11.2 (6 months ago) Jul 26 2019 compare
1,494 1.0.4 (2 years ago) Nov 22 2014 compare
2,980 1.5.0 (2 months ago) Sep 04 2013 compare
6,713 2.0.2 (4 months ago) Sep 10 2012 compare
6,193 1.1.14 (2 years ago) Jul 26 2019 compare
2,951 v2.1.1 (1 year, 7 days ago) Jul 17 2018 compare
809 0.7.1 (10 months ago) Jul 25 2009 compare
3,362 0.9.13 (1 year, 4 months ago) Jul 04 2017 compare
1,315 3.0.0 (2 years ago) Dec 27 2011 compare
3,176 1.5.1 (2 months ago) Sep 30 2018 compare
1,753 0.8.5 (2 years ago) Oct 17 2018 compare
246 1.33.0 (9 months ago) Feb 05 2023 compare
11,112 1.1.9 (6 years ago) Aug 24 2018 compare
1,353 v3.2.0 (8 months ago) Dec 27 2021 compare
156 2.2.4 (3 years ago) Dec 22 2019 compare
426 0.1.3 (1 year, 4 months ago) Feb 20 2022 compare
544 3.0.0 (8 months ago) May 04 2020 compare
212 1.0.0-beta8.4 (1 year, 5 months ago) Apr 18 2019 compare
1,335 v0.7.2 (a year ago) Mar 16 2013 compare
342 v2.1.3 (a month ago) Apr 18 2022 compare
Was this page helpful?